Changeset 75199 in spip-zone


Ignore:
Timestamp:
Sep 1, 2013, 2:52:13 PM (6 years ago)
Author:
eric@…
Message:

Renommage, modification du retour de certaines fonctions et PHPDoc

Location:
_plugins_/boussole/trunk
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/base/boussole_declarer.php

    r75126 r75199  
    11<?php
    22/**
    3  * Ce fichier contient les déclarations des modifications de la base de données requises
     3 * Ce fichier contient les modifications de la base de données requises
    44 * par le plugin.
    55 *
  • _plugins_/boussole/trunk/boussole_administrations.php

    r75126 r75199  
    22/**
    33 * 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)
     4 * du schéma de données propres au plugin (tables et configuration).
    55 *
    66 * @package SPIP\BOUSSOLE\Schema\Installation
     
    1414 * les évolutions du schéma.
    1515 *
    16  * Le schéma comprend des tables en BDD et des variables de configuration.
     16 * Le schéma comprend des tables et des variables de configuration.
    1717 *
    1818 * @api
  • _plugins_/boussole/trunk/inc/client.php

    r75195 r75199  
    11<?php
     2/**
     3 * Ce fichier contient l'API de gestion des boussoles sur le site client (base de données).
     4 *
     5 * @package SPIP\BOUSSOLE\Client\BDD
     6 */
    27
    38if (!defined("_ECRIRE_INC_VERSION")) return;
     
    510
    611/**
    7  * Mise à jour en base de données des boussoles installées sur le site client.
    8  *
    9  * @package SPIP\BOUSSOLE\Client
     12 * Mise à jour en base de données de toutes les boussoles installées sur le site client.
     13 *
     14 * La fonction appelle, pour toutes les boussoles installées dans la base de données du site client,
     15 * l'api d'ajout d'une boussole.
     16 *
    1017 * @api
    11  *
    12  * @return bool
     18 * @uses boussole_ajouter()
     19 *
     20 * @return void
    1321 */
    1422function boussole_actualiser_boussoles() {
     
    2634                }
    2735        }
    28 
    29         return true;
    30 }
    31 
    32 
    33 /**
    34  * Ajout de la boussole dans la base de donnees du site client
    35  *
    36  * @package     SPIP\BOUSSOLE\Client
     36}
     37
     38
     39/**
     40 * Ajout ou actualisation de la boussole dans la base de donnees du site client.
     41 *
     42 * Suivant que la boussole existe ou pas, la fonction renvoie le message adapté. Néanmoins,
     43 * le traitement est toujours le même et la boussole, si elle eexiste est préalablement supprimée
     44 * avant d'être insérée à nouveau.
     45 *
    3746 * @api
    3847 *
    39  * @param string $boussole      Alias de la boussole
    40  * @param string $serveur       Alias du serveur fournissant les données sur la boussole
    41  *
    42  * @return array()      index 0 : true ou false
    43  *                                      index 1 : libellé traduit du message d'erreur
     48 * @param string $boussole
     49 *              Alias de la boussole
     50 * @param string $serveur
     51 *              Alias du serveur fournissant les données sur la boussole
     52 * @return array
     53 *              Tableau décrivant le statut des traitements effectués :
     54 *
     55 *              - index 0 : `true` ou `false`,
     56 *              - index 1 : libellé traduit du message d'erreur.
    4457 */
    4558function boussole_ajouter($boussole, $serveur='spip') {
     
    119132
    120133/**
    121  * Suppression de la boussole dans la base de donnees
    122  *
    123  * @package     SPIP\BOUSSOLE\Client
     134 * Suppression de la boussole dans la base de données du site client.
     135 *
    124136 * @api
    125137 *
    126  * @param string $aka_boussole  alias de la boussole
    127  *
     138 * @param string $boussole
     139 *      Alias de la boussole
    128140 * @return boolean
    129  */
    130 function boussole_supprimer($aka_boussole) {
     141 *              `false` si l'alias de la boussole est vide, `true`sinon
     142 */
     143function boussole_supprimer($boussole) {
    131144       
    132145        // Alias non conforme
    133         if (!$aka_boussole)
     146        if (!$boussole)
    134147                return false;
    135148
    136149        // On supprime les sites de cette boussole
    137         sql_delete('spip_boussoles','aka_boussole='.sql_quote($aka_boussole));
     150        sql_delete('spip_boussoles','aka_boussole='.sql_quote($boussole));
    138151        // On supprime les extras de cette boussole
    139152        $trouver = charger_fonction('trouver_table', 'base');
    140153        if ($trouver('spip_boussoles_extras'))
    141                 sql_delete('spip_boussoles_extras','aka_boussole='.sql_quote($aka_boussole));
     154                sql_delete('spip_boussoles_extras','aka_boussole='.sql_quote($boussole));
    142155        // On supprime ensuite la meta consignant la derniere mise a jour de cette boussole
    143         effacer_meta('boussole_infos_' . $aka_boussole);
     156        effacer_meta('boussole_infos_' . $boussole);
    144157
    145158        return true;
     
    147160
    148161/**
    149  * Renvoie, a partir du fichier xml de la boussole, un tableau des sites de la boussole
    150  * Les cles du tableau correspondent au nom des champs en base de donnees
    151  *
    152  * @package     SPIP\BOUSSOLE\Client
    153  *
    154  * @param string $boussole      Alias de la boussole
    155  * @param string $serveur       Alias du serveur fournissant les données sur la boussole
    156  *
    157  * @return array()      index 0 : true ou false
    158  *                                      index 1 : id de l'erreur (l'item associé se construit en rajoutant message_nok_ en préfixe)
     162 * Conversion du fichier XML de la boussole en un tableau des sites de la boussole.
     163 *
     164 * Les cles du tableau correspondent au nom des champs en base de donnees.
     165 *
     166 * @uses action_serveur_informer_boussole_dist()
     167
     168 * @note
     169 *              Les cas d'erreur retournés par cette fonction sont :
     170 *
     171 *              - ceux de l'action action_serveur_informer_boussole_dist` si le serveur est actif,
     172 *              - la réponse du serveur est invalide ou le serveur est inactif.
     173 *
     174 * @param string $boussole
     175 *              Alias de la boussole
     176 * @param string $serveur
     177 *              Nom du serveur fournissant les données sur la boussole
     178 * @return array
     179 *              Tableau décrivant le statut des traitements effectués :
     180 *
     181 *              - index 0 : `true` ou `false`,
     182 *              - index 1 : identifiant du message en cas d'erreur. Pour construire l'item de langue associé,
     183 *                                      il faut que l'appelant préfixe l'identifiant par la chaine `message_nok_`.
    159184 */
    160185function phraser_xml_boussole($boussole, $serveur='spip') {
  • _plugins_/boussole/trunk/inc/informer_plugin.php

    r75196 r75199  
    1010
    1111/**
    12  * Récupération des informations d'un plugin connu par son préfixe.
     12 * Récupération des informations d'un plugin désigné par son préfixe.
    1313 *
    14  * Cette fonction reloade systématiquement le cache des plugins afin d'être sur
     14 * Cette fonction recharge systématiquement le cache des plugins afin d'être sur
    1515 * de lire les informations à jour.
    1616 *
    1717 * @todo
    18  *              Elle pourrait être avantageusement remplacé par le filtre SPIP info_plugin() si
    19  *              celui-ci pouvait forcer la relecture du XML (ajout d'un argument reload suffirait).
     18 *              Cette fonction pourrait être avantageusement remplacée par le filtre SPIP `info_plugin()` si
     19 *              celui-ci pouvait forcer la relecture du XML. Il suffit pour cela de propager l'argument
     20 *              `$reload` de la fonction `get_infos()` de base.
    2021 *
    2122 * @param $prefixe
  • _plugins_/boussole/trunk/inc/serveur.php

    r75195 r75199  
    11<?php
     2/**
     3 * Ce fichier contient l'API de gestion des caches des boussoles hébergées par le site serveur.
     4 *
     5 * @package SPIP\BOUSSOLE\Serveur\Cache
     6 */
    27
    38if (!defined("_ECRIRE_INC_VERSION")) return;
    49
     10
    511if (!defined('_BOUSSOLE_PATTERN_SHA'))
    6         /** Pattern pour insérer le sha du XML calculé à posteriori dans le cache */
     12        /**
     13         * Pattern permettant d'insérer le sha256 calculé à partir du XML d'origine d'une boussole
     14         * dans le cache produit */
    715        define('_BOUSSOLE_PATTERN_SHA', '%sha_contenu%');
    816
     
    1220 * de ces boussoles.
    1321 *
    14  * @package SPIP\BOUSSOLE\Serveur\Cache
    1522 * @api
    16  *
    17  * @return bool
     23 * @uses boussole_cacher_xml()
     24 * @uses boussole_cacher_liste()
     25 *
     26 * @return void
    1827 */
    1928function boussole_actualiser_caches() {
     
    2736        }
    2837
    29 
    3038        // Acquisition de la liste des boussoles disponibles sur le serveur.
    3139        // (on sait déjà que le mode serveur est actif)
     
    4351                boussole_cacher_liste($boussoles);
    4452        }
    45 
    46         return true;
    4753}
    4854
     
    5258 * Ce cache est renvoyé sur l'action serveur_informer_boussole
    5359 *
    54  * @package     SPIP\BOUSSOLE\Serveur\Cache
    5560 * @api
    5661 *
    5762 * @param string        $alias
    5863 * @param string        $prefixe_plugin
    59  *
    6064 * @return bool
    6165 */
     
    98102 * Ce cache est renvoyé sur l'action serveur_lister_boussoles
    99103 *
    100  * @package     SPIP\BOUSSOLE\Serveur\Cache
    101104 * @api
    102105 *
     
    196199/**
    197200 * Lecture du xml non traduit (donc issu d'un plugin) et génération du xml traduit et incluant les logos
    198 
     201 *
    199202 * @package     SPIP\BOUSSOLE\Serveur\Cache
    200203 *
     
    202205 * @param string        $alias_boussole
    203206 * @param string        $prefixe_plugin
    204  *
    205207 * @return bool
    206208 */
Note: See TracChangeset for help on using the changeset viewer.