www/plugins/saisies/balise/saisie.php

   1 <?php
   2
   3 /**
   4  * Déclaration de la classe `Pile` et de la balise `#SAISIE`
   5  *
   6  * @package SPIP\Saisies\Balises
   7 **/
   8
   9 if (!defined('_ECRIRE_INC_VERSION')) {
  10         return;
  11 }
  12
  13 // pour ne pas interferer avec d'eventuelles futures fonctions du core
  14 // on met le tout dans une classe ; les fonctions sont autonomes.
  15
  16 /**
  17  * Conteneur pour modifier les arguments d'une balise SPIP (de classe Champ) à compiler
  18  *
  19  * @note
  20  *     Ces fonctions visent à modifier l'AST (Arbre de Syntaxe Abstraite) issues
  21  *     de l'analyse du squelette. Très utile pour créer des balises qui
  22  *     transmettent des arguments supplémentaires automatiquement, à des balises
  23  *     déjà existantes.
  24  *     Voir un exemple d'utilisation dans `balise_SAISIE_dist()`.
  25  *
  26  * @note
  27  *     Les arguments sont stockés sont dans l'entree 0 de la propriété `param`
  28  *     dans l'objet Champ (représenté par `$p`), donc dans `$p->param[0]`.
  29  *
  30  *     `param[0][0]` vaut toujours '' (ou presque ?)
  31  *
  32  * @see balise_SAISIE_dist() Pour un exemple d'utilisation
  33 **/
  34 class Pile {
  35
  36
  37         /**
  38          * Récupère un argument de balise
  39          *
  40          * @param int $pos
  41          * @param Champ $p
  42          * @return mixed|null Élément de l'AST représentant l'argument s'il existe
  43         **/
  44         static function recuperer_argument_balise($pos, $p) {
  45                 if (!isset($p->param[0])) {
  46                         return null;
  47                 }
  48                 if (!isset($p->param[0][$pos])) {
  49                         return null;
  50                 }
  51                 return $p->param[0][$pos];
  52         }
  53
  54         /**
  55          * Supprime un argument de balise
  56          *
  57          * @param int $pos
  58          * @param Champ $p
  59          * @return Champ
  60         **/
  61         static function supprimer_argument_balise($pos, $p) {
  62                 if (!isset($p->param[0])) {
  63                         return null;
  64                 }
  65                 if (!isset($p->param[0][$pos])) {
  66                         return null;
  67                 }
  68                 if ($pos == 0) {
  69                         array_shift($p->param[0]);
  70                 } else {
  71                         $debut = array_slice($p->param[0], 0, $pos);
  72                         $fin   = array_slice($p->param[0], $pos+1);
  73                         $p->param[0] = array_merge($debut, $fin);
  74                 }
  75                 return $p;
  76         }
  77
  78
  79         /**
  80          * Retourne un argument de balise, et le supprime de la liste des arguments
  81          *
  82          * @uses Pile::recuperer_argument_balise()
  83          * @uses Pile::supprimer_argument_balise()
  84          *
  85          * @param int $pos
  86          * @param Champ $p
  87          * @return mixed|null Élément de l'AST représentant l'argument s'il existe
  88         **/
  89         static function recuperer_et_supprimer_argument_balise($pos, &$p) {
  90                 $arg = Pile::recuperer_argument_balise($pos, $p);
  91                 $p   = Pile::supprimer_argument_balise($pos, $p);
  92                 return $arg;
  93         }
  94
  95
  96         /**
  97          * Ajoute un argument de balise
  98          *
  99          * Empile l'argument à la suite des arguments déjà existants pour la balise
 100          *
 101          * @param mixed $element Élément de l'AST représentant l'argument à ajouter
 102          * @param Champ $p
 103          * @return Champ
 104         **/
 105         static function ajouter_argument_balise($element, $p) {
 106                 if (isset($p->param[0][0])) {
 107                         $zero = array_shift($p->param[0]);
 108                         array_unshift($p->param[0], $element);
 109                         array_unshift($p->param[0], $zero);
 110                 } else {
 111                         if (!is_array($p->param[0])) {
 112                                 $p->param[0] = array();
 113                         }
 114                         array_unshift($p->param[0], $element);
 115                 }
 116                 return $p;
 117         }
 118
 119
 120         /**
 121          * Crée l'élément de l'AST représentant un argument de balise.
 122          *
 123          * @example
 124          *     ```
 125          *     $nom = Pile::creer_argument_balise(nom);           // {nom}
 126          *     $nom = Pile::creer_argument_balise(nom, 'coucou'); // {nom=coucou}
 127          *
 128          *     $balise = Pile::creer_balise('BALISE');
 129          *     $nom = Pile::creer_argument_balise(nom, $balise);  // {nom=#BALISE}
 130          *     ```
 131          *
 132          * @param string $nom
 133          *     Nom de l'argument
 134          * @param string|object $valeur
 135          *     Valeur de l'argument. Peut être une chaîne de caractère ou un autre élément d'AST
 136          * @return array
 137         **/
 138         static function creer_argument_balise($nom, $valeur = null) {
 139                 include_spip('public/interfaces');
 140                 $s = new Texte;
 141                 $s->texte = $nom;
 142                 $s->ligne=0;
 143
 144                 // si #BALISE cree avec Pile::creer_balise(), le mettre en array, comme les autres
 145                 if (is_object($valeur)) {
 146                         $valeur = array($valeur);
 147                 }
 148
 149                 $res = null;
 150
 151                 // {nom}
 152                 if (is_null($valeur)) {
 153                         $res = array($s);
 154                 } elseif (is_string($valeur)) {
 155                         // {nom=coucou}
 156                         $s->texte .= "=$valeur";
 157                         $res = array($s);
 158                 } elseif (is_array($valeur)) {
 159                         // {nom=#BALISE}
 160                         $s->texte .= '='; // /!\ sans cette toute petite chose, ça ne fait pas d'egalite :)
 161                         $res = array_merge(array($s), $valeur);
 162                 }
 163
 164                 return $res;
 165         }
 166
 167
 168         /**
 169          * Crée et ajoute un argument à une balise
 170          *
 171          * @uses Pile::creer_argument_balise()
 172          * @uses Pile::ajouter_argument_balise()
 173          *
 174          * @param Champ $p
 175          * @param string $nom
 176          *     Nom de l'argument
 177          * @param string|object $valeur
 178          *     Valeur de l'argument. Peut être une chaîne de caractère ou un autre élément d'AST
 179          * @return Champ
 180         **/
 181         static function creer_et_ajouter_argument_balise($p, $nom, $valeur = null) {
 182                 $new = Pile::creer_argument_balise($nom, $valeur);
 183                 return Pile::ajouter_argument_balise($new, $p);
 184         }
 185
 186
 187
 188         /**
 189          * Crée l'AST d'une balise
 190          *
 191          * @example
 192          *     ```
 193          *     // Crée : #ENV*{titre}
 194          *     $titre = Pile::recuperer_argument_balise(1, $p); // $titre, 1er argument de la balise actuelle
 195          *     $env = Pile::creer_balise('ENV', array('param' => array($titre), 'etoile' => '*'));
 196          *     ```
 197          *
 198          * @param string $nom
 199          *     Nom de la balise
 200          * @param array $opt
 201          *     Options (remplira les propriétés correspondantes de l'objet Champ)
 202          * @return Champ
 203         **/
 204         static function creer_balise($nom, $opt = array()) {
 205                 include_spip('public/interfaces');
 206                 $b = new Champ;
 207                 $b->nom_champ = strtoupper($nom);
 208                 foreach ($opt as $o => $val) {
 209                         if (property_exists($b, $o)) {
 210                                 if ($o == 'param') {
 211                                         array_unshift($val, '');
 212                                         $b->$o = array($val);
 213                                 } else {
 214                                         $b->$o = $val;
 215                                 }
 216                         }
 217                 }
 218                 return $b;
 219         }
 220 }
 221
 222
 223
 224 /**
 225  * Compile la balise `#SAISIE` qui retourne le code HTML de la saisie de formulaire indiquée.
 226  *
 227  * Cette balise incluera le squelette `saisies/_base.html` et lui-même `saisies/{type}.html`
 228  *
 229  * La balise `#SAISIE` est un raccourci pour une écriture plus compliquée de la balise `#INCLURE`.
 230  * La balise calcule une série de paramètre récupérer et à transmettre à `#INCLURE`,
 231  * en fonction des valeurs des 2 premiers paramètres transmis.
 232  *
 233  * Les autres arguments sont transmis tels quels à la balise `#INCLURE`.
 234  *
 235  * Ainsi `#SAISIE{input,nom,label=Nom,...}` exécutera l'équivalent de
 236  * `#INCLURE{nom=nom,valeur=#ENV{nom},type_saisie=input,erreurs,fond=saisies/_base,label=Nom,...}`
 237  *
 238  * @syntaxe `#SAISIE{type,nom[,option=xx,...]}`
 239  *
 240  * @uses Pile::recuperer_et_supprimer_argument_balise()
 241  * @uses Pile::creer_balise()
 242  * @uses Pile::creer_et_ajouter_argument_balise()
 243  * @see balise_INCLURE_dist()
 244  *
 245  * @param Champ $p
 246  * @return Champ
 247  */
 248 function balise_SAISIE_dist($p) {
 249
 250         // on recupere les parametres sans les traduire en code d'execution php
 251         $type_saisie = Pile::recuperer_et_supprimer_argument_balise(1, $p); // $type
 252         $titre       = Pile::recuperer_et_supprimer_argument_balise(1, $p); // $titre
 253
 254         // creer #ENV*{$titre} (* pour les cas de tableau serialises par exemple, que l'on veut reutiliser)
 255         $env_titre   = Pile::creer_balise('ENV', array('param' => array($titre), 'etoile' => '*')); // #ENV*{titre}
 256
 257         // on modifie $p pour ajouter des arguments
 258         // {nom=$titre, valeur=#ENV{$titre}, erreurs, type_saisie=$type, fond=saisies/_base}
 259         $p = Pile::creer_et_ajouter_argument_balise($p, 'nom', $titre);
 260         $p = Pile::creer_et_ajouter_argument_balise($p, 'valeur', $env_titre);
 261         $p = Pile::creer_et_ajouter_argument_balise($p, 'type_saisie', $type_saisie);
 262         $p = Pile::creer_et_ajouter_argument_balise($p, 'erreurs');
 263         $p = Pile::creer_et_ajouter_argument_balise($p, 'fond', 'saisies/_base');
 264
 265         // on appelle la balise #INCLURE
 266         // avec les arguments ajoutes
 267         if (function_exists('balise_INCLURE')) {
 268                 return balise_INCLURE($p);
 269         } else {
 270                 return balise_INCLURE_dist($p);
 271         }
 272 }