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

[lhc/web/www.git] / www / plugins-dist / mots / mots_pipelines.php

diff --git a/www/plugins-dist/mots/mots_pipelines.php b/www/plugins-dist/mots/mots_pipelines.php
index a0d1359..e2c8d1b 100644 (file)
--- a/www/plugins-dist/mots/mots_pipelines.php
+++ b/www/plugins-dist/mots/mots_pipelines.php
@@ -10,72 +10,97 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Utilisations de pipelines
+ *
+ * @package SPIP\Mots\Pipelines
+ **/
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 /**
- * Definir les meta de configuration liee aux mots
+ * Définir les meta de configuration liées aux mots
  *
+ * @pipeline configurer_liste_metas
  * @param array $metas
+ *     Couples nom de la méta => valeur par défaut
  * @return array
+ *    Couples nom de la méta => valeur par défaut
  */
-function mots_configurer_liste_metas($metas){
-       $metas['articles_mots'] =  'non';
-       $metas['config_precise_groupes'] =  'non';
+function mots_configurer_liste_metas($metas) {
+       $metas['articles_mots'] = 'non';
+       $metas['config_precise_groupes'] = 'non';
+
        #$metas['mots_cles_forums'] =  'non';
        return $metas;
 }
 
 /**
- * Configuration des mots
+ * Utilisation du pipeline affiche milieu
+ *
+ * - Ajoute le formulaire de configuration des mots sur la configuration des contenus
+ * - Ajoute le formulaire d'édition de mots sur les objets qui le peuvent
+ *
+ * @pipeline affiche_milieu
  *
  * @param array $flux
+ *     Données du pipeline
  * @return array
+ *     Données du pipeline
  */
-function mots_affiche_milieu($flux){
-       if ($flux["args"]["exec"] == "configurer_contenu") {
-               $flux["data"] .=  recuperer_fond('prive/squelettes/inclure/configurer',array('configurer'=>'configurer_mots'));
+function mots_affiche_milieu($flux) {
+       if ($flux['args']['exec'] == 'configurer_contenu') {
+               $flux['data'] .= recuperer_fond('prive/squelettes/inclure/configurer', array('configurer' => 'configurer_mots'));
        }
 
        // si on est sur une page ou il faut inserer les mots cles...
        if ($en_cours = trouver_objet_exec($flux['args']['exec'])
-               AND $en_cours['edition']!==true // page visu
-               AND $type = $en_cours['type']
-               AND $id_table_objet = $en_cours['id_table_objet']
-               AND ($id = intval($flux['args'][$id_table_objet]))){
+               and $en_cours['edition'] !== true // page visu
+               and $type = $en_cours['type']
+               and $id_table_objet = $en_cours['id_table_objet']
+               and isset($flux['args'][$id_table_objet])
+               and ($id = intval($flux['args'][$id_table_objet]))
+       ) {
                $texte = recuperer_fond(
-                               'prive/objets/editer/liens',
-                               array(
-                                       'table_source'=>'mots',
-                                       'objet'=>$type,
-                                       'id_objet'=>$id,
-                               )
+                       'prive/objets/editer/liens',
+                       array(
+                               'table_source' => 'mots',
+                               'objet' => $type,
+                               'id_objet' => $id,
+                       )
                );
-               if ($p=strpos($flux['data'],"<!--affiche_milieu-->"))
-                       $flux['data'] = substr_replace($flux['data'],$texte,$p,0);
-               else
+               if ($p = strpos($flux['data'], '<!--affiche_milieu-->')) {
+                       $flux['data'] = substr_replace($flux['data'], $texte, $p, 0);
+               } else {
                        $flux['data'] .= $texte;
+               }
        }
-               
+
        return $flux;
 }
 
 /**
- * Optimiser la base de donnee en supprimant les liens orphelins
+ * Optimise la base de données en supprimant les liens orphelins
  *
- * @param int $n
- * @return int
+ * @pipeline optimiser_base_disparus
+ *
+ * @param array $flux
+ *     Données du pipeline
+ * @return array
+ *     Données du pipeline
  */
-function mots_optimiser_base_disparus($flux){
+function mots_optimiser_base_disparus($flux) {
        $n = &$flux['data'];
        $mydate = $flux['args']['date'];
-       
-       $result = sql_delete("spip_mots", "length(titre)=0 AND maj < $mydate");
+
+       $result = sql_delete('spip_mots', 'length(titre)=0 AND maj < ' . sql_quote($mydate));
 
        include_spip('action/editer_liens');
        // optimiser les liens morts :
        // entre mots vers des objets effaces
        // depuis des mots effaces
-       $n+= objet_optimiser_liens(array('mot'=>'*'),'*');
+       $n += objet_optimiser_liens(array('mot' => '*'), '*');
 
        return $flux;
 
@@ -84,20 +109,22 @@ function mots_optimiser_base_disparus($flux){
 
 /**
  * Copier le type des groupes sur la table spip_mots
- * a chaque changement d'un groupe.
+ * à chaque changement d'un groupe.
+ *
+ * @pipeline post_edition
  *
  * @param array $flux
+ *     Données du pipeline
  * @return array
+ *     Données du pipeline
  */
-function mots_post_edition($flux){
-       if (($flux['args']['table'] == 'spip_groupes_mots')
-               and isset($flux['data']['titre']))
-       {
-               sql_updateq('spip_mots', array('type' => $flux['data']['titre']),
-                       'id_groupe=' . $flux['args']['id_objet']);
+function mots_post_edition($flux) {
+       if (isset($flux['args']['table'])
+               and ($flux['args']['table'] == 'spip_groupes_mots')
+               and isset($flux['data']['titre'])
+       ) {
+               sql_updateq('spip_mots', array('type' => $flux['data']['titre']), 'id_groupe=' . $flux['args']['id_objet']);
        }
 
        return $flux;
 }
-
-?>