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

[lhc/web/www.git] / www / plugins-dist / compagnon / compagnon_pipelines.php

diff --git a/www/plugins-dist/compagnon/compagnon_pipelines.php b/www/plugins-dist/compagnon/compagnon_pipelines.php
index b2468cf..3e3d4c7 100644 (file)
--- a/www/plugins-dist/compagnon/compagnon_pipelines.php
+++ b/www/plugins-dist/compagnon/compagnon_pipelines.php
@@ -1,49 +1,94 @@
 <?php
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Utilisations de pipelines
+ *
+ * @package SPIP\Compagnon\Pipelines
+ **/
 
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 
+/**
+ * Ajoute les aides du compagnon sur le pipeline affiche milieu
+ *
+ * @pipeline affiche_milieu
+ *
+ * @param array $flux
+ *     Données du pipeline
+ * @return array
+ *     Données du pipeline
+ **/
 function compagnon_affiche_milieu($flux) {
        return compagnonage($flux, 'affiche_milieu');
 }
+
+/**
+ * Ajoute les aides du compagnon sur le pipeline affiche gauche
+ *
+ * @pipeline affiche_gauche
+ *
+ * @param array $flux
+ *     Données du pipeline
+ * @return array
+ *     Données du pipeline
+ **/
 function compagnon_affiche_gauche($flux) {
        return compagnonage($flux, 'affiche_gauche');
 }
+
+/**
+ * Ajoute les aides du compagnon sur le pipeline affiche droite
+ *
+ * @pipeline affiche_droite
+ *
+ * @param array $flux
+ *     Données du pipeline
+ * @return array
+ *     Données du pipeline
+ **/
 function compagnon_affiche_droite($flux) {
        return compagnonage($flux, 'affiche_droite');
 }
 
 /**
- *  
+ * Ajoute l'aide du compagnon dans un pipeline
+ *
+ * Les aides sont ajoutées
+ * - si la config le permet
+ * - si l'aide n'a pas déjà été validée par le visiteur
+ *
+ * @pipeline_appel compagnon_messages
  *
  * @param array $flux
- *             Flux d'informations transmises au pipeline
+ *    Flux d'informations transmises au pipeline
  * @param string $pipeline
- *             Nom du pipeline d'origine
+ *    Nom du pipeline d'origine
  * @return array $flux
- *             Le flux éventuellement complété de l'aide du compagnon
-**/
+ *    Le flux éventuellement complété de l'aide du compagnon
+ **/
 function compagnonage($flux, $pipeline) {
 
        // pas de compagnon souhaite ?
        include_spip('inc/config');
-       if (lire_config("compagnon/config/activer") == 'non') {
+       if (lire_config('compagnon/config/activer') == 'non') {
                return $flux;
        }
 
        $moi = $GLOBALS['visiteur_session'];
-       $deja_vus = lire_config("compagnon/".$moi['id_auteur']);
+       $deja_vus = lire_config('compagnon/' . $moi['id_auteur']);
 
        $flux['args']['pipeline'] = $pipeline;
        $flux['args']['deja_vus'] = $deja_vus;
-       $aides = pipeline('compagnon_messages', array('args'=>$flux['args'], 'data' => array()));
+       $aides = pipeline('compagnon_messages', array('args' => $flux['args'], 'data' => array()));
 
        if (!$aides) {
                return $flux;
        }
 
-       $ajouts = "";
+       $ajouts = '';
 
        foreach ($aides as $aide) {
                // restreindre l'affichage par statut d'auteur
@@ -69,11 +114,10 @@ function compagnonage($flux, $pipeline) {
                        // demande d'un squelette
                        if (isset($aide['inclure']) and $inclure = $aide['inclure']) {
                                unset($aide['inclure']);
-                               $ajout = recuperer_fond($inclure, array_merge($flux['args'], $aide), array('ajax'=>true));
-                       }
-                       // sinon les textes sont fournis
+                               $ajout = recuperer_fond($inclure, array_merge($flux['args'], $aide), array('ajax' => true));
+                       } // sinon les textes sont fournis
                        else {
-                               $ajout = recuperer_fond('compagnon/_boite', $aide, array('ajax'=>true));
+                               $ajout = recuperer_fond('compagnon/_boite', $aide, array('ajax' => true));
                        }
 
                        $ajouts .= $ajout;
@@ -83,7 +127,7 @@ function compagnonage($flux, $pipeline) {
        // ajout de nos trouvailles
        if ($ajouts) {
                $twinkle = find_in_path('prive/javascript/jquery.twinkle.js');
-               $ajouts.=<<<JS
+               $ajouts .= <<<JS
 <script type="text/javascript">
 jQuery.getScript('$twinkle',function(){
        jQuery(function(){
@@ -95,14 +139,14 @@ jQuery.getScript('$twinkle',function(){
                        }
                };
                jQuery('.compagnon .target').each(function(){
-                         var target = jQuery(this).attr('data-target');
-                         var delay = 0;
-                         jQuery(this).mousemove(function(){
-                             if (!delay) {
-                                   delay=1; setTimeout(function(){delay=0;}, 800);
+                       var target = jQuery(this).attr('data-target');
+                       var delay = 0;
+                       jQuery(this).mousemove(function(){
+                               if (!delay) {
+                                       delay=1; setTimeout(function(){delay=0;}, 800);
                                        jQuery(target).twinkle(options);
-                                 }
-                         });
+                               }
+                       });
                });
        });
 });
@@ -111,11 +155,6 @@ JS;
 
                $flux['data'] = $ajouts . $flux['data'];
        }
-       
+
        return $flux;
 }
-
-
-
-
-?>