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

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

diff --git a/www/plugins-dist/compagnon/compagnon_administrations.php b/www/plugins-dist/compagnon/compagnon_administrations.php
index 2bd3578..3a0b499 100644 (file)
--- a/www/plugins-dist/compagnon/compagnon_administrations.php
+++ b/www/plugins-dist/compagnon/compagnon_administrations.php
@@ -1,10 +1,28 @@
 <?php
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Fichier gérant l'installation et désinstallation du plugin
+ *
+ * @package SPIP\Compagnon\Installation
+ **/
 
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
+
+/**
+ * Installation et mises à jour du plugin
+ *
+ * Active par défaut le compagnon s'il n'y a aucune rubrique dans le site.
+ *
+ * @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 compagnon_upgrade($nom_meta_base_version, $version_cible) {
 
-function compagnon_upgrade($nom_meta_base_version, $version_cible){
-       
        $maj = array();
        $maj['create'] = array(
                array('compagnon_create')
@@ -13,6 +31,11 @@ function compagnon_upgrade($nom_meta_base_version, $version_cible){
        maj_plugin($nom_meta_base_version, $version_cible, $maj);
 }
 
+/**
+ * Déclare la configuration du compagnon
+ *
+ * Si aucune rubrique n'est présente, active le compagnon, sinon non.
+ **/
 function compagnon_create() {
        include_spip('inc/config');
        if (sql_getfetsel('id_rubrique', 'spip_rubriques', '', '', '', '0,1')) {
@@ -22,8 +45,16 @@ function compagnon_create() {
        }
 }
 
+/**
+ * Désinstallation du plugin
+ *
+ * Efface les informations du compagnon
+ *
+ * @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 compagnon_vider_tables($nom_meta_base_version) {
-       effacer_meta("compagnon");
+       effacer_meta('compagnon');
        effacer_meta($nom_meta_base_version);
 }
-?>