From 87b49ff1fb4ff42862296df94b3ecd570f68ca7b Mon Sep 17 00:00:00 2001 From: "marcimat@rezo.net" <> Date: Thu, 9 Aug 2012 21:20:43 +0000 Subject: [PATCH] Du PHP Doc sur une partie de SVP --- exec/admin_plugin.php | 40 +++++++++++++++++--- formulaires/charger_plugin.php | 41 +++++++++++++++++++++ formulaires/charger_plugin_archive.php | 32 +++++++++++++++- formulaires/editer_depot.php | 51 ++++++++++++++++++++++++-- genie/svp_actualiser_depots.php | 19 ++++++++++ genie/svp_taches_generales_cron.php | 32 ++++++++++++++-- 6 files changed, 201 insertions(+), 14 deletions(-) diff --git a/exec/admin_plugin.php b/exec/admin_plugin.php index 7655d25..1cd2a0a 100644 --- a/exec/admin_plugin.php +++ b/exec/admin_plugin.php @@ -10,11 +10,24 @@ * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. * \***************************************************************************/ +/** + * Surcharge de la page admin_plugin de SPIP + * + * Ce fichier est laissé en PHP pour de sombres histoires de redirections + * lors de l'approche d'un timeout au moment de l'installation ou de + * mise à jour de plugin. + * + * @plugin SVP pour SPIP + * @license GPL + * @package Plugins\SVP\Actions + */ if (!defined('_ECRIRE_INC_VERSION')) return; include_spip('inc/presentation'); -// http://doc.spip.org/@exec_admin_plugin_dist +/** + * Affichage de la page de gestion des plugins + */ function exec_admin_plugin_dist() { if (!autoriser('configurer', 'plugins')) { @@ -117,17 +130,32 @@ function exec_admin_plugin_dist() { } - +/** + * Retourne un texte des actions realisées s'il y en a eu tel que + * activation, désactivation, téléchargement de plugins... + * + * Nettoie au passage le fichier de cache décrivant les actions faites + * (ou encore à faire) dans les cas suivant : + * - il n'y a plus d'action + * - le nettoyage est expressement demandé par la commande 'nettoyer_actions' + * dans l'URL (ce lien est justement disponible si l'auteur des actions + * tombe sur cette page alors qu'il reste des actions à faire, ce qui + * signale en général un problème) + * + * @return string + * Code HTML présentant les actions réalisées + * Vide si rien ne s'est passé ! +**/ function svp_presenter_actions_realisees() { // presenter les traitements realises... si tel est le cas... include_spip('inc/svp_actionner'); $actionneur = new Actionneur(); - + // s'il ne reste aucune action a faire ou si on force un nettoyage. if (_request('nettoyer_actions')) { $actionneur->nettoyer_actions(); } - + $actionneur->get_actions(); $pres = $actionneur->presenter_actions($fin = true); @@ -135,7 +163,7 @@ function svp_presenter_actions_realisees() { if (!$actionneur->est_verrouille() OR !count($actionneur->end)) { $actionneur->nettoyer_actions(); } - + return $pres; - + } diff --git a/formulaires/charger_plugin.php b/formulaires/charger_plugin.php index 958fa60..d81240b 100644 --- a/formulaires/charger_plugin.php +++ b/formulaires/charger_plugin.php @@ -1,7 +1,22 @@ _request('phrase'), @@ -14,6 +29,23 @@ function formulaires_charger_plugin_charger_dist(){ '_todo' => _request('_todo')); } +/** + * Vérification du formulaire de recherche et téléchargement de plugins + * + * Appelle le décideur qui détermine la liste des actions à faire et si celles-ci + * peuvent être faites (dépendances connues). Une erreur sera levé dans le + * cas contraire. + * + * Si toutes les actions peuvent être faites, une demande de confirmation + * est envoyée (dans une erreur spéciale), présentant alors toutes les + * actions qui seront réalisées (celle demandée + celles à faire par voie + * de conséquence. + * + * Si on reçoit une demande de confirmation, on sort sans lever d'erreur ! + * + * @return array + * Liste des erreurs +**/ function formulaires_charger_plugin_verifier_dist(){ $erreurs = array(); @@ -63,6 +95,15 @@ function formulaires_charger_plugin_verifier_dist(){ return $erreurs; } +/** + * Traitement du formulaire de recherche et téléchargement de plugins + * + * Si une action est validée, on redirige de formulaire sur l'action 'actionner' + * qui les traitera une par une. + * + * @return array + * Retours du traitement +**/ function formulaires_charger_plugin_traiter_dist(){ $retour = array(); diff --git a/formulaires/charger_plugin_archive.php b/formulaires/charger_plugin_archive.php index ddd37ce..cd5816c 100644 --- a/formulaires/charger_plugin_archive.php +++ b/formulaires/charger_plugin_archive.php @@ -1,7 +1,21 @@ '', @@ -9,6 +23,15 @@ function formulaires_charger_plugin_archive_charger_dist() { ); } +/** + * Vérifications du formulaire de téléchargement de plugin + * + * Vérifie qu'une archive est saisie, et si la destination existe + * demande à confirmer l'écrasement + * + * @return array + * Liste des erreurs +**/ function formulaires_charger_plugin_archive_verifier_dist(){ include_spip('inc/plugin'); // _DIR_PLUGINS_AUTO $erreurs = array(); @@ -38,7 +61,14 @@ function formulaires_charger_plugin_archive_verifier_dist(){ return $erreurs; } - +/** + * Traitement du formulaire de téléchargement de plugin + * + * Télécharge le plugin via le téléporteur et rend la main. + * + * @return array + * Retours du traitement +**/ function formulaires_charger_plugin_archive_traiter_dist(){ $retour = array(); diff --git a/formulaires/editer_depot.php b/formulaires/editer_depot.php index 93bd50c..d24c169 100644 --- a/formulaires/editer_depot.php +++ b/formulaires/editer_depot.php @@ -1,25 +1,70 @@ \ No newline at end of file +?> diff --git a/genie/svp_actualiser_depots.php b/genie/svp_actualiser_depots.php index d45006f..a339f71 100644 --- a/genie/svp_actualiser_depots.php +++ b/genie/svp_actualiser_depots.php @@ -1,6 +1,25 @@