Carnet Wiki

Astuces longues pour SPIP !

Version 13 — Juin 2012 denisb

Les Astuces longues de SPIP sont des astuces qui nécessitent plus de 20 lignes pour être expliquées : voir les Astuces courtes pour SPIP courtes.


-  Partager des données entre plusieurs squelettes inclus (Zpip)

Question :
Dans ZPIP, la structure de base est définie à coup d’inclusion de grands blocs logiques du style

       ...        <div id="contenu">
                       < INCLURE{fond=contenu/#ENV{type},env}>
               </div>

               <div id="navigation">
                       < INCLURE{fond=navigation/#ENV{type},env}>
                       < INCLURE{fond=extra/#ENV{type},env}>
               </div>....

Supposons par exemple que nous soyons dans un contexte "rubrique" http///monsite.fr/spip.php?rubriqueXX
et que le squelette contenu/rubrique.html se comporte de manière à afficher l’article N°yy

Comment peut-on transmettre cet id_article dans l’inclusion extra ou dans l’inclusion navigation pour, par exemple, lister les autres articles de la rubrique. Il faut bien que le squelette appelé connaisse l’id de l’article à exclure que seul contenu/rubrique.html connait !

Pour que extra/rubrique.html ou navigation/rubrique.html puisse tenir compte de la situation, il faut disposer d’un moyen pour leur transmettre cette valeur. Or, seul le squelette appelant peut transmettre une variable...

Réponse :
L’astuce (alambiquée) pour remonter des variables d’un squelette appelé, est d’affecter le résultat sérialisé de ce squelette à une variable tableau dans le squelette appelant :

Dans structure.html :

[(#SET{myvars,[(#INCLURE{fond=vars/#ENV{type},env})]})]

Dans vars/rubrique.html :

#CACHE{3600}
[(#SET{vars,#ARRAY{
   objet,rubrique,
   id_objet,#ENV{id_rubrique},
   titreRubrique,Rubriques,
   titrePage,#ENV{id_rubrique}?
}})]

<BOUCLE_rub(RUBRIQUES){id_rubrique}>
   [(#SET{vars, #GET{vars}|array_merge{#ARRAY{titreRubrique,#TITRE,idRubrique,#ID_RUBRIQUE}}})]
</BOUCLE_rub>  

[(#GET{vars}|serialize)]
#FILTRE{trim}

Puis dans structure.html :

<INCLURE{fond=extra/#ENV{type},env}>

-  ZPIP : faire un inclure de squelette suivant une condition
dans le body de ZPIP, charger ou non un INCLURE qui contient #ENV{type}

[(#ID_RUBRIQUE|=={10}|?{
        ''
,
        <INCLURE{fond=extra/#ENV{type},env}>
})]

ne fonctionne pas à cause de accolades de #ENV, donc contourner avec
[(#ID_RUBRIQUE|=={10}|non) <INCLURE{fond=extra/#ENV{type},env}> ]


-  une boucle qui ne doit être exécutée que dans un certain contexte

tout le monde le sait (beaucoup le déplorent) :

[(#ENV{var}|=={val}|oui) <BOUCLE_test(TABLES){critere}>...</BOUCLE_test> ]

ne fonctionne pas.

en SPIP3, le critère {si ...} permet de définir la condition d’exécution depuis la boucle elle-même.

en SPIP2, il faut utiliser le plugin « bonux » et sa boucle « CONDITION ».

il existe néanmoins un autre moyen pour arriver à nos fins...

#SET{test, #ENV{truc}|=={coucou}|?{0, 999999}}
<BOUCLE_de_test(TABLES){id_table > #GET{test}}>
coucou !
</BOUCLE_de_test>

explications :

  • en premier lieu nous définissons notre test (présence de la variable « truc » dans l’environnement) et nous affectons à une variable « test » la valeur« 0 » ou « 999999 ».
    à ce stade, #GET{test} vaut donc soit « zéro », soit « neuf cent quatre-vingt-dix-neuf mille neuf cent quatre-vingt-dix-neuf ».
  • nous lançons alors la boucle dans laquelle nous demandons que l’« id_table » soit supérieur à notre valeur de test définie juste au-dessus.
    et le tour est joué...

DATE DU JOUR

dans un squelette, afficher la date du jour (la date courante) n’est pas toujours aisé.
deux variables peuvent entrer en jeu :

  • la date retournée par la boucle dans laquelle on veut afficher notre date du jour
  • une variable nommée date passée en url ou par le biais d’un formulaire

pour chaque cas, néanmoins, il existe une possibilité d’afficher la date du jour et ce sans que cette date soit tributaire du cache du squelette (ce sera toujours la date courante qui sera affichée)

dans une boucle dont la table possède

un champ date ou date_redac

hors boucle
pas de date ni de date_redac en url

ni passées par formulaire

#ENV{date_redac}

ou

#ENV{date}

#DATE_REDAC

ou

#DATE

variable date passée en url ou par formulaire #ENV{date_redac} #DATE_REDAC
variable date_redac passée en url ou par formulaire #ENV{date} #DATE
variables date et date_redac passées

en url ou par formulaire

définir en début de squelette la date courante avec par exemple :

#SET{cur_date, #VAL{Y-m-d h:i:s}|date}

puis l’utiliser dans le squelette avec :

#GET{cur_date}

JOUONS AVEC LES DATES

<blockquote class="spip">

voir aussi saisie des dates de publication et de rédaction antérieure (spip 2.0.x et 2.1.x)

</blockquote>

-  la date du prochain jeudi qui suit #DATE :

[(#VAL{Y-m-d}|date{#VAL{next Thursday}|strtotime{#DATE|affdate{U}}})]

-  le nom du jour de l’avant-veille de #DATE :

[(#VAL{Y-m-d}|date{#VAL{-2 days}|strtotime{#DATE|affdate{U}}}|nom_jour)]

-  la date de lundi prochain :

[(#SET{lundi_prochain, #VAL{Y-m-d 00:00:00}|date{#VAL{next Monday}|strtotime{#DATE|affdate{U}}}})]
#GET{lundi_prochain}

-  la date du dimanche d’après lundi prochain :

[(#SET{dimanche_apres, #VAL{Y-m-d 23:59:59}|date{#VAL{+6days}|strtotime{#GET{lundi_prochain}|affdate{U}}}})]
#GET{dimanche_apres}

-  afficher le label nouveau ! pour un article publié ou modifié il y a moins de 10 jours :

#SET{periode, -10days}
#TITRE[ (#DATE_MODIF|>{#VAL{Y-m-d H:i:s}|date{#GET{periode}|strtotime}}|oui) nouveau !]

et _fil_ (sur irc) propose encore plus simple :

#TITRE[ (#DATE|strtotime|>{#VAL{-10days}|strtotime}|?{nouveau !, ''})]

EXPORTER AU FORMAT CSV

Triton nous confie un petit exemple qui marche pour MS Excel et openOffice (il y a des particularités d’encodage de caractères) :

#CACHE{0} #HTTP_HEADER{Content-Type: text/csv; charset=windows-1252/Winlatin1} #HTTP_HEADER{Content-Disposition: attachment; filename=inscriptions.csv}
"date"; "nom_participant";"prenom";"paiement effectue"; "tarif_valide"; "promo";"telephone"; "email";"societe"; "nbr_part";"conjoint"; "mobile_dom";"type_paiement"; "souscripteur"
<BOUCLE_les_inscriptions_ouvertes(EVENEMENTS_LESINSCRIPTIONS){id_evenement}{nbr_part>0}>"[(#DATE|affdate{'d-m-Y'})]";"[(#NOM_PARTICIPANT|utf8_decode)]";"[(#PRENOM|utf8_decode)]";"[(#VERIFIER_PAIEMENT_INSCRIPTION{#ID_INSCRIPTION}|utf8_decode)]";"[(#TARIF_VALIDE|utf8_decode)]";"[(#PROMO|utf8_decode)]";"[(#TELEPHONE|utf8_decode)]";"[(#EMAIL|utf8_decode)]";"[(#SOCIETE|utf8_decode)]";"[(#NBR_PART|utf8_decode)]";"[(#CONJOINT|utf8_decode)]";"[(#MOBILE_DOM|utf8_decode)]";"[(#TYPE_PAIEMENT|utf8_decode)]";"[(#SOUSCRIPTEUR|utf8_decode)]"
</BOUCLE_les_inscriptions_ouvertes>
  • le http_header indique qu’il s’agit d’un document csv encodé pour MS excel
  • la premiere ligne c’est les têtières (en tete de colonne) du fichier csv
  • La boucle écrit ensuite le contenu ligne par ligne

Il faut, souvent, coller toutes les lignes comme ci-dessus, sinon, on peut, ou pas, se retrouver avec des lignes vides dans le csv....

Si tu colles ca dans un squelette (nommé squelette_cvs), il suffit
ensuite d’appeler la page spip.php ?page=squelette_cvs et le navigateur
te proposera de sauvegarder le fichier (ici inscriptions.csv - voir le
filename au dessus) ou de l ouvrir avec le logiciel de ton choix....

Apres, faut voir a quoi doit servir ton cvs, a etre lu directement par
une appli type MS/ Open Office (cet exemple) ou a autre chose, import
dans une base sql par exemple, auquel cas, il faudra peut-être modifier l’encodage de caractères...

Par ailleurs, paube indique qu’il faut d’abord passer les champs par le filtre textebrut avant de les passer à la moulinette de utf8_decode

on peut aussi « jolifier » et simplifier le code (surtout dans la boucle) :

#CACHE{0}
#HTTP_HEADER{Content-Type: text/csv; charset=windows-1252/Winlatin1}
#HTTP_HEADER{Content-Disposition: attachment; filename=inscriptions.csv}

"ordre"; "date"; "nom_participant"; "prenom"; "paiement effectue"; "tarif_valide"; "promo"; "telephone"; "email"; "societe"; "nbr_part"; "conjoint"; "mobile_dom"; "type_paiement"; "souscripteur"

<BOUCLE_inscriptions_ouvertes(EVENEMENTS_LESINSCRIPTIONS){id_evenement}{nbr_part>0}>#VAL{#COMPTEUR_BOUCLE;"[(#DATE|affdate{'d-m-Y'})]"; "#NOM_PARTICIPANT"; "#PRENOM"; "#VERIFIER_PAIEMENT_INSCRIPTION{#ID_INSCRIPTION}"; "#TARIF_VALIDE"; "#PROMO"; "#TELEPHONE"; "#EMAIL"; "#SOCIETE"; "#NBR_PART"; "#CONJOINT"; "#MOBILE_DOM"; "#TYPE_PAIEMENT"; "#SOUSCRIPTEUR"}|textebrut|utf8_decode)]
</BOUCLE_inscriptions_ouvertes>

l’astuce consiste à ajouter #COMPTEUR_BOUCLE; comme premier champ de #VAL (donc aussi "ordre"; en première ligne de la feuille)


extraire les adresses email contenues dans un(des) texte(s)

  1. /**
  2.  * Le filtre extraire_email permet de récuperer toutes les adresses email
  3.  * présentes dans le texte retourné par la balise sur laquelle il s'applique.
  4.  *
  5.  * @param string $texte
  6.  *              l'affichage retourné par la balise
  7.  *             
  8.  * @return array
  9.  *              un tableau dédoublonné des adresses email
  10. **/
  11. function extraire_email($texte) {
  12.         //  /toto@truc.net étant une adresse valide ne pas confondre
  13.         //  avec toto@truc.net dans href="mailto://toto@truc.net"
  14.         $texte = preg_replace(',mailto://,', '', $texte);
  15.  
  16.         //  contrôle : voir http://tools.ietf.org/html/rfc3696#page-6
  17.         if (preg_match_all(";[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?;ims", $texte, $matches))
  18.                 return array_unique($matches[0]);
  19.         return array();
  20. }

Télécharger

exemple d’utilisation dans un squelette :

  1. #SET{res, #ARRAY}
  2. <BOUCLE_art(ARTICLES) {tout}>
  3. [(#SET{res, #GET{res}|array_merge{#TEXTE|extraire_email}})]
  4. </BOUCLE_art>
  5.  
  6. [(#GET{res}|foreach)]

Télécharger


Une fonction pour joliment afficher les variables de #ENV, #GET ou #SESSION

copiée sur la fonction du débugueur debusquer_contexte() (de ecrire/public/debusquer.php), cette fonction est à déposer dans le fichier mes_options.php

  1. /**
  2.  * Une fonction récursive pour joliment afficher #ENV, #GET, #SESSION...
  3.  *              en squelette : [(#ENV|bel_env)], [(#GET|bel_env)], [(#SESSION|bel_env)]
  4.  *              ou encore [(#ARRAY{0,1, a,#SESSION, 1,#ARRAY{x,y}}|bel_env)]
  5.  *
  6.  * @param string|array $env
  7.  *              si une string est passée elle doit être le serialize d'un array
  8.  *
  9.  * @return string
  10.  *              une chaîne html affichant une <table>
  11. **/
  12. function bel_env($env) {
  13.         $env = str_replace(array('&quot;', '&#039;'), array('"', '\''), $env);
  14.         if (is_array($env_tab = @unserialize($env))) {
  15.                 $env = $env_tab;
  16.         }
  17.         if (!is_array($env)) {
  18.                 return '';
  19.         }
  20.         $style = " style='border:1px solid #ddd;'";
  21.         $res = "<table style='border-collapse:collapse;'>\n";
  22.         foreach ($env as $nom => $val) {
  23.                 if (is_array($val) || is_array(@unserialize($val))) {
  24.                         $val = bel_env($val);
  25.                 }
  26.                 else {
  27.                         $val = entites_html($val);
  28.                 }
  29.                 $res .= "<tr>\n<td$style><strong>". entites_html($nom).
  30.                                 "&nbsp;:&nbsp;</strong></td><td$style>" .$val. "</td>\n</tr>\n";
  31.         }
  32.         $res .= "</table>";
  33.         return $res;
  34. }

Télécharger

ne reste plus qu’à l’appeler (que l’on soit loggé ou pas) dans un squelette avec :

  1. [(#ENV|bel_env)]

ou encore :

  1. [(#GET|bel_env)]

ou encore :

  1. [(#SESSION|bel_env)]

Connaître le niveau de profondeur d’une rubrique

-  Avec SPIP3 c’est même pas drôle :

  • #PROFONDEUR dans une boucle (RUBRIQUES)
  • #INFO_x{objet, id_objet} en dehors d’une boucle

-  Avec SPIP2.1 deux solutions :

    1. <BOUCLE_niveau(HIERARCHIE) {id_rubrique} {tout}>
    2. </BOUCLE_niveau>
    3.       #SET{niveau,#TOTAL_BOUCLE}
    4. <//B_niveau>
    5. et on récupère l'info avec un #GET{niveau}

    Télécharger

  • une fonction à poser dans squelettes/mes_fonctions.php :
    1. function filtre_profondeur_dist($id_rubrique) {
    2.     $id_rubrique = intval($id_rubrique);
    3.     // sauver les calculs déjà faits
    4.     static $profs = array();
    5.     if (isset($profs[$id_rubrique])) {
    6.       return $profs[$id_rubrique];
    7.     }
    8.     // récupérer le parent.
    9.     $id_parent = sql_getfetsel('id_parent', 'spip_rubriques', 'id_rubrique='.$id_rubrique);
    10.     // pas de parent : id_rubrique n'existe pas
    11.     if (is_null($id_parent)) {
    12.       return '';
    13.     }
    14.     // parent zéro : on est tout en haut (racine)
    15.     if ($id_parent == '0') {
    16.       return $profs[$id_rubrique] = 1;
    17.     }
    18.     // sinon, on trouve la profondeur du parent
    19.     $parent = filtre_profondeur_dist($id_parent);
    20.     $profs[$id_rubrique] = ($parent + 1);
    21.     return $profs[$id_rubrique];
    22. }

    Télécharger

                appelée dans un squelette avec : [(#ID_RUBRIQUE|profondeur)]


Retour à la version courante

Toutes les versions