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

[lhc/web/www.git] / www / ecrire / inc / lister_objets.php

diff --git a/www/ecrire/inc/lister_objets.php b/www/ecrire/inc/lister_objets.php
index 2eec519..678e967 100644 (file)
--- a/www/ecrire/inc/lister_objets.php
+++ b/www/ecrire/inc/lister_objets.php
@@ -3,51 +3,65 @@
 /***************************************************************************\
  *  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;
+/**
+ * Gestion de listes d'objets
+ *
+ * @package SPIP\Core\Listes
+ **/
 
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 
 /**
- * affichage des liste d'objets
- * surcharge pour aiguiller vers la mise en skel
+ * Affichage des liste d'objets
+ *
+ * Surcharge pour aiguiller vers la mise en squelettes des listes
+ *
+ * @deprecated Créer ou utiliser un squelette dans `prive/objets/liste/`
+ *   pour la table en question et l'appeler avec une inclusion.
  *
  * @param string $vue
- * @param string $titre
- * @param array $requete
- * @param string $formater
+ *     Nom de l'objet
+ * @param array $contexte
+ *     Contexte du squelette
  * @param bool $force
+ *     Si `true` le titre est affiché même s'il n'y a aucun élément dans la liste.
  * @return string
+ *     Code HTML de la liste
  */
-function inc_lister_objets_dist($vue, $contexte=array(), $force=false){
+function inc_lister_objets_dist($vue, $contexte = array(), $force = false) {
        $res = ""; // debug
-       if (!is_array($contexte))
+       if (!is_array($contexte)) {
                return _L('$contexte doit etre un tableau dans inc/lister_objets');
+       }
 
        $fond = "prive/objets/liste/$vue";
-       if (!find_in_path($fond."."._EXTENSION_SQUELETTES)) {
+       if (!find_in_path($fond . "." . _EXTENSION_SQUELETTES)) {
                // traiter les cas particuliers
                include_spip('base/connect_sql');
                $vue = table_objet($vue);
                $fond = "prive/objets/liste/$vue";
-               if (!find_in_path($fond."."._EXTENSION_SQUELETTES))
+               if (!find_in_path($fond . "." . _EXTENSION_SQUELETTES)) {
                        return _L("vue $vue introuvable pour lister les objets");
+               }
        }
-               
-       
-       $contexte['sinon']=($force ? $contexte['titre']:'');
 
-       $res = recuperer_fond($fond,$contexte,array('ajax'=>true));
-       if (_request('var_liste'))
+
+       $contexte['sinon'] = ($force ? $contexte['titre'] : '');
+
+       $res = recuperer_fond($fond, $contexte, array('ajax' => true));
+       if (_request('var_liste')) {
                echo var_export($contexte, true);
-               
+       }
+
        return $res;
 }
-
-?>