[PLUGINS] +maj gis4
[lhc/web/www.git] / www / plugins / saisies / balise / voir_saisie.php
index 3498901..8ed9f94 100644 (file)
@@ -1,21 +1,34 @@
 <?php
 
+/**
+ * Déclaration de la balise `#VOIR_SAISIE`
+ *
+ * @package SPIP\Saisies\Balises
+**/
+
+
 // Sécurité
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
-/* 
- * #VOIR_SAISIE{type,nom} : champs obligatoires
+/**
+ * Compile la balise `#VOIR_SAISIE` qui retourne le code HTML de la vue d'une saisie indiquée
+ *
+ * Cette balise incluera le squelette `saisies-vues/_base.html` et lui-même `saisies-vues/{type}.html`
  * 
- * collecte des arguments en fonctions du parametre "nom"
- * ajoute des arguments
- * appelle #INCLURE avec les arguments collectes en plus
+ * @syntaxe `#VOIR_SAISIE{type,nom[,option=valeur,...]}`
+ * @uses Pile::recuperer_et_supprimer_argument_balise()
+ * @uses Pile::creer_et_ajouter_argument_balise()
+ * @uses Pile::creer_balise()
+ * @see balise_INCLURE_dist()
  * 
+ * @param Champ $p
+ * @return Champ
  */
 function balise_VOIR_SAISIE_dist ($p) {
 
        // on recupere les parametres sans les traduire en code d'execution php
        $type_saisie = Pile::recuperer_et_supprimer_argument_balise(1, $p);
-       $nom       = Pile::recuperer_et_supprimer_argument_balise(1, $p);
+       $nom         = Pile::recuperer_et_supprimer_argument_balise(1, $p);
 
        // creer #ENV*{$titre} (* pour les cas de tableau serialises par exemple, que l'on veut reutiliser)
        $env_nom   = Pile::creer_balise('ENV', array('param' => array($nom), 'etoile' => '*')); // #ENV*{nom}
@@ -29,11 +42,10 @@ function balise_VOIR_SAISIE_dist ($p) {
 
        // on appelle la balise #INCLURE
        // avec les arguments ajoutes
-       if(function_exists('balise_INCLURE'))
+       if(function_exists('balise_INCLURE')) {
                return balise_INCLURE($p);
-       else
-               return balise_INCLURE_dist($p); 
-               
-}
+       } else {
+               return balise_INCLURE_dist($p);
+       }
 
-?>
+}