Changeset 64671 in spip-zone


Ignore:
Timestamp:
Aug 9, 2012, 9:20:43 PM (7 years ago)
Author:
marcimat@…
Message:

Du PHP Doc sur une partie de SVP

Location:
_core_/plugins/svp
Files:
6 edited

Legend:

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

    r62211 r64671  
    1111\***************************************************************************/
    1212
     13/**
     14 * Surcharge de la page admin_plugin de SPIP
     15 *
     16 * Ce fichier est laissé en PHP pour de sombres histoires de redirections
     17 * lors de l'approche d'un timeout au moment de l'installation ou de
     18 * mise à jour de plugin.
     19 *
     20 * @plugin SVP pour SPIP
     21 * @license GPL
     22 * @package Plugins\SVP\Actions
     23 */
    1324if (!defined('_ECRIRE_INC_VERSION')) return;
    1425
    1526include_spip('inc/presentation');
    1627
    17 // http://doc.spip.org/@exec_admin_plugin_dist
     28/**
     29 * Affichage de la page de gestion des plugins
     30 */
    1831function exec_admin_plugin_dist() {
    1932
     
    118131
    119132
    120 
     133/**
     134 * Retourne un texte des actions realisées s'il y en a eu tel que
     135 * activation, désactivation, téléchargement de plugins...
     136 *
     137 * Nettoie au passage le fichier de cache décrivant les actions faites
     138 * (ou encore à faire) dans les cas suivant :
     139 * - il n'y a plus d'action
     140 * - le nettoyage est expressement demandé par la commande 'nettoyer_actions'
     141 *   dans l'URL (ce lien est justement disponible si l'auteur des actions
     142 *   tombe sur cette page alors qu'il reste des actions à faire, ce qui
     143 *   signale en général un problème)
     144 *
     145 * @return string
     146 *     Code HTML présentant les actions réalisées
     147 *     Vide si rien ne s'est passé !
     148**/
    121149function svp_presenter_actions_realisees() {
    122150        // presenter les traitements realises... si tel est le cas...
    123151        include_spip('inc/svp_actionner');
    124152        $actionneur = new Actionneur();
    125        
     153
    126154        // s'il ne reste aucune action a faire ou si on force un nettoyage.
    127155        if (_request('nettoyer_actions')) {
    128156                $actionneur->nettoyer_actions();
    129157        }
    130        
     158
    131159        $actionneur->get_actions();
    132160        $pres = $actionneur->presenter_actions($fin = true);
     
    136164                $actionneur->nettoyer_actions();
    137165        }
    138                
     166
    139167        return $pres;
    140        
     168
    141169}
  • _core_/plugins/svp/formulaires/charger_plugin.php

    r57293 r64671  
    11<?php
    22
     3/**
     4 * Gestion du formulaire de recherche et téléchargement de plugins
     5 * distants connus dans un dépot
     6 *
     7 * @plugin SVP pour SPIP
     8 * @license GPL
     9 * @package Plugins\SVP\Formulaires
     10 */
     11 
    312if (!defined("_ECRIRE_INC_VERSION")) return;
    413
     14/**
     15 * Chargement du formulaire de recherche et téléchargement de plugins
     16 *
     17 * @return array
     18 *     Environnement du formulaire
     19**/
    520function formulaires_charger_plugin_charger_dist(){
    621        return array(
     
    1530}
    1631
     32/**
     33 * Vérification du formulaire de recherche et téléchargement de plugins
     34 *
     35 * Appelle le décideur qui détermine la liste des actions à faire et si celles-ci
     36 * peuvent être faites (dépendances connues). Une erreur sera levé dans le
     37 * cas contraire.
     38 *
     39 * Si toutes les actions peuvent être faites, une demande de confirmation
     40 * est envoyée (dans une erreur spéciale), présentant alors toutes les
     41 * actions qui seront réalisées (celle demandée + celles à faire par voie
     42 * de conséquence.
     43 *
     44 * Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
     45 *
     46 * @return array
     47 *     Liste des erreurs
     48**/
    1749function formulaires_charger_plugin_verifier_dist(){
    1850
     
    6496}
    6597
     98/**
     99 * Traitement du formulaire de recherche et téléchargement de plugins
     100 *
     101 * Si une action est validée, on redirige de formulaire sur l'action 'actionner'
     102 * qui les traitera une par une.
     103 *
     104 * @return array
     105 *     Retours du traitement
     106**/
    66107function formulaires_charger_plugin_traiter_dist(){
    67108
  • _core_/plugins/svp/formulaires/charger_plugin_archive.php

    r59471 r64671  
    11<?php
    22
     3/**
     4 * Gestion du formulaire de téléchargement de plugin via une URL
     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 téléchargement de plugin
     15 *
     16 * @return array
     17 *     Environnement du formulaire
     18**/
    519function formulaires_charger_plugin_archive_charger_dist() {
    620        return array(
     
    1024}
    1125
     26/**
     27 * Vérifications du formulaire de téléchargement de plugin
     28 *
     29 * Vérifie qu'une archive est saisie, et si la destination existe
     30 * demande à confirmer l'écrasement
     31 *
     32 * @return array
     33 *     Liste des erreurs
     34**/
    1235function formulaires_charger_plugin_archive_verifier_dist(){
    1336        include_spip('inc/plugin'); // _DIR_PLUGINS_AUTO
     
    3962}
    4063
    41 
     64/**
     65 * Traitement du formulaire de téléchargement de plugin
     66 *
     67 * Télécharge le plugin via le téléporteur et rend la main.
     68 *
     69 * @return array
     70 *     Retours du traitement
     71**/
    4272function formulaires_charger_plugin_archive_traiter_dist(){
    4373        $retour = array();
  • _core_/plugins/svp/formulaires/editer_depot.php

    r41854 r64671  
    11<?php
    22
     3/**
     4 * Gestion du formulaire d'édition 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
    513include_spip('inc/editer');
    614
    7 // http://doc.spip.org/@inc_editer_article_dist
     15/**
     16 * Chargement du formulaire d'édition de dépot
     17 *
     18 * @param int $id_depot
     19 *     Identifiant du dépot
     20 * @param string $redirect
     21 *     URL de redirection
     22 * @return array
     23 *     Environnement du formulaire
     24**/
    825function formulaires_editer_depot_charger_dist($id_depot, $redirect){
    926        $valeurs = formulaires_editer_objet_charger('depot', $id_depot, 0, 0, $redirect, 'depots_edit_config');
     
    1128}
    1229
     30/**
     31 * Vérification du formulaire d'édition de dépot
     32 *
     33 * @param int $id_depot
     34 *     Identifiant du dépot
     35 * @param string $redirect
     36 *     URL de redirection
     37 * @return array
     38 *     Liste des erreurs
     39**/
    1340function formulaires_editer_depot_verifier_dist($id_depot, $redirect){
    1441        $erreurs = formulaires_editer_objet_verifier('depot', $id_depot, array('titre'));
     
    1643}
    1744
    18 // http://doc.spip.org/@inc_editer_article_dist
     45/**
     46 * Traitement du formulaire d'édition de dépot
     47 *
     48 * @param int $id_depot
     49 *     Identifiant du dépot
     50 * @param string $redirect
     51 *     URL de redirection
     52 * @return array
     53 *     Retours du traitement
     54**/
    1955function formulaires_editer_depot_traiter_dist($id_depot, $redirect){
    2056        return formulaires_editer_objet_traiter('depot', $id_depot, 0, 0, $redirect);
    2157}
    2258
     59/**
     60 * Préparation des configurations particulières du formulaire d'édition de dépot
     61 *
     62 * @param array $row
     63 *     Données SQL actuelles de l'objet qui va être édité
     64 * @return array
     65 *     Tableau de configurations qui seront ajoutés à l'environnement
     66 *     du formulaire sous la clé 'config'
     67**/
    2368function depots_edit_config($row)
    2469{
  • _core_/plugins/svp/genie/svp_actualiser_depots.php

    r59351 r64671  
    11<?php
     2
     3/**
     4 * Gestion du génie svp_actualiser_depots
     5 *
     6 * @plugin SVP pour SPIP
     7 * @license GPL
     8 * @package Plugins\SVP\Genie
     9 */
     10
    211if (!defined("_ECRIRE_INC_VERSION")) return;
    312
     13/**
     14 * Actualise tous les dépots
     15 *
     16 * @genie svp_actualiser_depots
     17 *
     18 * @param int $last
     19 *     Timestamp de la dernière exécution de cette tâche
     20 * @return int
     21 *     Positif : la tâche a été effectuée
     22 */
    423function genie_svp_actualiser_depots_dist ($last) {
    524
  • _core_/plugins/svp/genie/svp_taches_generales_cron.php

    r56066 r64671  
    11<?php
     2
     3/**
     4 * Déclaration des tâches du génie
     5 *
     6 * @plugin SVP pour SPIP
     7 * @license GPL
     8 * @package Plugins\SVP\Genie
     9 */
    210if (!defined("_ECRIRE_INC_VERSION")) return;
    311
    4 // Mise a jour automatique des depots (CRON)
    5 // - Flag de declenchement
     12
    613if (!defined('_SVP_CRON_ACTUALISATION_DEPOTS')) {
     14        /**
     15         * Mise a jour automatique des depots (CRON)
     16         * true pour autoriser les actualisations automatique
     17         * @var bool
     18         */
    719        define('_SVP_CRON_ACTUALISATION_DEPOTS', true);
    820}
    921
    10 // - Periode d'actualisation en nombre d'heures (de 1 a 24)
    1122if (!defined('_SVP_PERIODE_ACTUALISATION_DEPOTS')) {
     23        /**
     24         * Période d'actualisation en nombre d'heures (de 1 a 24)
     25         * @var int
     26         */
    1227        define('_SVP_PERIODE_ACTUALISATION_DEPOTS', 6);
    1328}
    1429
    1530
    16 
     31/**
     32 * Ajoute la tâche d'actualisation des dépots dans la liste des tâches périodiques
     33 *
     34 * @pipelined taches_generales_cron
     35 *
     36 * @param array $taches_generales
     37 *     Tableau des tâches et leur périodicité en seconde
     38 * @return array
     39 *     Tableau des tâches et leur périodicité en seconde
     40 */
    1741function svp_taches_generales_cron($taches_generales) {
    1842
Note: See TracChangeset for help on using the changeset viewer.