[SPIP][PLUGINS] v3.0-->v3.2

[lhc/web/www.git] / www / plugins-dist / petitions / petitions_fonctions.php

diff --git a/www/plugins-dist/petitions/petitions_fonctions.php b/www/plugins-dist/petitions/petitions_fonctions.php
index a81af29..ced0ce7 100644 (file)
--- a/www/plugins-dist/petitions/petitions_fonctions.php
+++ b/www/plugins-dist/petitions/petitions_fonctions.php
@@ -10,54 +10,65 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 /**
- * #PETITION
- * retourne '' si l'article courant n'a pas de petition
- * le texte de celle-ci sinon (et ' ' si il est vide)
- * cf FORMULAIRE_PETITION
+ * Compile la balise `#PETITION` permettant d'afficher, s'il existe,
+ * le texte de pétition associé à l'article.
+ *
+ * Retourne :
+ *
+ * - `''` si l'article courant n'a pas de pétition
+ * - le texte de celle-ci sinon (et `' '` si il est vide)
  *
- * https://code.spip.net/@balise_PETITION_dist
+ * @see balise_FORMULAIRE_SIGNATURE()
+ * @link https://www.spip.net/3967
  *
- * @param $p
- * @return
+ * @param Champ $p
+ *    Pile au niveau de la balise
+ * @return Champ
+ *    Pile complétée du code à générer
  */
-function balise_PETITION_dist ($p) {
+function balise_PETITION_dist($p) {
        $nom = $p->id_boucle;
        $p->code = "quete_petitions(" .
-                       champ_sql('id_article', $p) .
-                       ",'" .
-                       $p->boucles[$nom]->type_requete .
-                       "','" .
-                       $nom .
-                       "','" .
-                       $p->boucles[$nom]->sql_serveur .
-                       "', \$Cache)";
+               champ_sql('id_article', $p) .
+               ",'" .
+               $p->boucles[$nom]->type_requete .
+               "','" .
+               $nom .
+               "','" .
+               $p->boucles[$nom]->sql_serveur .
+               "', \$Cache)";
        $p->interdire_scripts = false;
+
        return $p;
 }
 
-if(!function_exists('quete_petitions')) {
-/**
- * retourne le champ 'texte' d'une petition
- *
- * @param int $id_article
- * @param string $table
- * @param string $id_boucle
- * @param string $serveur
- * @param array $cache
- * @return array|bool|null|string
- */
-function quete_petitions($id_article, $table, $id_boucle, $serveur, &$cache) {
-       $retour = sql_getfetsel('texte', 'spip_petitions',("id_article=".intval($id_article)),'',array(),'','', $serveur);
+if (!function_exists('quete_petitions')) {
+       /**
+        * retourne le champ 'texte' d'une petition
+        *
+        * @param int $id_article
+        * @param string $table
+        * @param string $id_boucle
+        * @param string $serveur
+        * @param array $cache
+        * @return array|bool|null|string
+        */
+       function quete_petitions($id_article, $table, $id_boucle, $serveur, &$cache) {
+               $retour = sql_getfetsel('texte', 'spip_petitions', ("id_article=" . intval($id_article)), '', array(), '', '',
+                       $serveur);
 
-       if ($retour === NULL) return '';
-       # cette page est invalidee par toute petition
-       $cache['varia']['pet'.$id_article] = 1;
-       # ne pas retourner '' car le texte sert aussi de presence
-       return $retour ? $retour : ' ';
-}
-}
+               if ($retour === null) {
+                       return '';
+               }
+               # cette page est invalidee par toute petition
+               $cache['varia']['pet' . $id_article] = 1;
 
-?>
\ No newline at end of file
+               # ne pas retourner '' car le texte sert aussi de presence
+               return $retour ? $retour : ' ';
+       }
+}