From b79ae2177bab047652ef7432868e31616d252e1b Mon Sep 17 00:00:00 2001
From: Matthieu Marcillaud <marcimat@rezo.net>
Date: Wed, 12 Jul 2017 07:29:19 +0000
Subject: [PATCH] PHPDoc de la fonction pipeline()

---
 ecrire/inc/utils.php | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/ecrire/inc/utils.php b/ecrire/inc/utils.php
index 8a0387626d..ad4f5fabfd 100644
--- a/ecrire/inc/utils.php
+++ b/ecrire/inc/utils.php
@@ -212,8 +212,33 @@ function minipipe($fonc, &$val) {
 	return $val;
 }
 
-// chargement du pipeline sous la forme d'un fichier php prepare
-// http://code.spip.net/@pipeline
+/**
+ * Appel d’un pipeline
+ *
+ * Exécute le pipeline souhaité, éventuellement avec des données initiales.
+ * Chaque plugin qui a demandé à voir ce pipeline vera sa fonction spécifique appelée.
+ * Les fonctions (des plugins) appelées peuvent modifier à leur guise le contenu.
+ *
+ * Deux types de retours. Si `$val` est un tableau de 2 éléments, avec une clé `data`
+ * on retourne uniquement ce contenu (`$val['data']`) sinon on retourne tout `$val`.
+ *
+ *
+ * @example
+ *     Appel du pipeline `pre_insertion`
+ *     ```
+ *     $champs = pipeline('pre_insertion', array(
+ *         'args' => array('table' => 'spip_articles'),
+ *         'data' => $champs
+ *     ));
+ *     ```
+ *
+ * @param string $action
+ *     Nom du pipeline
+ * @param null|string|array $val
+ *     Données à l’entrée du pipeline
+ * @return mixed|null
+ *     Résultat
+ */
 function pipeline($action, $val = null) {
 	static $charger;
 
-- 
GitLab