Changeset 48140 in spip-zone

Timestamp:

May 26, 2011, 2:22:24 PM (10 years ago)

Author:

paladin@…

Message:

Documentation code

Location:

_plugins_/spip-listes/spip-listes_1_9_3

Files:

• genie/spiplistes_cron.php (modified) (4 diffs)
• inc/spiplistes_api.php (modified) (2 diffs)
• inc/spiplistes_api_courrier.php (modified) (2 diffs)
• inc/spiplistes_meleuse.php (modified) (4 diffs)

_plugins_/spip-listes/spip-listes_1_9_3/genie/spiplistes_cron.php

@@ -192 +192 @@
                         }
         
-                        /////////////////////////////
-                        // preparation du courrier a placer dans le panier (spip_courriers)
-                        // en cas de periode, la date est dans le passe'
-                        // pour avoir les elements publies depuis cette date
+                        /**
+                         * preparation du courrier a placer dans le panier (spip_courriers)
+                         * en cas de periode, la date est dans le passe'
+                         * pour avoir les elements publies depuis cette date
+                         */
                         if (
                                 empty($titre_message)
@@ -209 +210 @@
                         spiplistes_debug_log ($prefix_log.'utiliser patron '._SPIPLISTES_PATRONS_DIR.$patron);
                         
+                        /**
+                         * Assemble le patron
+                         * Obtient en retour le contenu en version html et texte
+                         */
                         list($courrier_html, $courrier_texte) = spiplistes_courriers_assembler_patron (
                                 _SPIPLISTES_PATRONS_DIR . $patron
                                 , array('date' => $dernier_envoi, 'patron'=>$patron, 'lang'=>$lang));
                         
-                        //$taille_courrier_ok = (($n = spiplistes_strlen(spiplistes_courrier_version_texte($courrier_html))) > 10);
                         $taille_courrier_ok = (($n = strlen($courrier_texte)) > 10);
                         
                         spiplistes_debug_log($prefix_log.'taille courrier pour la liste #'.$id_liste.' : '.$n);
 
-                        if($taille_courrier_ok) {
+                        /**
+                         * Si la taille du courrier est OK
+                         * corriger les URLs
+                         * Sinon, passer le courrier en statut 'vide'
+                         */
+                        if ($taille_courrier_ok) {
                                 include_spip('inc/filtres');
                                 $courrier_html = spiplistes_liens_absolus ($courrier_html);
@@ -230 +239 @@
                         }
 
-                        // Place le courrier dans le casier
+                        /**
+                         * Place le courrier dans le casier
+                         */
                         $id_courrier = sql_insert(
                                 'spip_courriers'
@@ -262 +273 @@
                                 // place les etiquettes
                                 // (ajout des abonnes dans la queue (spip_auteurs_courriers))
-                                spiplistes_courrier_remplir_queue_envois($id_courrier, $id_liste);
+                                spiplistes_courrier_remplir_queue_envois ($id_courrier, $id_liste);
                         } 
                 } // end while // fin traitement des listes

_plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_api.php

@@ -1179 +1179 @@
                 ;
         
-        // chercher si un patron version texte existe
+        /**
+         * Calculer le contenu texte à partir
+         * du {patron}_texte s'il existe
+         */
         $patron_texte = spiplistes_patron_find_in_path($path_patron, $contexte['lang'], true);
         unset($contexte['patron_html']);
@@ -1197 +1200 @@
                 }
         }
-        // si version texte manque, la calculer
-        // a partir de la version html
+        /**
+         * si {patron}_texte manque, ou vide,
+         * calculer a partir de la version html
+         */
         if (!$texte_ok) {
                 $result_texte = spiplistes_courrier_version_texte($result_html);

_plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_api_courrier.php

@@ -266 +266 @@
 /**
  * Ajouter les abonnes d'une liste a un envoi
- * @param : $id_courrier : reference d'un envoi
- * @param $id_liste : reference d'une liste
+ * @param int $id_courrier reference d'un envoi
+ * @param int $id_liste reference d'une liste
+ * @param int $id_auteur
  * @return bool
  */
 function spiplistes_courrier_remplir_queue_envois ($id_courrier, $id_liste, $id_auteur = 0) {
+        
         $id_courrier = intval($id_courrier);
         $id_liste = intval($id_liste);
@@ -285 +287 @@
                         // prendre la liste des abonnes a cette liste
                         $ids_abos = spiplistes_listes_liste_abo_ids($id_liste);
-                        if(count($ids_abos)) {
+                        if(count($ids_abos))
+                        {
                                 $sql_where_q = "(".implode(",", array_map("sql_quote", $ids_abos)).")";
                                 $sql_result = sql_select('id_auteur', 'spip_auteurs', "id_auteur IN $sql_where_q", ''

_plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_meleuse.php

@@ -260 +260 @@
                                 ;
                         
-                        ////////////////////////////////////
-                        // Ajoute lien tete de courrier
+                        /**
+                         * Ajouter le lien de courrier
+                         * en tête du courrier
+                         * si demandé en page de configuration
+                         */
                         if(
                                 ($opt_lien_en_tete_courrier == 'oui') 
@@ -275 +278 @@
                         }
 
-                        ////////////////////////////////////
-                        // La petite ligne du renvoi du cookie pour modifier son abonnement
-                        //$pied_rappel_html = _T('spiplistes:modif_abonnement_html');
-                        //$pied_rappel_texte = _T('spiplistes:modif_abonnement_text');
-                        
-                        // transcrire le contenu
+                        /**
+                         * transcrire le contenu
+                         * dans le charset souhaité
+                         * indiqué en page de configuration
+                         */
                         if ($charset_dest != $charset_spip)
                         {
@@ -303 +305 @@
                         }
                         
-                        // corrige les liens relatifs (celui de texte a deja ete corrige par la trieuse (cron)
+                        /**
+                         * corrige les liens relatifs
+                         * (celui de texte a deja ete corrige par la trieuse (cron)
+                         */
                         foreach(array('pied_html', 'pied_texte'
                                 //, 'pied_rappel_html', 'pied_rappel_texte'
@@ -313 +318 @@
 
                         /**
-                         * Adapter le CSS
+                         * Adapter le CSS produit par SPIP
+                         * (les class spip-center, etc.
+                         * sont remplacées par style en inline)
                          */
                         foreach(array(