Changeset 75208 in spip-zone


Ignore:
Timestamp:
Sep 1, 2013, 6:55:08 PM (6 years ago)
Author:
eric@…
Message:

Mise au point du PHPDoc des actions client

Location:
_plugins_/boussole/trunk
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/action/client_actualiser_boussoles.php

    r75083 r75208  
    11<?php
     2/**
     3 * Ce fichier contient l'action `client_actualiser_boussoles` utilisée par un site client pour
     4 * actualiser l'ensemble des boussoles installées.
     5 *
     6 * @package SPIP\BOUSSOLE\Serveur\Action
     7 */
     8
    29if (!defined('_ECRIRE_INC_VERSION')) return;
    310
    411/**
    5  * Action de génération des caches des boussoles hébergées et de la liste de ces boussoles
     12 * Cette action permet au site client d'actualiser l'ensemble des boussoles insérées dans
     13 * sa base de données.
    614 *
     15 * Cette action est réservée aux webmestres. Elle nécessite un seul argument dont la valeur
     16 * est toujours égale à "tout".
     17 * L'action est utilisée par le CRON journalier du client ou sur demande depuis la page
     18 * d'administration du client de l'espace privé.
     19 *
     20 * @note
     21 *              Aucun argument n'est en fait nécessaire. Néanmoins, étant donné le bug de la balise
     22 *              `#URL_ACTION_AUTEUR` uniquement corrigé dans la version 3.0.12, il est nécessaire
     23 *              d'en passer un bidon. On s'en sert donc proprement en passant l'argument "tout"
     24 *              et en le testant.
     25 *
     26 * @uses boussole_actualiser_boussoles()
     27 *
     28 * @return void
    729 */
    830function action_client_actualiser_boussoles_dist(){
    931
    10         // Securisation: aucun argument attendu, néanmoins étant donné le bug la balise
     32        // Securisation: aucun argument attendu, néanmoins étant donné le bug de la balise
    1133        // #URL_ACTION_AUTEUR, il est nécessaire d'en passer un bidon.
    1234        // On s'en sert donc proprement en passant l'argument "tout" et en le testant
  • _plugins_/boussole/trunk/action/client_retirer_serveur.php

    r75195 r75208  
    11<?php
     2/**
     3 * Ce fichier contient l'action `client_retirer_serveur` utilisée par un site client pour
     4 * retirer un serveur donné de la liste des serveurs consultables.
     5 *
     6 * @package SPIP\BOUSSOLE\Serveur\Action
     7 */
    28
    3 if (!defined("_ECRIRE_INC_VERSION")) return;
     9if (!defined('_ECRIRE_INC_VERSION')) return;
    410
    511/**
    6  * Action de retrait d'un serveur de la liste des serveurs accessibles
    7  * par le site client
    8  * *
    9  * @package SPIP\BOUSSOLE\Client\Action
     12 * Cette action permet au site client de retirer un serveur donné de sa liste des serveurs
     13 * qu'il est autorisé à interroger (variable de configuration).
     14 *
     15 * Cette action est réservée aux webmestres. Elle nécessite un seul argument, le nom du serveur
     16 * à retirer.
     17 *
     18 * @uses boussole_actualiser_boussoles()
    1019 *
    1120 * @return void
  • _plugins_/boussole/trunk/action/client_supprimer_boussole.php

    r75083 r75208  
    11<?php
     2/**
     3 * Ce fichier contient l'action `client_supprimer_boussole` utilisée par un site client pour
     4 * supprimer de façon sécurisée une boussole donnée.
     5 *
     6 * @package SPIP\BOUSSOLE\Serveur\Action
     7 */
    28
    3 if (!defined("_ECRIRE_INC_VERSION")) return;
     9if (!defined('_ECRIRE_INC_VERSION')) return;
    410
    511/**
    6  * Action de suppression en base de donnees de la boussole
     12 * Cette action permet au site client de supprimer de sa base de données, de façon sécurisée,
     13 * une boussole donnée.
    714 *
     15 * Cette action est réservée aux webmestres. Elle nécessite un seul argument,
     16 * l'alias de la boussole.
     17 *
     18 * @uses boussole_actualiser_boussoles()
     19 *
     20 * @return void
    821 */
    922function action_client_supprimer_boussole_dist(){
  • _plugins_/boussole/trunk/action/serveur_informer_boussole.php

    r75207 r75208  
    55 *
    66 * @package SPIP\BOUSSOLE\Serveur\Action
    7  *
    87 */
    98
  • _plugins_/boussole/trunk/genie/boussole_actualiser_client.php

    r75083 r75208  
    22if (!defined("_ECRIRE_INC_VERSION")) return;
    33
     4/**
     5 *
     6 * @uses action_client_actualiser_boussoles_dist()
     7 *
     8 * @param $last
     9 * @return int
     10 */
    411function genie_boussole_actualiser_client_dist($last) {
    512
Note: See TracChangeset for help on using the changeset viewer.