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

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

diff --git a/www/ecrire/inc/precharger_article.php b/www/ecrire/inc/precharger_article.php
index 9169b7a..6efec9d 100644 (file)
--- a/www/ecrire/inc/precharger_article.php
+++ b/www/ecrire/inc/precharger_article.php
@@ -3,38 +3,62 @@
 /***************************************************************************\
  *  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;
+/**
+ * Préchargement les formulaires d'édition d'article, notament pour les traductions
+ *
+ * @package SPIP\Core\Objets
+ **/
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 include_spip('inc/precharger_objet');
 
 
-// Recupere les donnees d'un article pour composer un formulaire d'edition
-// id_article = numero d'article existant
-// id_rubrique = ou veut-on l'installer (pas obligatoire)
-// lier_trad = l'associer a l'article numero $lier_trad
-// new=oui = article a creer si on valide le formulaire
-// http://doc.spip.org/@inc_article_select_dist
-function inc_precharger_article_dist($id_article, $id_rubrique=0, $lier_trad=0) {
+/**
+ * Retourne les valeurs à charger pour un formulaire d'édition d'un article
+ *
+ * Lors d'une création, certains champs peuvent être préremplis
+ * (c'est le cas des traductions)
+ *
+ * @param string|int $id_article
+ *     Identifiant de l'article, ou "new" pour une création
+ * @param int $id_rubrique
+ *     Identifiant éventuel de la rubrique parente
+ * @param int $lier_trad
+ *     Identifiant éventuel de la traduction de référence
+ * @return array
+ *     Couples clés / valeurs des champs du formulaire à charger.
+ **/
+function inc_precharger_article_dist($id_article, $id_rubrique = 0, $lier_trad = 0) {
        return precharger_objet('article', $id_article, $id_rubrique, $lier_trad, 'titre');
 }
 
 
-//
-// Si un article est demande en creation (new=oui) avec un lien de trad,
-// on initialise les donnees de maniere specifique
-//
-// (fonction facultative si pas de changement dans les traitements)
-function inc_precharger_traduction_article_dist($id_article, $id_rubrique=0, $lier_trad=0) {
+/**
+ * Récupère les valeurs d'une traduction de référence pour la création
+ * d'un article (préremplissage du formulaire).
+ *
+ * @note
+ *     Fonction facultative si pas de changement dans les traitements
+ *
+ * @param string|int $id_article
+ *     Identifiant de l'article, ou "new" pour une création
+ * @param int $id_rubrique
+ *     Identifiant éventuel de la rubrique parente
+ * @param int $lier_trad
+ *     Identifiant éventuel de la traduction de référence
+ * @return array
+ *     Couples clés / valeurs des champs du formulaire à charger
+ **/
+function inc_precharger_traduction_article_dist($id_article, $id_rubrique = 0, $lier_trad = 0) {
        return precharger_traduction_objet('article', $id_article, $id_rubrique, $lier_trad, 'titre');
 }
-
-
-
-?>