Ignore:
Timestamp:
Aug 29, 2013, 4:28:16 PM (8 years ago)
Author:
eric@…
Message:

PHPDoc sur le schéma.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/boussole_administrations.php

    r75088 r75096  
    11<?php
     2/**
     3 * Ce fichier contient les fonctions de création, de mise à jour et de suppression
     4 * du schéma de données propres au plugin (tables de la base de données et configuration meta)
     5 *
     6 * @package SPIP\BOUSSOLE\Schema\Installation
     7 */
    28
    39if (!defined("_ECRIRE_INC_VERSION")) return;
    410
    5 /**
    6  * Installation du schéma de données propre au plugin en tenant compte des évolutions.
    7  *
    8  * Le schéma comprend des tables en BDD :
    9  * - spip_boussoles,
    10  * - spip_boussoles_extras,
    11  * et des variables de configuration
    12  *
    13  * @param $nom_meta_base_version
     11
     12/**
     13 * Installation du schéma de données propre au plugin et gestion des migrations suivant
     14 * les évolutions.
     15 *
     16 * Le schéma comprend des tables en BDD et des variables de configuration
     17 *
     18 * @api
     19 *
     20 * @param string $nom_meta_base_version
    1421 *              Nom de la meta dans laquelle sera rangée la version du schéma
    15  * @param $version_cible
     22 * @param string $version_cible
    1623 *              Version du schéma de données en fin d'upgrade
     24 *
     25 * @return void
    1726 */
    1827function boussole_upgrade($nom_meta_base_version, $version_cible){
     
    7079 * Suppression de l'ensemble du schéma de données propre au plugin
    7180 *
    72  * @param $nom_meta_base_version
     81 * @api
     82 *
     83 * @param string $nom_meta_base_version
    7384 *              Nom de la meta dans laquelle sera rangée la version du schéma
     85 *
     86 * @return void
    7487 */
    7588function boussole_vider_tables($nom_meta_base_version) {
     
    127140 * transférées dans des variables de configuration
    128141 *
    129  * @param array
     142 * @param array $defaut_config
    130143 *              Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site a
    131144 *              déjà personnalisé les globales la configuration par défaut sera écrasée par
     
    182195 * l'une pour l'activité de la fonction serveur et l'autre pour le nom du serveur.
    183196 *
    184  * @param array
     197 * @param array $defaut_config
    185198 *              Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site est
    186199 *              déjà un serveur, la configuration par défaut sera écrasée par celle de la constante migrée.
Note: See TracChangeset for help on using the changeset viewer.