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

[lhc/web/www.git] / www / plugins-dist / breves / breves_administrations.php

diff --git a/www/plugins-dist/breves/breves_administrations.php b/www/plugins-dist/breves/breves_administrations.php
index b74be95..df95625 100644 (file)
--- a/www/plugins-dist/breves/breves_administrations.php
+++ b/www/plugins-dist/breves/breves_administrations.php
@@ -10,48 +10,60 @@
  *  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\Breves\Installation
+ **/
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 /**
- * Installation/maj des tables breves
+ * Installation/maj des tables de brèves
+ *
+ * Crée les tables SQL du plugin (spip_breves)
  *
  * @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)
  */
-function breves_upgrade($nom_meta_base_version,$version_cible){
+function breves_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_breves')
-                 AND isset($desc['exist']) AND $desc['exist']){
-                       ecrire_meta($nom_meta_base_version,'1.0.0');
+                       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_breves')),
+               array('maj_tables', array('spip_breves')),
        );
 
        include_spip('base/upgrade');
        maj_plugin($nom_meta_base_version, $version_cible, $maj);
 }
 
+
 /**
- * Desinstallation/suppression des tables breves
+ * Désinstallation du plugin
+ *
+ * Supprime les tables SQL du plugin (spip_breves)
  *
  * @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
+ **/
 function breves_vider_tables($nom_meta_base_version) {
-       sql_drop_table("spip_breves");
-       
-       effacer_meta("activer_breves");
-       
+       sql_drop_table('spip_breves');
+       effacer_meta('activer_breves');
        effacer_meta($nom_meta_base_version);
 }
-
-?>