Changeset 65580 in spip-zone

Timestamp:

Sep 5, 2012, 5:35:07 PM (7 years ago)

Author:

marcimat@…

Message:

Un peu plus de migration de Formidable vers SPIP 3 :

• paquet.xml et administration nouvelle mode
• un peu de phpdoc.

Location:

_plugins_/formidable/trunk

Files:

• base/formidable_tables.php (modified) (3 diffs)
• formidable_administrations.php (moved) (moved from _plugins_/formidable/trunk/base/formidable_installation.php) (2 diffs)
• formidable_autorisations.php (moved) (moved from _plugins_/formidable/trunk/inc/formidable_autoriser.php)
• formidable_fonctions.php (added)
• formidable_options.php (modified) (2 diffs)
• lang/paquet-formidable_fr.php (added)
• paquet.xml (added)
• plugin.xml (deleted)
• puce_statut (added)
• puce_statut/formulaires_reponse.php (added)

_plugins_/formidable/trunk/base/formidable_tables.php

@@ -1 +1 @@
 <?php
+
+/**
+ * Déclarations relatives à la base de données
+ * 
+ * @package SPIP\Formidable\Pipelines
+**/
 
 // Sécurité
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
-function formidable_declarer_tables_interfaces($interface){
+/**
+ * Déclarer les interfaces des tables de formidable pour le compilateur
+ *
+ * @pipeline declarer_tables_interfaces
+ * @param array $interfaces
+ *     Déclarations d'interface pour le compilateur
+ * @return array
+ *     Déclarations d'interface pour le compilateur
+ */
+function formidable_declarer_tables_interfaces($interfaces) {
         // 'spip_' dans l'index de $tables_principales
-        $interface['table_des_tables']['formulaires'] = 'formulaires';
-        $interface['table_des_tables']['formulaires_reponses'] = 'formulaires_reponses';
-        $interface['table_des_tables']['formulaires_reponses_champs'] = 'formulaires_reponses_champs';
-        
-        
-        $interface['table_titre']['formulaires'] = 'titre';
-        
-        $interface['tables_jointures']['spip_formulaires'][] = 'formulaires_liens';
-        $interface['tables_jointures']['spip_articles'][] = 'formulaires_liens';
-        $interface['tables_jointures']['spip_rubriques'][] = 'formulaires_liens';
-        
-        return $interface;
+        $interfaces['table_des_tables']['formulaires'] = 'formulaires';
+        $interfaces['table_des_tables']['formulaires_reponses'] = 'formulaires_reponses';
+        $interfaces['table_des_tables']['formulaires_reponses_champs'] = 'formulaires_reponses_champs';
+
+        $interfaces['table_titre']['formulaires'] = 'titre';
+
+        $interfaces['tables_jointures']['spip_formulaires'][] = 'formulaires_liens';
+        $interfaces['tables_jointures']['spip_articles'][] = 'formulaires_liens';
+        $interfaces['tables_jointures']['spip_rubriques'][] = 'formulaires_liens';
+
+        return $interfaces;
 }
 
+
+/**
+ * Déclarer les tables principales de formidable
+ *
+ * @pipeline declarer_tables_principales
+ * @param array $tables_principales
+ *     Description des tables
+ * @return array
+ *     Description complétée des tables
+ */
 function formidable_declarer_tables_principales($tables_principales){
         //-- Table formulaires -----------------------------------------------------
@@ -93 +117 @@
 }
 
+/**
+ * Déclarer les tables auxiliaires de formidable
+ *
+ * @pipeline declarer_tables_auxiliaires
+ * @param array $tables_auxiliaires
+ *     Description des tables
+ * @return array
+ *     Description complétée des tables
+ */
 function formidable_declarer_tables_auxiliaires($tables_auxiliaires){
         $formulaires_liens = array(
@@ -113 +146 @@
 }
 
+/**
+ * Déclarer les champs inclus dans la recherche 
+ *
+ * @pipeline rechercher_liste_des_champs
+ * @param array $tables
+ *     Liste des tables, de leurs champs de recherche et pondération
+ * @return array
+ *     Liste ddes tables complétée
+**/
 function formidable_rechercher_liste_des_champs($tables){
         $tables['formulaire']['titre'] = 5;

_plugins_/formidable/trunk/formidable_administrations.php

@@ -1 +1 @@
 <?php
+
+/**
+ * Fichier gérant l'installation et désinstallation du plugin
+ *
+ * @package SPIP\Formidable\Installation
+**/
 
 // Sécurité
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
-include_spip('inc/meta');
+/**
+ * Installation/maj des tables de formidable...
+ *
+ * @param string $nom_meta_base_version
+ *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
+ * @param string $version_cible
+ *     Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
+ * @return void
+ */
+function formidable_upgrade($nom_meta_base_version, $version_cible){
+        // Création des tables
+        include_spip('base/create');
+        include_spip('base/abstract_sql');
 
-// Installation et mise à jour
-function formidable_upgrade($nom_meta_version_base, $version_cible){
+        $maj = array();
+        $maj['create'] = array(
+                array('maj_tables',array(
+                        'spip_formulaires',
+                        'spip_formulaires_reponses'
+                        'spip_formulaires_reponses_champs'
+                        'spip_formulaires_liens')),
+        );
+        // Ajout du choix de ce qu'on affiche à la fin des traitements
+        $maj['0.4.0'] = array(array('maj_tables',array('spip_formulaires')));
+        // Ajout d'une URL de redirection
+        $maj['0.5.0'] = array(array('maj_tables',array('spip_formulaires')));
+        // Modif du type du message de retour pour pouvoir mettre plus de chose
+        $maj['0.5.1'] = array(array('sql_alter','TABLE spip_formulaires CHANGE message_retour message_retour text NOT NULL default ""'));
 
-        $version_actuelle = '0.0';
-        if (
-                (!isset($GLOBALS['meta'][$nom_meta_version_base]))
-                || (($version_actuelle = $GLOBALS['meta'][$nom_meta_version_base]) != $version_cible)
-        ){
-                
-                if (version_compare($version_actuelle,'0.0','=')){
-                        // Création des tables
-                        include_spip('base/create');
-                        include_spip('base/abstract_sql');
-                        creer_base();
-                        
-                        echo "Installation du plugin formidable<br/>";
-                        ecrire_meta($nom_meta_version_base, $version_actuelle=$version_cible, 'non');
-                }
-                
-                // Ajout du choix de ce qu'on affiche à la fin des traitements
-                if (version_compare($version_actuelle,$version_cible='0.4.0','<')){     
-                        include_spip('base/create');
-                        maj_tables('spip_formulaires');
-
-                        echo "Mise à jour du plugin formidable en version 0.4.0<br/>";
-                        ecrire_meta($nom_meta_version_base, $version_actuelle=$version_cible, 'non');
-                }
-                
-                // Ajout d'une URL de redirection
-                if (version_compare($version_actuelle,$version_cible='0.5.0','<')){     
-                        include_spip('base/create');
-                        maj_tables('spip_formulaires');
-                        
-                        echo "Mise à jour du plugin formidable en version 0.5.0<br/>";
-                        ecrire_meta($nom_meta_version_base, $version_actuelle=$version_cible, 'non');
-                }
-                
-                // Modif du type du message de retour pour pouvoir mettre plus de chose
-                if (version_compare($version_actuelle,$version_cible='0.5.1','<')){     
-                        include_spip('base/abstract_sql');
-                        sql_alter('TABLE spip_formulaires CHANGE message_retour message_retour text NOT NULL default ""');
-                        
-                        echo "Mise à jour du plugin formidable en version 0.5.1<br/>";
-                        ecrire_meta($nom_meta_version_base, $version_actuelle=$version_cible, 'non');
-                }
-        }
-        
+        include_spip('base/upgrade');
+        maj_plugin($nom_meta_base_version, $version_cible, $maj);
 }
 
-// Désinstallation
-function formidable_vider_tables($nom_meta_version_base){
+/**
+ * Désinstallation/suppression des tables de formidable
+ *
+ * @param string $nom_meta_base_version
+ *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
+ * @return void
+ */
+function formidable_vider_tables($nom_meta_base_version){
 
+        include_spip('inc/meta');
         include_spip('base/abstract_sql');
-        
+
         // On efface les tables du plugin
         sql_drop_table('spip_formulaires');
@@ -65 +60 @@
         sql_drop_table('spip_formulaires_reponses_champs');
         sql_drop_table('spip_formulaires_liens');
-                
+
         // On efface la version entregistrée
-        effacer_meta($nom_meta_version_base);
-
+        effacer_meta($nom_meta_base_version);
 }
 

_plugins_/formidable/trunk/formidable_options.php

@@ -1 +1 @@
 <?php
+
+/**
+ * Options globales chargées à chaque hit
+ *
+ * @package SPIP\Formidable\Options
+**/
 
 // Sécurité
@@ -78 +84 @@
 );
 
-function puce_statut_formulaires_reponse_dist($id, $statut, $id_rubrique, $type='formulaires_reponse', $ajax=false){
-        global $lang_objet;
-        
-        static $coord = array(
-                'publie' => 1,
-                'prop' => 0,
-                'poubelle' => 2
-        );
 
-        $lang_dir = lang_dir($lang_objet);
-        $ajax_node = " id='imgstatut$type$id'";
-        $inser_puce = puce_statut($statut, " width='9' height='9' style='margin: 1px;'$ajax_node");
-
-        if (!autoriser('instituer', 'formulaires_reponse', $id)
-                or !_ACTIVER_PUCE_RAPIDE
-        )
-                return $inser_puce;
-
-        $titles = array(
-                "orange" => _T('texte_statut_propose_evaluation'),
-                "verte" => _T('texte_statut_publie'),
-                "poubelle" => _T('texte_statut_poubelle')
-        );
-        
-        $clip = 1 + (11 * $coord[$statut]);
-
-        if ($ajax){
-                return  "<span class='puce_article_fixe'>"
-                . $inser_puce
-                . "</span>"
-                . "<span class='puce_article_popup' id='statutdecal$type$id' style='width:33px; margin-left: -$clip"."px;'>"
-                  . afficher_script_statut($id, $type, -1, 'puce-orange.gif', 'prop', $titles['orange'])
-                  . afficher_script_statut($id, $type, -12, 'puce-verte.gif', 'publie', $titles['verte'])
-                  . afficher_script_statut($id, $type, -23, 'puce-poubelle.gif', 'poubelle', $titles['poubelle'])
-                  . "</span>";
-        }
-
-        $nom = "puce_statut_";
-
-        if ((! _SPIP_AJAX) AND $type != 'formulaires_reponse') 
-          $over ='';
-        else {
-                $action = generer_url_ecrire('puce_statut_formulaires',"",true);
-                $action = "if (!this.puce_loaded) { this.puce_loaded = true; prepare_selec_statut('$nom', '$type', '$id', '$action'); }";
-                $over = "\nonmouseover=\"$action\"";
-        }
-
-        return  "<span class='puce_article' id='$nom$type$id' dir='$lang_dir'$over>"
-        . $inser_puce
-        . '</span>';
-}
-
-if (!function_exists('array_fill_keys')){
+if (!function_exists('array_fill_keys')) {
+        /**
+         * Remplit un tableau avec des valeurs, en spécifiant les clés
+         *
+         * Fonction dans PHP 5.2+
+         * @see http://php.net/manual/fr/function.array-fill-keys.php
+         * 
+         * @param array $keys
+         *     Tableau de valeurs qui sera utilisé comme clés. 
+         * @param mixed $value
+         *     Valeur à utiliser pour remplir le tableau.
+         * @return array
+         *     Le tableau rempli. 
+        **/
         function array_fill_keys($keys, $value){
                 array_combine($keys,array_fill(0,count($keys),$value));