Changeset 64676 in spip-zone


Ignore:
Timestamp:
Aug 10, 2012, 7:31:54 AM (7 years ago)
Author:
marcimat@…
Message:

Du PHP Doc sur une partie de SVP

Location:
_core_/plugins/svp/formulaires
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/svp/formulaires/admin_plugin.php

    r64251 r64676  
    11<?php
    22
     3/**
     4 * Gestion du formulaire de gestion des plugins
     5 *
     6 * @plugin SVP pour SPIP
     7 * @license GPL
     8 * @package Plugins\SVP\Formulaires
     9 */
     10 
    311if (!defined("_ECRIRE_INC_VERSION")) return;
    412
     13/**
     14 * Chargement du formulaire de gestion des plugins
     15 *
     16 * @param string $voir
     17 *     Statut des plugins que l'on souhaite voir : actif, inactif, tous
     18 * @param string $verrouille
     19 *     Types de plugins que l'on souhaite voir :
     20 *     - 'non' : les plugins utilisateurs
     21 *     - 'oui' : les plugins verrouillés (plugins-dist)
     22 *     - 'tous' : les deux !
     23 * @param string|int $id_paquet
     24 *     Identifiant du paquet dont on veut obtenir une description complète
     25 *     lors de l'affichage du formulaire
     26 * @param string $redirect
     27 *     URL de redirection après les traitements
     28 * @return array
     29 *     Environnement du formulaire
     30**/
    531function formulaires_admin_plugin_charger_dist($voir='actif', $verrouille='non', $id_paquet='',$redirect=''){
    632        $valeurs = array();
     
    3359}
    3460
     61/**
     62 * Vérifications du formulaire de gestion des plugins
     63 *
     64 * Appelle le décideur qui détermine la liste des actions à faire et si celles-ci
     65 * peuvent être faites (dépendances connues). Une erreur sera levé dans le
     66 * cas contraire.
     67 *
     68 * Si toutes les actions peuvent être faites, une demande de confirmation
     69 * est envoyée (dans une erreur spéciale), présentant alors toutes les
     70 * actions qui seront réalisées (celle demandée + celles à faire par voie
     71 * de conséquence.
     72 *
     73 * Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
     74 *
     75 * @param string $voir
     76 *     Statut des plugins que l'on souhaite voir : actif, inactif, tous
     77 * @param string $verrouille
     78 *     Types de plugins que l'on souhaite voir :
     79 *     - 'non' : les plugins utilisateurs
     80 *     - 'oui' : les plugins verrouillés (plugins-dist)
     81 *     - 'tous' : les deux !
     82 * @param string|int $id_paquet
     83 *     Identifiant du paquet dont on veut obtenir une description complète
     84 *     lors de l'affichage du formulaire
     85 * @param string $redirect
     86 *     URL de redirection après les traitements
     87 * @return array
     88 *     Tableau des erreurs
     89**/
    3590function formulaires_admin_plugin_verifier_dist($voir='actif', $verrouille='non', $id_paquet='',$redirect=''){
    3691
     
    84139}
    85140
     141/**
     142 * Traitement du formulaire de gestion des plugins
     143 *
     144 * Si une liste d'action est validée, on redirige de formulaire sur
     145 * l'action 'actionner' qui les traitera une par une.
     146 *
     147 * @param string $voir
     148 *     Statut des plugins que l'on souhaite voir : actif, inactif, tous
     149 * @param string $verrouille
     150 *     Types de plugins que l'on souhaite voir :
     151 *     - 'non' : les plugins utilisateurs
     152 *     - 'oui' : les plugins verrouillés (plugins-dist)
     153 *     - 'tous' : les deux !
     154 * @param string|int $id_paquet
     155 *     Identifiant du paquet dont on veut obtenir une description complète
     156 *     lors de l'affichage du formulaire
     157 * @param string $redirect
     158 *     URL de redirection après les traitements
     159 * @return array
     160 *     Retours du traitement
     161**/
    86162function formulaires_admin_plugin_traiter_dist($voir='actif', $verrouille='non', $id_paquet='',$redirect=''){
    87163       
     
    97173                svp_actionner_traiter_actions_demandees($actions, $retour,$redirect);
    98174        }
    99                
     175
    100176        $retour['editable'] = true;
    101177        return $retour;
     
    103179
    104180/**
    105  * Filtre pour simplifier la creation des actions du formulaire
    106  * [(#ID_PAQUET|svp_nom_action{desactiver})]
    107  * actions[desactiver][24]
     181 * Crée une valeur d'action pour l'attribut 'name' d'une saisie de formulaire
     182 *
     183 * @example
     184 *     [(#ID_PAQUET|svp_nom_action{on})]
     185 *     écrit : actions[on][24]
     186 * @param int $id_paquet
     187 *     Identifiant du paquet
     188 * @param string $action
     189 *     Une action possible (on, off, stop, up, on, upon, kill)
    108190**/
    109191function filtre_svp_nom_action($id_paquet, $action) {
  • _core_/plugins/svp/formulaires/ajouter_depot.php

    r57482 r64676  
    11<?php
    22
     3/**
     4 * Gestion du formulaire d'ajout de dépot
     5 *
     6 * @plugin SVP pour SPIP
     7 * @license GPL
     8 * @package Plugins\SVP\Formulaires
     9 */
     10 
    311if (!defined("_ECRIRE_INC_VERSION")) return;
    412
    5 
     13/**
     14 * Chargement du formulaire d'ajout de dépot
     15 *
     16 * @return array
     17 *     Environnement du formulaire
     18**/
    619function formulaires_ajouter_depot_charger_dist(){
    720        // On ne renvoie pas les valeurs saisies mais on fait un raz systematique
     
    922}
    1023
     24/**
     25 * Vérifications du formulaire d'ajout de dépot
     26 *
     27 * Vérifie qu'une adresse valide est soumise et que ce dépot n'a pas
     28 * déjà été créé.
     29 *
     30 * @return array
     31 *     Tableau des erreurs
     32**/
    1133function formulaires_ajouter_depot_verifier_dist(){
    1234       
     
    2951}
    3052
     53/**
     54 * Traitement du formulaire d'ajout de dépot
     55 *
     56 * Ajoute le dépot.
     57 * Retourne une éventuelle erreur si le dépot a un XML mal formé
     58 * ou s'il n'a aucun plugin.
     59 *
     60 * @return array
     61 *     Retours du traitement
     62**/
    3163function formulaires_ajouter_depot_traiter_dist(){
    3264        include_spip('inc/svp_depoter_distant');
     
    5587
    5688/**
    57  * Teste la validite d'une url d'un depot de paquets
     89 * Teste la validité d'une URL d'un dépot de paquets
    5890 *
     91 * Pour cela on tente de rapatrier le fichier distant
     92 * en local. Si on réussi, c'est bon.
     93 *
    5994 * @param string $url
    60  * @return boolean
     95 *     URL du fichier xml de description du depot
     96 * @return bool
     97 *     Le dépot est-il valide ?
    6198 */
    62 
    63 // $url => url du fichier xml de description du depot
    6499function svp_verifier_adresse_depot($url){
    65100        include_spip('inc/distant');
  • _core_/plugins/svp/formulaires/charger_plugin.php

    r64671 r64676  
    4545 *
    4646 * @return array
    47  *     Liste des erreurs
     47 *     Tableau des erreurs
    4848**/
    4949function formulaires_charger_plugin_verifier_dist(){
     
    9999 * Traitement du formulaire de recherche et téléchargement de plugins
    100100 *
    101  * Si une action est validée, on redirige de formulaire sur l'action 'actionner'
    102  * qui les traitera une par une.
     101 * Si une liste d'action est validée, on redirige de formulaire sur
     102 * l'action 'actionner' qui les traitera une par une.
    103103 *
    104104 * @return array
  • _core_/plugins/svp/formulaires/charger_plugin_archive.php

    r64671 r64676  
    3131 *
    3232 * @return array
    33  *     Liste des erreurs
     33 *     Tableau des erreurs
    3434**/
    3535function formulaires_charger_plugin_archive_verifier_dist(){
  • _core_/plugins/svp/formulaires/editer_depot.php

    r64671 r64676  
    3636 *     URL de redirection
    3737 * @return array
    38  *     Liste des erreurs
     38 *     Tableau des erreurs
    3939**/
    4040function formulaires_editer_depot_verifier_dist($id_depot, $redirect){
Note: See TracChangeset for help on using the changeset viewer.