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

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

diff --git a/www/ecrire/inc/iconifier.php b/www/ecrire/inc/iconifier.php
index 618d2b7..0fe4da6 100644 (file)
--- a/www/ecrire/inc/iconifier.php
+++ b/www/ecrire/inc/iconifier.php
@@ -3,23 +3,42 @@
 /***************************************************************************\
  *  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 du formulaire iconifier pour ajouter des logos
+ *
+ * @package SPIP\Core\Logos
+ */
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 include_spip('inc/actions');
 
-// http://doc.spip.org/@inc_iconifier_dist
-function inc_iconifier_dist($objet, $id,  $script, $visible=false, $flag_modif=true) {
+/**
+ * Retourne le formulaire de gestion de logo sur les objets.
+ *
+ * @param string $objet
+ * @param integer $id
+ * @param string $script
+ * @param bool $visible
+ * @param bool $flag_modif
+ *
+ * @return string|array
+ *     - Contenu du squelette calculé
+ *     - ou tableau d'information sur le squelette.
+ */
+function inc_iconifier_dist($objet, $id, $script, $visible = false, $flag_modif = true) {
        // compat avec anciens appels
        $objet = objet_type($objet);
-       
-       return recuperer_fond('prive/objets/editer/logo',array('objet'=>$objet,'id_objet'=>$id,'editable'=>$flag_modif));
-}
 
-?>
+       return recuperer_fond('prive/objets/editer/logo',
+               array('objet' => $objet, 'id_objet' => $id, 'editable' => $flag_modif));
+}