La balise #ENV

Fonctionnement et usage divers et variés

Publié le : 25 septembre 2007 – Dernière modification le 21 décembre 2021 – par Maïeul – 70 commentaires

1
2
3
4
5
14 votes

Régulièrement, on lit sur la liste ou sur IRC « la balise #ENV, j’y comprends rien » . Tentons ici une explication sur le pourquoi du comment de cette balise...

13 - ENV, qu’est-ce à dire ?

Si nous lisons la documentation officielle, nous voyons que

[(#ENV{xxxx,zzzz})] permet d’accéder à la variable de nom xxxx passée par la requête HTTP. zzzz est une partie optionnelle qui permet de retourner une valeur même si la variable xxxx n’existe pas.

Ah... mais en fait, c’est plus subtil que cela. En réalité, #ENV permet d’accéder aux variables dites d’environnement d’un squelette.

14 - Qu’es aquò variable d’environnement ?

Un squelette SPIP est appelé dans un certain contexte. Par exemple, si vous appelez http://www.spip.net/spip.php?article1 ou bien http://www.spip.net/spip.php?article2, SPIP utilisera le même squelette , article.html, mais ne lui fournira pas les mêmes variables d’environnement.

15 - Mais quelles variables d’environnement sont passées aux squelettes ?

C’est vrai ça, on sait que le squelette reçoit des variables d’environnement, mais lesquelles ?

En préambule, je vais vous donner un « truc » pour savoir quelles variables
d’environnement sont passées à votre squelette.

Il s’agit d’un mode « debug » de SPIP. À la fin de l’adresse d’une page publique, rajoutez &var_mode=debug... Et là ? Surprise ! vous arrivez sur la page de débogage de squelette.

Sur cette page est listé chaque squelette appelé par la page, avec différents
détails...

Ce qui nous intéresse plus particulièrement, c’est la partie #ENV [1]

Prenons l’exemple du squelette de la dist, appelons la page http://site.tld/spip.php?article2&var_mode=debug, nous obtenons ceci

Et voilà la liste des variables d’environnement, avec leurs valeurs... Ainsi, dans cet exemple, si nous écrivons #ENV{id_article} dans le squelette article.html ; nous obtiendrons 2

Bon, d’accord... maintenant, on connaît ce truc, mais bon ... ce serait mieux si on savait d’avance quelles sont ces fameuses variables.

16 - Cas 1 : le squelette de la page

Sans doute le cas le plus simple. Le squelette qui est appelé « directement » quand on accède à une page reçoit comme variables #ENV l’ensemble des variables fournies par l’URL.

Exemple : http://www.site.tld/?page=xxx&var1=val1&

Passera au squelette xxx, les variables d’environnements suivantes :

VariableValeur
page xxx
var1 val1

17 - Cas 2 : les squelettes inclus

Bon, bon... vous incluez un squelette dans votre squelette...

Si vous faites <INCLURE{fond=yy}{var2=val2}> [2], le squelette yy reçoit les variables d’environnement suivantes :

VariableValeur
fond yy
var2 val2

Signalons, au passage que SPIP transmet par défaut, le contexte de langue au squelette inclus.

Ainsi, si vous incluez votre squelette dans un contexte de langue française, le squelette inclus recevra comme variable #ENV« lang » la valeur « fr ». Cependant, il y a possibilité de forcer la variable lang ainsi passée. Il suffit de faire, par exemple<INCLURE{fond=yy}{var2=val2}{lang=en}>.

Signalons aussi le cas des paramètres sans arguments... du genre <INCLURE{fond=yy}{id_article}. Eh bien, dans ce cas, le squelette inclus recevra la variable #ENV « id_article » dont la valeur sera celle de l’id_article courant.

Enfin, signalons la possibilité de passer à un squelette inclus l’ensemble des variables d’environnement du squelette incluant ! Il suffit pour cela d’ajouter le critère {env} dans l’appel de votre INCLURE... Cependant, il est conseillé d’éviter cela : en effet, rappelons qu’un fichier de cache est généré pour chaque combinaison de variable #ENV.

18 - Cas 3 : les modèles

Depuis SPIP 1.9.1, il est possible d’installer des modèles dans un article.

Pour rappel, la syntaxe générale de l’appel d’un modèle est <modelexxx|align|var1=val1|...|varn=valn>

Un modèle, n’est après tout qu’un squelette. Comme tout squelette, il reçoit des paramètres #ENV.

Prenons un exemple simple <modele1|left|variable=valeur>.

Les variables passées sont :

VariableValeur
id 1
id_modele 1
align left
variable valeur
lang Langue du contexte

Depuis SPIP 3, les modèles reçoivent aussi comme variables d’environnement les variables de la page l’appelant. Cependant les arguments passés explicitement au modèle se retrouvent dans #ENV{args/nomdelargument}.

19 - Cas 4 : les formulaires

Rappelons qu’un formulaire est composé de deux fichiers :
-  un squelette
-  un fichier php, chargé de la prise en charge des données.

C’est le fichier php, qui en appelant le squelette, va lui transmettre un certain nombres de variables #ENV. Il faut donc regarder pour chaque formulaire ce qu’il en est (via le mode debug).

20 - Cas 5 : les pages en « article »,« rubrique » etc

Les pages qui fonctionnent en URL propres fournissent leurs variables #ENV selon des règles spéciales.

Si une page fonctionnant en URL propres est une page de type « article », le squelette recevra comme variable d’environnement id_article de la valeur du numéro de l’article concerné...

Il en est de même pour les pages de types rubriques, mot, etc.

21 - Des variables d’environnement de date

Des variables d’environnement calculées automatiquement [3] sont passées à tout les squelettes calculés (sauf les modèles pour SPIP < 3)

Ces variables sont date et date_redac, qui ont pour valeur la date de calcul de la page... Elles servent au calcul des critères {age} et {age_redac}

22 - Forme abrégée

En dehors de toute boucle, #TOTO est strictement égale à #ENV{toto}. Cependant, sauf cas exceptionnel, on préférera la première syntaxe : en effet, #TOTO appelée dans une boucle possédant la balise #TOTO sera compris dans le contexte de cette boucle.

Exemple :

#ID_ARTICLE #ENV{id_article}
<BOUCLE_article(ARTICLES)>
#ID_ARTICLE #ENV{id_article}
</BOUCLE_article>
  • En dehors de la boucle #ID_ARTICLE et #ENV{id_article} sont équivalents.
  • Dans la boucle, en revanche, ils ne le sont pas.

23 - Quelles utilisations ?

De nombreuses utilisations sont possibles, notamment à l’aide des filtres de comparaisons. Cela pourrait être l’objet d’une documentation à part.

La balise #EXPOSE

Citons cependant le plus souvent demandé : l’utilisation de la balise #EXPOSE.

Dans une boucle (OBJETS), où chaque objet à un identifiant unique de la forme id_objet [4], lorsque cet identifiant est égal à la valeur de la variable d’environnement id_objet, la balise #EXPOSE retourne son premier argument ; sinon, son second argument.

Exemple : Soit la page www.domaine.tld/spip.php?page=toto&id_article=2

Supposons que notre site n’ait que deux articles, les numéros 1 et 2.

Si le squelette toto.html contient la boucle suivante

<BOUCLE_toto(ARTICLES)>
l'article n°#ID_ARTICLE #EXPOSE{"est l'article courant", "n'est pas l'article courant"}
</BOUCLE_toto>

Alors le résultat sera

l’article n°1 n’est pas l’article courant
l’article n°2 est l’article courant

/ !\ La syntaxe SPIP prohibe totalement de mettre des boucles entres {}. Seule des balises et filtres peuvent exister.

24 - Conclusion : encore pas mal de rédaction

Voilà ! Il y a encore pas mal de choses à écrire pour saisir toutes les subtilités des variables d’environnement, mais j’espère que cet article, laborieusement écrit à la sueur des mes doigts vous aura permis de comprendre un peu mieux comment les déterminer.

Notes

[1] ben oui quoi, c’est un tuto sur #ENV

[2] il semble que ce soit la même chose avec #INCLURE, mais j’avoue ne pas avoir saisi la nuance

[3] sauf si on force leurs valeurs lors d’un ou #INCLURE

[4] par exemple, dans une boucle (ARTICLES), chaque article à un identifiant id_article

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

22 discussions

  • 4
    Maxime Charruel

    Bonjour !

    Dans le but de finaliser mon plugin, j’ai besoin de faire passer mes variables d’environnement via un lien javascript. Je m’explique, j’ai ceci :

    <?php
	$flux .= '<script src="'.lienversmapage.'" type="text/javascript"></script>';
?>

    Je voudrais passer #ENV à mapage, quelquechose du genre :

    <?php
	$flux .= '<script src="(#ENV{'.lienversmapage.'})" type="text/javascript"></script>';
?>

    Mais c’est pas ça :P

    Merci !

    • Maïeul

      rien compris à ce que vous dite !

      pourquoi mettez vous du php ? normalement il n’y a pas besoin de php dans un squelette spip.

      Pouvez vous donner un exemple de type de liens que vous voudriez voir généré.

    • Maxime Charruel

      En fait, j’ai oublié de préciser que cette ligne de code se trouve dans monplugin.fonctions.php.
      Ma fonction est insert_head, elle doit insérer dans mon head un .js, d’où le :

      <script src="'.lienversmapage.'" type="text/javascript"></script>

      L’intégration du .js fonctionne parfaitement, seulement, dans mon .js, j’utilise les balises #ENV{type} et #ENV{page}. J’aurai donc besoin de faire passer mes variables d’environnement. Je suis peut-être sur une mauvaise piste, il y a peut-être une autre solution.

      En gros, j’aimerai que mon lien envoie ceci :

      <script src="'.lienversmapage.'&type=#ENV{type}" type="text/javascript"></script>

      Mais ça ne fonctionne pas !
      Merci !

    • Maxime Charruel

      J’ai ciblé le problème, en fait, vu que mon fichier .js est dans le header, quand je fais #ENV{page} je me retrouve avec le nom du fichier .js (dont je m’en fous complètement :P).
      Je souhaite récupérer le nom de la page (rubrique/article/auteur), seulement voilà, dans l’ordre d’appel, j’ai mon header / mon css / ma page :(

      Je vais voir si, avec un lien, je peux pas récupérer les variables d’environnement !

    • Maïeul

      malheureusement dans le php on ne peut pas utiliser les balises de spip.

      En revanche je pense que les variables d’environnement se trouve dans le tableau des $GLOBALS

      ceci dit, pourquoi passer par un insert_head si ce n’est pas pour faire un plugin ? autant mettre directement dans le head à partir du du squelette ...

    Répondre à ce message

  • 1

    Bonjour,

    Article très intéressant mais il reste encore des zones d’ombres pour moi.
    Par exemple :
    J’ai une url du type ?rubr=1,2,3 (encodée avec urlencode de php)

    dans le fichier qui reçoit ce paramètre si je fais
    #ENV{rubr} ça affiche bien 1,2,3
    maintenant, si je mets dans une boucle du type

    <BOUCLE_lieux(ARTICLES){id_secteur=1}{id_rubrique IN #ENV{rubr}}>

    Ca n’affiche que la rubrique 1 (le premier id qu’il rencontre)

    J’ai essayé de faire un filtre dans mes_fonctions.php avec un urldecode mais je ne sais pas où le mettre.

    #ENV|mon_filtre{rubr} renvoie un tableau sérialisé de toutes les variables d’environnement et

    #ENV{rubr}|mon_filtre n’agit pas.

    D’où question : peut-on appliquer un filtre sur #ENV, si oui, comment ?

    Sinon, comment faire pour récupérer ce genre d’url ?

    Merci à toutes et tous

    Serge

    • Maïeul

      Bonjour,

      je suis vraiment étonné que votre test n’agisse pas. Êtes vous sûr que vos rubrique 1,2,3 soit dans le secteur 1 ?

    Répondre à ce message

  • 3
    wal

    bonjour à tous,
    j’ai une petite question : dans spip 2, peux-t’on passer une variable quelconque dans une url (genre monsite/spip.php ?rubrique60&toto=7), et récupérer ensuite cette variable avec la balise #ENVtoto  ?

    merci de vos réponses !

    • Maïeul

      oui, tout à fait ... c’était déjà le cas avant.

      Attention, la variable #ENV n’est passé qu’au premier squelette appelé, pas au squelette inclu, sauf si tu explicite lors de l’appel que tu veux lui passer...

    • wal

      ok merci !
      mais ça marche pas chez moi... si je résume, avec mon url monsite/spip.php ?rubrique60&toto=7, je passe la variable toto au squelette rubrique.html, et je récupère la valeur de toto dans ce squelette grace à la balise #ENVtoto, échec, sauf que ça me retourne systématiquement « échec » ... comprends pas... quelqu’un a deja rencontré ce problème ? j’ai passé l’après midi dessus, rien à faire...

    • MR

      Quelle version de spip utilises-tu ?

      Parce qu’un GROS bug présent dans la v2.0.7 a pour conséquence que seul le premier paramètre de l’URL est récupé par cette balise, donc
      #ENVtoto est vide alors que

      <?php
$toto = $_GET['toto'];
?>

      affectera bien 7 à toto !
      Lire :

      http://trac.rezo.net/trac/spip/ticket/1755

      Ce bug est corrigé dans la v2.0.8

    Répondre à ce message

  • 4
    Cédric

    Bonjour

    Je me sert de la balise #ENV pour filtrer une boucle... jusque la pas de problème, tout fonctionne bien. Le problème arrive quand il n’y a pas le filtre définit dans l’url, donc pas dans #ENV, la boucle ne sort rien. Je voudrais qu’elle sorte tout.

    Illustration :

    J’ai des articles sur lesquels j’attribue des mots clé A, B ou C.

    Je passe en url un « monsite/spip.php ?page=mapage&motcle=id_A » (id_A correspondant à l’id des mots clé).

    Dans le squelette il y a une boucle ARTICLES filtré par « id_mot=#ENVmotcle ».

    S’il n’y a pas d’info de mot clé en url, la boucle est vide. J’aimerais au contraire qu’elle affiche tout les articles.

    Comment faire pour utiliser le même squelette quand il n’y a pas de « &motcle » passé en url ?

    Avec une boucle sur les mots clé existant et une syntaxe du type &motcle[]=id_dumotcle envoyé en url (une belle url bien longue...), un filtre « id_mot IN #ENV**motcle » me renvoie tous les articles avec n’importe quel mot clé, mais pas les articles sans mot clé.

    • Maïeul

      bonjour,

      pas sur d’avoir bien compris votre problème,

      mais je pense qu’il faut utiliser la syntaxe alternative #ENV{var,valeur_alternative}

    • Cédric

      Quelle valeur utiliser pour la valeur alternative ?

      Si je filtre ma boucle par un mot clé : BOUCLE(ARTICLES) id_mot=#ENVmotfiltre,0.

      Problème si je ne passe pas de motfiltre dans l’url il cherche mon mot clé 0 et ne me sort aucun article dans la boucle.
      Je cherche donc à supprimer le filtre dans le cas où il n’est pas renseigné dans l’url pour afficher tous les articles. j’aimerai ne pas créer un squelette différent où je supprime le filtre par id_mot.

    • Régis

      Un petit message simplement pour dire que je me cogne exactement à la même problématique que Cédric (voir quelques messages plus bas).
      Si quelqu’un a un élément de réponse pour cette question, je suis preneur.

      En attendant, j’utilise des boucles conditionnelles en php pour vérifier l’existence de mes #ENV précédemment passés en GET.

    • Et bien pour ceux qui se sont posé la même question que Cédric et moi, il y a des éléments de réponse ici : http://forum.spip.org/fr_211033.html

    Répondre à ce message

  • piercol

    OK, j’ai mis un moment à comprendre, mais maintenant ça fonctionne.

    Je pensais - je ne sais pas pourquoi - qu’il fallait déclarer une valeur par défaut de #ENV au moment du chargement de la page, j’avais écrit #ENV{tri} dans mes boucles.
    je l’ai corrigé en
    #ENV{tri,date}
    et ça roule.

    Merci pour le coup de main.

    Répondre à ce message

  • 1
    piercol

    Merci pour votre réponse rapide

    Ce que je ne vois pas, c’est où je dois écrire cette expression dans ma page.

    Dans le head ?, dans le body ? à quel endroit ?

    et j’écris #ENV{tri,date} comme cela, sans < >, ou [ ]

    • Maïeul

      ben j’en sais rien moi où il faut que vous le mettiez ... c’est votre code après tout ;-) d’autant que vous aviez l’air de comprendre comment se servir de la blise #ENV pour le système de tri

      non, plus sérieusement, je suppose que vous avez un boucle du genre

      <BOUCLE_xxx (XXX) {par #ENV{tri}}>

      et donc il faudrait mettre
      <BOUCLE_xxx (XXX) {par #ENV{tri,valeur_alternative}}>

      pas besoins de crochet normalement

    Répondre à ce message

  • 1
    piercol

    Dans le sommaire de mon site, je propose aux visiteurs de choisir le mode de tri des liste d’articles (par date de création ascendante ou descentante, date de mise à jour, titre, popularité, nombre de visites, et hasard).

    Cela fonctionne parfaitement dans la page, grâce à l’utilisation de la balise #ENV qui envoie les critères de tri à partir d’un des boutons vers une boucle où #ENV détermine le critère de tri.

    Le problème que je ne parviens pas à résoudre est le suivant : comment entrer dans la page sommaire avec une adresse qui ne comporte pas l’indication du critère de tri ?

    En effet si j’entre dans l’adresse spip.php&tri=date, ou tri=titre pas de problème

    Mais si j’entre simplement dans spip.php, j’ai une erreur squelette, parce que la balise #ENV est vide

    il manque quelque chose du genre if #ENV est vide alors #ENV=date, au moment du chargement de la page.

    Quel pourrait être la syntaxe de ce petit script php ?

    Voir sur le site à ces deux adresses :

    -  ce qui marche http://www.histoirepassion.eu/index.php?tri=date

    -  ce qui ne marche pas http://www.histoirepassion.eu/index.php

    • Maïeul

      il faut utiliser la syntaxe alternative

      #ENV{tri,valeur_si_vide}

      par exemple si vous voulez que par défaut cela soit triè par date #ENV{tri,date}
      (remarquez que c’est dit dans l’article)

    Répondre à ce message

  • 7

    bonjour,

    saurais tu pourquoi lorsqu’un rédacteur tape
    <message|texte=C'est pour nous, une façon de vivre>

    et que le modéle contient
     [(#ENV*{texte}|propre)]

    cela donne
       <p class="spip">C’est pour nous, une façon de vivre</p>

    impossible d’enlever le p class=spip..

    merci d’avance

    • pommé

      Je complète ma question : si dans un modèle je récupère, avec la balise #ENV, la variable texte comment :

      1- récupérer les adresses mails, liens saisis par le rédacteur (en 1.9.2c j’obtiens @@SPIP_ECHAPPE_LIEN_1@@ à la place du mail)

      2- les documents /images inclus dans le texte.. je n’obtiens rien

      J’ai essayée des combinaisons de  #ENV, #ENV*, #ENV**, typo, propre   mais je n’y arrive pas.

      Ps : je sais récupérer un seul lien ou une seule image passée explicitement dans le modéle avec <modelexx|doc=10|mail=xxx|texte=blabla> mais pas ceux placés dans le texte.

      Merci pour vos éclaircissements

    • Maïeul

      La classe spip se resout avec le plugin couteaux suisse et la dernière version de spip

    • Jérémie

      Bonjour,

      En réponse à pommé 23 novembre 2007 10:40

      J’ai également ce problème sur mes modèles créés. Je voudrais y passer des liens via la redaction d’article (placés dans le texte) et j’obtient également @@SPIP_ECHAPPE_LIEN_1@@

      Est-ce que ce problème a été résolu ? Je suis SPIP 1.9.2d
      J’ai également testé sur la Beta de SPIP 2.0 mais le problème existe toujours...

      Y’a t-il un solution ?

    • Maïeul

      hum ...

      quel est le code utilisé ?

    • Jérémie

      J’ai réalisé un petit modèle de manière à faciliter la saisie pour une mise en page donnée, or j’aurais aimé pouvoir y passer des liens de type raccourci SPIP à savoir [texte de lien->7] directement depuis le champ de saisi des articles. Or je me retrouve avec un @@SPIP_ECHAPPE_LIEN_1@@ en lieu et place du lien.

      Voici le code de mon modèle, il n’est pas très compliqué :

      <li[ class='[(#ENV{state}|?{done})] (#ENV{step}|propre) spip_lien_ok'][ style='float:(#ENV{align}|match{left|right});']>
	[<a href="(#ENV{lien})"[ class="(#ENV{lien_class})"]>]
		[<img src="#CHEMIN{images/}(#ENV{step}|propre).png" alt="" />]
	[(#ENV{lien}|?{</a>})]

        [(#REM) parties où viendraient se placer mon texte pouvant contenir des liens]
	[<h3>(#ENV*{step_title}|typo)</h3>]
	[<p>(#ENV*{step_subtitle}|typo)</p>]
</li>

      et voici donc ce que je dois saisir dans la fenêtre de rédaction de SPIP :

      <step
   |step=4
   |step_title=Step's title here
   |step_subtitle=Little texte explaining the step [plus some links->7]
>

      donc là où j’ai placé [plus some links->7]
      SPIP va m’afficher @@SPIP_ECHAPPE_LIEN_1@@

      Et si je place un second lien j’ai @@SPIP_ECHAPPE_LIEN_2@@, un troisième @@SPIP_ECHAPPE_LIEN_3@@, etc.

      Est-ce normal ? Comment faire pour avoir mon lien vers l’article 7 ?

      Merci !!

    • Maïeul

      je pense que c’est liè à l’ordre dans lequel spip traite les raccourcis...

      je ne vois pas trop comment faire.
      il faudrait écrire sur la site des devellopeurs à mon avis

    • Jérémie

      Ouaip j’ai mis un ticket...

      Merci en tous les cas.
      En attendant va falloir que je trouve une alternative...

      Jé.

    Répondre à ce message

  • Corinne

    Bonjour,
    Ma problématique est la suivante, j’aimerai afficher différemment les articles anciens ie plus vieux que juin 2008, je pense que la balise #ENV peut me permettre de récupérer la variante date, mais ensuite, quid ?
    Si quelqu’un peut m’aider ...
    merci d’avance

    Répondre à ce message

  • b.poiraud

    Bonjour

    Je cherche un tuto de base sur l’utilisation de DEBUG

    je viens en effet de trouver ceci :

    http://echange.ovh.org/?var_mode=debug

    et je ne sais pas du tout ce que cela peut vouloir dire.

    Auriez-vous une indication à me donner ?

    Merci

    B.Poiraud

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom