Balise #FOREACH

Ceci est une archive périmée mais qui reste intéressante, parfois autant pour l’article que les commentaires associés.

une balise pour appliquer un modèle à tous les éléments d’une balise contenant un tableau

SPIP s’est vu enrichi ces derniers mois de balises permettant des constructions de squelettes avec un niveau programmatique qui dépasse le cadre de la consultation de bases de données. En particulier une balise qu’on pourrait comparer aux instructions de bouclage de php lui-même : #FOREACH.

Dans la lignée des balises #SET, #GET et #ARRAY, cette balise permet de « boucler » sur un contenu équivalent à un tableau calculé dans le squelette en appliquant pour chacun de ses éléments un modèle SPIP.

Le choix de développer ce concept sous forme de balise plutôt que de boucle tient au fait que les boucles sont destinées à traiter des données issues de bases de données. Les besoins de boucler sur des contenus calculés dans les squelettes doivent donc être traités par une balise et des squelettes.

Le plugin nuage s’appuie sur cette balise,et la technique d’intégration dans 1.9.2 est aussi comprise dans le plugin, d’où sa présence dans cette rubrique.

Premier exemple

Dans un squelette quelconque, l’utilisation de #FOREACH affichera toutes les variables de la balise #ENV de la manière suivante :

- cle=> valeur

soit :
-  lang => fr
-  date => 2008-01-28 21:15:00
-  date_redac => 2008-01-28 21:15:00
-  ... => ...

Autrement dit, pour chaque élément du tableau associatif php que représente la balise #ENV, #FOREACH appliquera le modèle foreach.html (cf . plus bas). Dans ce modèle, le nom de la variable sera stocké dans #ENV{cle}, la valeur dans #ENV{valeur}.

Corsons l’affaire

On peut vouloir afficher le contenu d’une autre balise. #CONFIG par exemple. Pour cela, on passera le nom de la balise comme premier paramètre :

#FOREACH{CONFIG} affichera donc à peu près :
-  version_installee=> 1.927
-  charset=> utf-8
-  nom_site=> Mon site SPIP Stable
-  ... => ...

Et pour toute balise SPIP représentant un tableau php on aura un résultat similaire.

Changeons de forme

Le modèle foreach.html est celui qui est appliqué par défaut. Il est possible de le modifier, mais on peut aussi fabriquer un modèle dédié à une balise.

Le modèle foreach_balise.html correspond à #FOREACH{BALISE}.

On peut aussi souhaiter créer des modèles généraux et les utiliser pour telle ou telle balise. Par exemple, pour des listes non énumérées :

squelettes/modeles/foreach_ul_li.html :

<li><a href="#ENV{valeur}">#ENV{cle}</a></li>

sera le modèle qui correspond à [<ul>(#FOREACH{ENV,ul_li})</ul>]

.

Plus de valeurs

Enfin, dans les cas plus complexes, on peut passer plus de valeurs au modèles en respectant la structure de tableau suivante pour la balise que vous aurez conçue :

array (
    'cle' => array (
        'val1' => 'valeur1'
        'val2' => 'valeur2'
        'val3' => 'valeur3'
        'val4' => 'valeur4'
    )
    'cle2' => array (
        'val1' => 'valeur1bis'
        'val2' => 'valeur2bis'
        'val3' => 'valeur3bis'
        'val4' => 'valeur4bis'
    )
)

et en fournissant un modèle adapté :

#ENV{val1}, #ENV{val2}, #ENV{val3} et #ENV{val4}

La définition de la balise #NUAGE dans le plugin du même nom est un bon exemple de ce cas.

Le code

Cette balise se trouve dans la version de développement de SPIP, mais voici comment l’intégrer dans un site qui tourne encore avec une version 1.9.2.

Lorsque vous passerez à la prochaine version, ça se passera sans douleur grâce au petit test de version ci-dessous.

  1. Récuperer le fichier 193_fonctions.php du plugin nuage et copiez-le dans votre dossier squelettes/,
  2. dans squelettes/mes_fonctions.php :
    <?php
    
    //intégration des fonctions nécessaires de SPIP 1.9.3
    if($GLOBALS['spip_version'] < 1.93)
            include_spip('193_fonctions');
    
    //vos filtres...
    
    ?>
  3. dans squelettes/modeles/foreach.html :
    #PUCE #ENV{cle} => #ENV{valeur}<br />

Dernière modification de cette page le 3 février 2008