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

[lhc/web/www.git] / www / ecrire / balise / info_.php

diff --git a/www/ecrire/balise/info_.php b/www/ecrire/balise/info_.php
index 23c021e..83d7982 100644 (file)
--- a/www/ecrire/balise/info_.php
+++ b/www/ecrire/balise/info_.php
@@ -3,38 +3,58 @@
 /***************************************************************************\
  *  SPIP, Systeme de publication pour l'internet                           *
  *                                                                         *
- *  Copyright (c) 2001-2016                                                *
+ *  Copyright (c) 2001-2017                                                *
  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
  *                                                                         *
  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Fonctions génériques pour les balises `#INFO_XXXX`
+ *
+ * @package SPIP\Core\Compilateur\Balises
+ **/
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 /**
- * Generer n'importe quel info pour un objet : #INFO_TITRE{article, #ENV{id_article}}
- * Utilise la fonction generer_info_entite() de inc/filtres
- * se reporter a sa documentation
- * 
+ * Compile la balise dynamique `#INFO_xx` qui génère n'importe quelle
+ * information pour un objet
+ *
+ * Signature : `#INFO_n{objet,id_objet}` où n est une colonne sur la table
+ * SQL de l'objet.
+ *
+ * @balise
+ * @link http://www.spip.net/5544
+ * @uses generer_info_entite()
+ * @example
+ *     ```
+ *     #INFO_TITRE{article, #ENV{id_article}}
+ *     ```
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
  */
-function balise_INFO__dist($p){
+function balise_INFO__dist($p) {
        $info = $p->nom_champ;
-       $type_objet = interprete_argument_balise(1,$p);
-       $id_objet = interprete_argument_balise(2,$p);
+       $type_objet = interprete_argument_balise(1, $p);
+       $id_objet = interprete_argument_balise(2, $p);
        if ($info === 'INFO_' or !$type_objet or !$id_objet) {
                $msg = _T('zbug_balise_sans_argument', array('balise' => ' INFO_'));
                erreur_squelette($msg, $p);
                $p->interdire_scripts = true;
+
                return $p;
-       }
-       else {
-               $info_sql = strtolower(substr($info,5));
-               $code = "generer_info_entite($id_objet, $type_objet, '$info_sql'".($p->etoile?","._q($p->etoile):"").")";
+       } else {
+               $info_sql = strtolower(substr($info, 5));
+               $code = "generer_info_entite($id_objet, $type_objet, '$info_sql'" . ($p->etoile ? "," . _q($p->etoile) : "") . ")";
                $p->code = champ_sql($info, $p, $code);
                $p->interdire_scripts = true;
+
                return $p;
        }
 }
-
-?>