SPIP

#SELF

Aurélie — 2010-03-08T00:11:50Z

La balise #SELF retourne l'URL de la page en cours.

Sommaire

Les variables propres à l'exécution de SPIP (par exemple, var_mode) sont supprimées.
Ainsi, pour une page avec l'url spip.php?article25&var_mode=recalcul, la balise #SELF placée dans article.html retournera spip.php?article25.

Usages

- Certaines balises de formulaires acceptent un paramètre pour préciser sur quelle page le visiteur doit être redirigé après avoir validé le formulaire. #SELF peut alors être utilisé pour qu'il revienne sur la page courante. Exemple : [(#FORMULAIRE_FORUM{#SELF})]

- Avec le filtre |parametre_url, pour ajouter des variables dans l'URL de la page courante. Exemple : [(#SELF|parametre_url{'id_mot','3'})] ajoute id_mot=3 à l'URL courante. Voir |parametre_url pour plus de détails.

- #SELF est utile dans les formulaires, pour que l'utilisateur revienne à la page courante après validation :

 [(#SELF|form_hidden)] ...

Note : le filtre |form_hidden calcule les champs cachés (hidden) du formulaire à partir des arguments de #SELF.

SELF dans les squelettes inclus

Lorsque l'un des paramètres de l'URL de la page doit être récupéré dans un squelette inclus, #SELF doit être ajouté comme paramètre de l'INCLURE. De cette façon, un cache différent du squelette inclus sera créé pour chaque URL [1].

Ce paramètre {self=#SELF} doit également être passé à un INCLURE lorsque l'on veut utiliser la balise #PAGINATION dans un squelette inclus, étant donné que celle-ci repose sur la fonction self pour retrouver la variable debut_....

Voir aussi

d'autres squelettes

[1] Ceci constitue une sécurité contre une potentielle attaque XSS.

#REM

Aurélie — 2010-03-01T08:19:01Z

La balise #REM ne produit aucun affichage : elle permet de commenter le code des squelettes.

[(#REM) Ceci est une remarque ]

La balise et sa partie optionnelle sont purement et simplement supprimées lors du calcul du squelette. [(#REM)] n'apparaît pas dans le code HTML du site public et ne produit donc aucun affichage.

Attention toutefois aux effets pervers de #REM< : la partie optionnelle d'une balise ne devant pas contenir de boucle, l'écriture ci-dessous

[(#REM) essai de boucle: ne pas afficher !  #ID_ARTICLE - #TITRE  ]

retournera :
essai de boucle: ne pas afficher ! 18 - Mon titre d'article

|find

Aurélie, denisb — 2009-12-23T16:52:35Z

Le filtre |find appliqué à un tableau vérifie la présence d'une valeur dans le tableau

Le filtre |find permet de vérifier la présence d'une valeur dans le tableau auquel il est appliqué :

[(#GET{mon_tableau}|find{la_valeur}|oui) Ceci s'affiche si la valeur «la_valeur» est bien présente dans le tableau «mon_tableau».]

Si #GET{mon_tableau} n'est pas un tableau (array au sens PHP), la balise filtrée par |find ne retourne rien.

Voir aussi : le filtre |in_any

|table_valeur

Aurélie — 2009-12-23T11:18:24Z

Le filtre |table_valeur{clé,valeur par défaut} retourne la valeur associée à une clé dans un tableau.

Sommaire

Utilisation

|table_valeur{clé,valeur par défaut}

Le filtre |table_valeur s'applique à une balise contenant un tableau, prend une clé du tableau comme paramètre et retourne la valeur associée à cette clé.

Voir la balise #ARRAY pour une explication plus générale sur les tableaux.

Exemple

#SET{un_tableau,#ARRAY{0,rouge,1,bleu,2,vert}} [(#GET{un_tableau}|table_valeur{2})]

…retourne vert.

Le paramètre optionnel valeur par défaut permet de préciser une valeur à retourner si la valeur n'est pas trouvée (la clé n'existe pas ou la balise filtrée n'est pas un tableau).

[(#GET{un_tableau}|table_valeur{3,noir})] retourne noir parce qu'il n'y a pas de clé 3.

Avec des tableaux "linéarisés"

|table_valeur fonctionne aussi avec des tableaux "linéarisés", par exemple, les tableaux retournés par les balises #ENV et #CONFIG (mais ces balises disposent de leur propre syntaxe pour accéder aux valeurs du tableau).

Le tableau ci-dessus linéarisé donne ceci :

a:3:{i:0;s:5:"rouge";i:1;s:4:"bleu";i:2;s:4:"vert";}

[(#GET{un_tableau}|table_valeur{2})] retourne toujours vert.

Voir aussi

les fonctions serialize et unserialize en PHP

|push

Aurélie — 2009-12-23T11:17:33Z

|push permet d'ajouter une valeur à la fin d'un tableau.

Le filtre |push s'applique à une balise contenant un tableau PHP (voir #ARRAY) et y ajoute une nouvelle valeur.

La clé est incrémentée de 1 à chaque nouvelle valeur. Si aucune clé n'a été définie pour la première valeur, le tableau est indexé à partir de 0 (la première clé est 0).

#SET{un_tableau,#ARRAY{5,une_valeur}} #SET{un_tableau,#GET{un_tableau}|push{une_autre_valeur}} #SET{un_tableau,#GET{un_tableau}|push{une_troisieme_valeur}}

[(#GET{un_tableau}|foreach)] affiche :

5=> une_valeur
6=> une_autre_valeur
7=> une_troisieme_valeur

La première clé est 5 parce qu'elle a été précisée lors de la création du tableau (premier #SET).

Exemple courant d'usage de |push :

#SET{mes_articles, #ARRAY}  #SET{mes_articles, #GET{mes_articles}|push{#ID_ARTICLE}}

Si les articles sélectionnés par la BOUCLE portent les numéros 2, 5 et 10, [(#GET{mes_articles}|foreach)] retourne :

0=>2
1=>5
2=>10

Ici, la première clé est zéro car aucune clé n'a été définie préalablement.

Contrairement à la fonction PHP array_push, |push ne produit pas de message d'erreur si la balise filtrée n'est pas un tableau.

|parametre_url

Aurélie, denisb — 2009-10-10T05:24:25Z

Le filtre |parametre_url ajoute ou retire un paramètre à une balise d'URL.

Sommaire

Utilisation

Ce filtre s'applique donc à une balise d'URL, par exemple #SELF, #URL_ARTICLE, #URL_PAGE{sommaire}...

Typiquement, on placera la balise dans l'attribut href d'un lien :

France

ajoutera à l'url de la page en cours soit :

?pays=france s'il s'agit du premier paramètre passé à cette url,
&pays=france si l'url possède déjà au moins un paramètre.

Passer plusieurs paramètres à l'URL

On peut enchaîner les filtres pour passer en url une suite de paramètres et leurs valeurs :

 [(#SELF|parametre_url{pays,france}|parametre_url{monnaie,euro})]

Si l'on désire passer une même valeur à plusieurs paramètres, on utilisera l'écriture :

[(#SELF|parametre_url{pays|lieu|terrain,france})]

qui retournera l'url de la page en cours argumentée de :
pays=france&lieu=france&terrain=france

Passer un tableau de valeurs

Si l'on désire passer plusieurs valeurs pour un même argument, il est possible de passer le tableau de ces valeurs, avec les balises #ARRAY ou #LISTE.
Exemple :

[(#SELF|parametre_url{ville,#LISTE{Toulouse,Valence,Montpellier,Paris}})]

Supprimer des paramètres existants

Pour faire disparaître un paramètre d'url existant, il faut le vider de sa valeur en le déclarant à nouveau, mais explicitement vide :

[(#SELF|parametre_url{pays,''})]

On peut supprimer plusieurs paramètres à la fois avec l'écriture :

[(#SELF|parametre_url{pays|lieu|terrain,''})]

Récupérer un paramètre passé dans une URL

On utilisera la balise #ENV.

Ainsi, dans l'exemple

France

#ENV{pays} retournera france.

Autre exemple, le plugin "Calendrier_mini" récupère des informations dans le contexte d'affichage du mini calendrier comme suit [1] :
... #ENV{urljson}|parametre_url{id_rubrique} ...

Explication : la variable #ENV{urljson} contient une url et le code ci-dessus retourne la valeur de id_rubrique si ce paramètre est présent dans l'url en question.

Forcer le séparateur

Par défaut, les URLs sont encodés avec le séparateur & mais il est possible de forcer le séparateur en indiquant un 3ème argument
|parametre_url{nom de variable, valeur, separateur}

Ainsi

[(#URL_PAGE{bloc}|parametre_url{id_bloc, 5})]

retournera spip.php?page=bloc&id_bloc=5

[(#URL_PAGE{bloc}|parametre_url{id_bloc, 5, &}]

retournera spip.php?page=bloc&id_bloc=5

Voir aussi

[1] Voir le code complet sur la zone : http://zone.spip.org/trac/spip-zone....

#ARRAY

Aurélie, BoOz, denisb — 2009-06-16T06:52:27Z

La balise #ARRAY peut contenir un tableau PHP, c'est-à-dire un ensemble de paires clé/valeur, que l'on veut stocker pour les réutiliser dans la suite du squelette.

Le tableau doit être déclaré par la balise #SET et peut ensuite être récupéré par la balise #GET [1].

Il peut être utilisé ensuite, entre autres, associé au critère IN d'une boucle.

Sommaire

Déclarer un tableau et récupérer des valeurs

- #SET{mon_tableau, #ARRAY{cle1,valeur1,cle2,valeur2}}
crée la variable mon_tableau et lui affecte un tableau PHP comme valeur, qui pourrait être représenté comme suit :

Clés	Valeurs
cle1	valeur1
cle2	valeur2

Il n'est pas nécessaire d'entourer les chaines de caractères avec des guillemets simple ou double, sauf pour spécifier une chaine vide qui s'écrira ''

- À des fins de test, on peut afficher le tableau grâce au filtre |foreach (déprécié depuis SPIP 4)

- La valeur associée à une clé donnée peut être récupérée en utilisant le filtre |table_valeur :

[(#GET{mon_tableau}|table_valeur{cle1})] retourne valeur1.

Depuis SPIP 3.0, on peut simplifier sous la forme suivante [(#GET{mon_tableau/cle1})].

- Vérifier la présence d'une valeur dans le tableau avec le filtre |find [2] :

[(#GET{mon_tableau}|find{valeur2}|oui) Ceci s'affiche si la valeur est dans le tableau. ]

Remplir un tableau dynamiquement

Un intérêt des tableaux est de les remplir dynamiquement, par les résultats d'une ou plusieurs boucle(s).

Le tableau doit alors être déclaré par un #SET avant la boucle : #SET{mon_tableau,#ARRAY}

Dans la boucle, un nouveau #SET redéfinit mon_tableau à chaque itération : on le récupère par #GET et on y ajoute une nouvelle valeur grâce aux filtres |push ou |array_merge.

#SET{mon_tableau,#ARRAY}  #SET{mon_tableau, #GET{mon_tableau}|push{#COMPTEUR_BOUCLE}}

L'ordre des valeurs du tableau dépend des critères de tri de la boucle.

- |push ajoute simplement une valeur à la fin du tableau. La clé est indexée automatiquement : elle est incrémentée de 1 à chaque itération de la boucle et ce, à partir de 0 (la première clé est 0, puis 1, 2, 3,...).

Exemple : créer un tableau mots_choisis contenant les #ID_MOT de tous les mots-clés liés à un article.

#SET{mots_choisis, #ARRAY}  #SET{mots_choisis, #GET{mots_choisis}|push{#ID_MOT}}

Si les mots liés à cet article portent les numéros 4, 9 et 18, [(#GET{mots_choisis}|foreach)] retourne :

0=>4
1=>9
2=>18

Notez bien que [(#GET{mots_choisis}|table_valeur{2})] retourne 18, la valeur associée à la clé 2, donc la troisième valeur du tableau.

- |array_merge ajoute une paire clé/valeur à la fin du tableau. Cela permet donc de forcer le "nom" des clés.

Attention (1) : si une clé apparaît plusieurs fois, seule la dernière valeur pour cette clé sera retenue.

Attention (2) : la clé que l'on veut forcer ne peut pas être de type numérique. En effet, la documentation de array_merge précise :

Si vous passez un seul tableau à cette fonction et qu'il a des index numériques, les clés seront réindexées normalement.

Il existe deux solutions à cette limitation :

- préfixer cette clé avec une valeur alphabétique :

#SET{mots_choisis, #ARRAY}  [(#SET{mots_choisis,#GET{mots_choisis}|array_merge{#ARRAY{mot#ID_MOT,#TITRE}}})]

[(#GET{mots_choisis}|foreach)] retourne :

mot4=>Pomme
mot9=>Banane
mot18=>Carotte

- inverser clé et valeur, à condition que valeur ne soit pas elle aussi numérique :

#SET{mots_choisis, #ARRAY}  [(#SET{mots_choisis,#GET{mots_choisis}|array_merge{#ARRAY{#TITRE,#ID_MOT}}})]

[(#GET{mots_choisis}|foreach)] retourne :

Pomme=>4
Banane=>9
Carotte=>18

Dans ce cas, on pourra appliquer la fonction PHP |array_flip comme filtre sur le tableau final (après la boucle) :

[(#SET{mots_choisis, #GET{mots_choisis}|array_flip})]

[(#GET{mots_choisis}|foreach)] retourne alors :

4=>Pomme
9=>Banane
18=>Carotte

Dans certains cas, on pourra utiliser la balise #LISTE qui permet de saisir des tableaux sous forme simplifiée

Utiliser le tableau dans une boucle avec l'opérateur IN

Reprenons le tableau mots_choisis contenant des #ID_MOT, on peut sélectionner ensuite les articles liés aux mêmes mots-clés que notre article initial grâce au critère IN.

#SET{mots_choisis, #ARRAY}  #SET{mots_choisis, #GET{mots_choisis}|push{#ID_MOT}}   #TITRE

Cette utilisation connaît de multiples usages, notamment lorsque l'on veut sélectionner des objets à l'aide de plusieurs critères qui ne peuvent faire partie de la même boucle, puis les mélanger entre eux avec un critère de tri unique.

Exemples d'utilisation des tableaux

- Affichage conditionnel en fonction de la page (valeur de #ENV{page}) :

[(#ENV{page}|in_array{#ARRAY{0,article,1,rubrique,2,site}}|oui) Affichage conditionnel: la page est celle d'un article, d'une rubrique ou d'un site. ]

- Affichage conditionnel en fonction d'une variable passée dans l'URL [3] :

 #TITRE  #SET{les_mots, #ARRAY}  #SET{les_mots, #GET{les_mots}|push{#ID_MOT}}  [
Ceci s'affichera si la valeur de la variable 'lolo' passée dans l'url est présente dans un tableau 'les_mots' déclaré et rempli précédemment. (#ENV{lolo}|in_any{#GET{les_mots}}|oui)]

- Sélectionner les articles d'une rubrique et ceux associés par ailleurs à un mot-clé puis lister tous ces articles par date.

#SET{les_articles,#ARRAY}  #SET{les_articles,#GET{les_articles}|push{#ID_ARTICLE}}   #SET{les_articles,#GET{les_articles}|push{#ID_ARTICLE}}   
#TITRE

Boucler sur n'importe quel tableau

On pourra utiliser la boucle DATA pour boucler arbitrairement sur un tableau.

Tester si un tableau est vide

1er cas
Si #GET{mon_tableau} est un tableau vide

/* je déclare un tableau vide */ [(#SET{mon_tableau, #ARRAY})] /* alors le test suivant est suffisant : */ [(#GET{mon_tableau}|non) … ]

2e cas
Dans le cas d'entrées vides dans le tableau tel que :

[(#SET{mon_tableau, #ARRAY{0,'',1,0}})]

…on pourra utiliser la fonction PHP array_filter() qui enlèvera du tableau toute valeur équivalente à false du tableau.

[(#GET{mon_tableau}|array_filter|non) ... ]

Voir aussi

#LISTE : balise pratique pour déclarer de simples tableaux indexés
La boucle DATA : pour utiliser des tableaux complexes

[1] Voir #SET et #GET pour plus de détails.

[2] |find correspond à la fonction PHP in_array, à la différence que ce filtre ne produit pas le message d'erreur "Warning : in_array() [function.in-array] : Wrong datatype for second argument." si la variable n'est finalement pas un tableau. En effet, lorsqu'une variable est générée dynamiquement, on ne sait pas toujours si elle existera et s'il s'agira bien d'un tableau.

[3] Voir #SELF et |parametre_url.

#ENV

Aurélie, cam.lafit, denisb — 2009-02-14T13:48:34Z

#ENV{parametre} récupère des variables d'environnement transmises au squelette. Un second argument permet de donner une valeur par défaut si le paramètre demandé n'est pas présent dans l'environnement ou si son contenu est vide.

Sommaire

Description

[(#ENV{paramètre, valeur par défaut})]

Chercher dans un sous tableau
Le nom du paramètre d'environnement peut également contenir des barres obliques / indiquant de chercher dans un sous tableau. Cette écriture est équivalente à l'appel du filtre |table_valeur et est aussi valide sur les balises #GET, #SESSION et #CONFIG.

#ENV{parametre/dans/un/tableau, valeur par défaut} // équivalent à : [(#ENV**{parametre}|table_valeur{dans/un/tableau, valeur par défaut})]

Enfin, la balise #ENV toute seule retourne un tableau sérialisé de tous les paramètres d'environnement.

Exemples

Récupérer un identifiant d'article, sinon la chaîne « new » :

#ENV{id_article,new}

Récupérer dans une boucle les valeurs de l'id_rubrique et de l'id_mot passées dans l'URL spip.php?rubrique24&id_mot=5

…

Récupérer l'id_article passée dans un INCLURE :

Dans mon_squelette.html, #ENV{id_article} vaut 136.

Exemples avancés

Avec dans l'URL ?afficher[articles]=oui, tester si on affiche les articles :

#ENV{afficher/articles} // affiche 'oui'

Afficher tout l'environnement (utile pour débugguer) :

[(#ENV**|unserialize|print_r{1})
]

Important : Pour des questions de sécurité, il faudra absolument retirer ce code à la fin de développement de votre site.

Court-circuiter les traitements de sécurité

Par défaut, SPIP applique les fonctions interdire_scripts() et |entites_html à la balise #ENV. Comme pour toute balise, on peut supprimer les traitements automatiques de SPIP avec #ENV* et #ENV** (voir, pour l'usage de * et **, l'article #BALISE* et #BALISE**).

- #ENV* retourne la variable sans appliquer le filtre |entites_html , donc sans transformer tous les caractères spéciaux en entités HTML.

- #ENV** retourne la variable sans appliquer également la fonction interdire_scripts(). Elle renvoie donc le PHP exécuté.
Ceci peut poser un problème de sécurité si cette variable reçoit une injection de code.

Néanmoins #ENV** trouve des applications, par exemple dans l'espace privé où la fonction interdire_scripts() est appliquée de façon plus restrictive. #ENV** permet alors de lever ces restrictions de façon très localisée. Mais encore une fois, à utiliser en connaissance de cause !

Voir aussi

d'autres squelettes
Le filtre |setenv

Sur Programmer.spip.net

#PETITION

Aurélie, cam.lafit — 2009-01-07T21:34:05Z

#PETITION affiche le texte de la pétition si elle existe.

Si elle existe mais que le texte est vide, retourne un espace (une chaîne non vide sans incidence dans une page html). Ceci permet de tester l'existence d'une pétition dans une boucle (ARTICLES).

Exemple tiré de squelettes-dist
Le squelette inclure/petition.html n'est inclus que si la pétition de l'article est activée :
[(#PETITION|oui)]

Exemple avancé
On inclut le squelette inc-petition.html, soit s'il y a des signatures, soit s'il y a une pétition. En effet, lorsque l'on supprime une pétition via l'espace privé, afin de clore la possibilité de la signer, le code précédent supprime également la liste des signatures.

   [(#PETITION|oui) ]