[PLUGINS] +maj gis4

[lhc/web/www.git] / www / plugins / saisies / balise / voir_saisies.php

diff --git a/www/plugins/saisies/balise/voir_saisies.php b/www/plugins/saisies/balise/voir_saisies.php
index 609742d..482c418 100644 (file)
--- a/www/plugins/saisies/balise/voir_saisies.php
+++ b/www/plugins/saisies/balise/voir_saisies.php
@@ -1,30 +1,55 @@
 <?php 
+/**
+ * Déclaration de la balise `#VOIR_SAISIES`
+ *
+ * @package SPIP\Saisies\Balises
+**/
 
 // Sécurité
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
+/**
+ * Compile la balise `#VOIR_SAISIES` qui retourne le code HTML des vues de formulaire,
+ * à partir du tableau des saisies transmises
+ *
+ * La balise accepte 1 paramètre qui est une liste de descriptions de saisies
+ * dont on veut générer le HTML affichant les vues du formulaires
+ *
+ * Cette balise est un raccourcis :
+ * - `#VOIR_SAISIES{#TABLEAU_DE_SAISIES}` est équivalent à
+ * - `#INCLURE{fond=inclure/voir_saisies,env,saisies=#TABLEAU_DE_SAISIES}`
+ * 
+ * @syntaxe `#VOIR_SAISIE{#TABLEAU_DE_SAISIES}`
+ * @uses Pile::recuperer_et_supprimer_argument_balise()
+ * @uses Pile::creer_et_ajouter_argument_balise()
+ * @see balise_INCLURE_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complété du code à générer
+**/
 function balise_VOIR_SAISIES_dist($p){
 
        // On recupere les arguments : les tableaux decrivant ce qu'on veut generer + les reponses
        $saisies = Pile::recuperer_et_supprimer_argument_balise(1, $p);
        $valeurs = Pile::recuperer_et_supprimer_argument_balise(1, $p);
-       
+
        // On ajoute le squelette a inclure dans les parametres
        $p = Pile::creer_et_ajouter_argument_balise($p, 'fond', 'inclure/voir_saisies');
-       
+
        // On ajoute l'environnement
        $p = Pile::creer_et_ajouter_argument_balise($p, 'env');
-       
+
        // On ajoute les tableaux recuperes
        $p = Pile::creer_et_ajouter_argument_balise($p, 'saisies', $saisies);
        $p = Pile::creer_et_ajouter_argument_balise($p, 'valeurs', $valeurs);
-       
+
        // On redirige vers la balise INCLURE
-       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);
+       }
 
 }
-
-?>