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

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

diff --git a/www/plugins-dist/mots/mots_administrations.php b/www/plugins-dist/mots/mots_administrations.php
index be8e11d..ffc3568 100644 (file)
--- a/www/plugins-dist/mots/mots_administrations.php
+++ b/www/plugins-dist/mots/mots_administrations.php
@@ -10,65 +10,76 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Fichier gérant l'installation et désinstallation du plugin
+ *
+ * @package SPIP\Mots\Installation
+ **/
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 /**
  * Installation/maj des tables mots et groupes de mots...
  *
  * @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 mots_upgrade($nom_meta_base_version,$version_cible){
+function mots_upgrade($nom_meta_base_version, $version_cible) {
 
        // cas particulier :
        // si plugin pas installe mais que la table existe
        // considerer que c'est un upgrade depuis v 1.0.0
        // pour gerer l'historique des installations SPIP <=2.1
-       if (!isset($GLOBALS['meta'][$nom_meta_base_version])){
-               $trouver_table = charger_fonction('trouver_table','base');
+       if (!isset($GLOBALS['meta'][$nom_meta_base_version])) {
+               $trouver_table = charger_fonction('trouver_table', 'base');
                if ($desc = $trouver_table('spip_mots')
-                 AND isset($desc['exist']) AND $desc['exist']
-                 AND $desc = $trouver_table('spip_mots_articles')
-                       AND isset($desc['exist']) AND $desc['exist']){
-                       ecrire_meta($nom_meta_base_version,'1.0.0');
+                       and isset($desc['exist']) and $desc['exist']
+                       and $desc = $trouver_table('spip_mots_articles')
+                       and isset($desc['exist']) and $desc['exist']
+               ) {
+                       ecrire_meta($nom_meta_base_version, '1.0.0');
                }
                // si pas de table en base, on fera une simple creation de base
        }
 
        $maj = array();
        $maj['create'] = array(
-               array('maj_tables',array('spip_groupes_mots','spip_mots','spip_mots_liens')),
+               array('maj_tables', array('spip_groupes_mots', 'spip_mots', 'spip_mots_liens')),
        );
        $maj['1.0.0'] = array(
-               array('maj_tables',array('spip_groupes_mots','spip_mots','spip_mots_liens')),
+               array('maj_tables', array('spip_groupes_mots', 'spip_mots', 'spip_mots_liens')),
        );
        include_spip('maj/svn10000');
        $maj['2.0.0'] = array(
-               array('maj_liens','mot'), // creer la table liens
-               array('maj_liens','mot','breve'),
-               array('sql_drop_table',"spip_mots_breves"),
-               array('maj_liens','mot','rubrique'),
-               array('sql_drop_table',"spip_mots_rubriques"),
-               array('maj_liens','mot','syndic'),
-               array('sql_drop_table',"spip_mots_syndic"),
-               array('maj_liens','mot','forum'),
-               array('sql_drop_table',"spip_mots_forum"),
-               array('maj_liens','mot','auteur'),
-               array('sql_drop_table',"spip_mots_auteurs"),
-               array('maj_liens','mot','document'),
-               array('sql_drop_table',"spip_mots_documents"),
-               array('maj_liens','mot','article'),
-               array('sql_drop_table',"spip_mots_articles"),
+               array('maj_liens', 'mot'), // creer la table liens
+               array('maj_liens', 'mot', 'breve'),
+               array('sql_drop_table', 'spip_mots_breves'),
+               array('maj_liens', 'mot', 'rubrique'),
+               array('sql_drop_table', 'spip_mots_rubriques'),
+               array('maj_liens', 'mot', 'syndic'),
+               array('sql_drop_table', 'spip_mots_syndic'),
+               array('maj_liens', 'mot', 'forum'),
+               array('sql_drop_table', 'spip_mots_forum'),
+               array('maj_liens', 'mot', 'auteur'),
+               array('sql_drop_table', 'spip_mots_auteurs'),
+               array('maj_liens', 'mot', 'document'),
+               array('sql_drop_table', 'spip_mots_documents'),
+               array('maj_liens', 'mot', 'article'),
+               array('sql_drop_table', 'spip_mots_articles')
        );
        $maj['2.0.1'] = array(
-               array('sql_updateq',"spip_mots_liens",array('objet'=>'site'),"objet='syndic'"),
+               array('sql_updateq', 'spip_mots_liens', array('objet' => 'site'), "objet='syndic'"),
        );
        $maj['2.1.0'] = array(
-               array('sql_alter',"TABLE spip_mots_liens ADD INDEX id_objet (id_objet)"),
-               array('sql_alter',"TABLE spip_mots_liens ADD INDEX objet (objet)"),
+               array('sql_alter', 'TABLE spip_mots_liens ADD INDEX id_objet (id_objet)'),
+               array('sql_alter', 'TABLE spip_mots_liens ADD INDEX objet (objet)')
        );
        $maj['2.1.1'] = array(
-               array('sql_alter',"TABLE spip_mots ADD INDEX id_groupe (id_groupe)")
+               array('sql_alter', 'TABLE spip_mots ADD INDEX id_groupe (id_groupe)')
        );
 
        include_spip('base/upgrade');
@@ -77,19 +88,19 @@ function mots_upgrade($nom_meta_base_version,$version_cible){
 
 
 /**
- * Desinstallation/suppression des tables mots et groupes de mots
+ * Désinstallation/suppression des tables mots et groupes de mots
  *
  * @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 mots_vider_tables($nom_meta_base_version) {
-       sql_drop_table("spip_mots");
-       sql_drop_table("spip_groupes_mots");
-       sql_drop_table("spip_mots_liens");
-       
+       sql_drop_table('spip_mots');
+       sql_drop_table('spip_groupes_mots');
+       sql_drop_table('spip_mots_liens');
+
        effacer_meta('articles_mots');
        effacer_meta('config_precise_groupes');
-       
+
        effacer_meta($nom_meta_base_version);
 }
-
-?>