Ticket #170 - début de doc pour deux pipelines

MediaSPIP propose deux pipelines :

• ms_config pour modifier une valeur de configuration
• ms_ajout_html pour ajouter du HTML dans un squelette.

Pipeline ms_config

Le pipeline ms_config est utilisé, par exemple, dans le formulaire de sélection des champs à cacher dans la page d’un média :

Le pipeline fait donc transiter un tableau avec deux éléments :

• cle : le nom de la variable de configuration
• valeur : la valeur de la variable (dans l’exemple ci-dessus, un tableau de champs à cacher)

Dans un plugin imaginaire "fax", qui utiliserait MediaSPIP, et qui ajouterait un champ fax à la table des articles, on peut utiliser le pipeline ms_config pour ajouter ce nouveau champ fax à la liste de champs à cacher :

• définir le pipeline dans le fichier paquet.xml du plugin "fax" <pipeline nom="ms_config" inclure="fax_pipelines.php" />
• ajouter le code suivant dans le fichier fax_pipelines.php du plugin function fax_ms_config($flux) <i> if ((strcmp($flux['cle'],'mediaspip/medias/infos_cachees') == 0) && is_array($flux['valeur'])) <i> $flux['valeur']['info_fax'] = _T('fax:label_case_info_fax') ; </i> return $flux ; </i>
• en finalement ajouter la chaîne de langue fax:label_case_info_fax dans le fichier lang/fax_fr.php du plugin // F 'fax' => 'Numéro de fax',

Le champ fax apparaîtra ainsi dans la liste des champs à cacher, dans la page de configuration des squelettes de MediaSPIP.

Pipeline ms_ajout_html

Le pipeline ms_ajout_html est utilisé, par exemple, dans le squelette d’affichage d’un média :

Ce pipeline passe un tableau à deux éléments :

• data : le HTML produit (vide à l’initialisation, dans cet exemple)
• args : un tableau contenant les arguments suivants
  -* squelette : le squelette dans lequel sera inclus le code HTML
  -* objet et id_objet : la boucle courante dans laquelle a été inclus le pipeline (une boucle ARTICLES dans l’exemple)
  -* et un paramètre spécifique à ce squelette,
  infos_cachees_medias&lt;code&gt;, qui contient le tableau des champs à cacher.<br />
<br />
Dans le plugin imaginaire &quot;fax&quot; défini plus haut, on utilise le pipeline &lt;code&gt;ms_ajout_html

  pour afficher ou non le nouveau champ fax dans le squelette content/article-medias.html :

• définir le pipeline dans le fichier paquet.xml du plugin "fax" <pipeline nom="ms_ajout_html" inclure="fax_pipelines.php" />
• ajouter le code suivant dans le fichier fax_pipelines.php du plugin function fax_ms_ajout_html($flux) <i> if (strcmp($flux['args']['squelette'],'content/article-medias.html') == 0) <i> $flux['data'] .= recuperer_fond('inclure/ms_article_medias', $flux['args']) ; </i> return $flux ; </i>
• créer le fichier inclure/ms_article_medias dans le plugin <BOUCLE_articles(ARTICLES)<i>id_article=#ID_OBJET</i>>[(#VAL<i>info_fax</i>|in_array<i>#ENV<i>infos_cachees_medias</i></i>|non)[ <div class="info_media info-fax"><p><span class="title"><:fax:titre_fax :> </span><span class="fax #EDIT<i>fax</i>"> (#FAX)</span></p></div>]] </BOUCLE_articles>
• finalement ajouter la chaîne de langue fax:titre_fax dans le fichier lang/fax_fr.php du plugin // T 'titre_fax' => 'Numéro de fax',

Le champ "fax" sera ainsi inclus dans les informations de description du média, à condition qu’il n’ait été sélectionné comme champ à cacher.