Du PHP Doc sur une partie de SVP

spip-3.0
marcimat@rezo.net 11 years ago
parent 5c1fa2b701
commit 87b49ff1fb

@ -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;
}

@ -1,7 +1,22 @@
<?php
/**
* Gestion du formulaire de recherche et téléchargement de plugins
* distants connus dans un dépot
*
* @plugin SVP pour SPIP
* @license GPL
* @package Plugins\SVP\Formulaires
*/
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Chargement du formulaire de recherche et téléchargement de plugins
*
* @return array
* Environnement du formulaire
**/
function formulaires_charger_plugin_charger_dist(){
return array(
'phrase' => _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();

@ -1,7 +1,21 @@
<?php
/**
* Gestion du formulaire de téléchargement de plugin via une URL
*
* @plugin SVP pour SPIP
* @license GPL
* @package Plugins\SVP\Formulaires
*/
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Chargement du formulaire de téléchargement de plugin
*
* @return array
* Environnement du formulaire
**/
function formulaires_charger_plugin_archive_charger_dist() {
return array(
'archive' =>'',
@ -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();

@ -1,25 +1,70 @@
<?php
/**
* Gestion du formulaire d'édition de dépot
*
* @plugin SVP pour SPIP
* @license GPL
* @package Plugins\SVP\Formulaires
*/
if (!defined("_ECRIRE_INC_VERSION")) return;
include_spip('inc/editer');
// http://doc.spip.org/@inc_editer_article_dist
/**
* Chargement du formulaire d'édition de dépot
*
* @param int $id_depot
* Identifiant du dépot
* @param string $redirect
* URL de redirection
* @return array
* Environnement du formulaire
**/
function formulaires_editer_depot_charger_dist($id_depot, $redirect){
$valeurs = formulaires_editer_objet_charger('depot', $id_depot, 0, 0, $redirect, 'depots_edit_config');
return $valeurs;
}
/**
* Vérification du formulaire d'édition de dépot
*
* @param int $id_depot
* Identifiant du dépot
* @param string $redirect
* URL de redirection
* @return array
* Liste des erreurs
**/
function formulaires_editer_depot_verifier_dist($id_depot, $redirect){
$erreurs = formulaires_editer_objet_verifier('depot', $id_depot, array('titre'));
return $erreurs;
}
// http://doc.spip.org/@inc_editer_article_dist
/**
* Traitement du formulaire d'édition de dépot
*
* @param int $id_depot
* Identifiant du dépot
* @param string $redirect
* URL de redirection
* @return array
* Retours du traitement
**/
function formulaires_editer_depot_traiter_dist($id_depot, $redirect){
return formulaires_editer_objet_traiter('depot', $id_depot, 0, 0, $redirect);
}
/**
* Préparation des configurations particulières du formulaire d'édition de dépot
*
* @param array $row
* Données SQL actuelles de l'objet qui va être édité
* @return array
* Tableau de configurations qui seront ajoutés à l'environnement
* du formulaire sous la clé 'config'
**/
function depots_edit_config($row)
{
global $spip_ecran, $spip_lang;
@ -30,4 +75,4 @@ function depots_edit_config($row)
return $config;
}
?>
?>

@ -1,6 +1,25 @@
<?php
/**
* Gestion du génie svp_actualiser_depots
*
* @plugin SVP pour SPIP
* @license GPL
* @package Plugins\SVP\Genie
*/
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Actualise tous les dépots
*
* @genie svp_actualiser_depots
*
* @param int $last
* Timestamp de la dernière exécution de cette tâche
* @return int
* Positif : la tâche a été effectuée
*/
function genie_svp_actualiser_depots_dist ($last) {
include_spip('inc/svp_depoter_distant');

@ -1,19 +1,43 @@
<?php
/**
* Déclaration des tâches du génie
*
* @plugin SVP pour SPIP
* @license GPL
* @package Plugins\SVP\Genie
*/
if (!defined("_ECRIRE_INC_VERSION")) return;
// Mise a jour automatique des depots (CRON)
// - Flag de declenchement
if (!defined('_SVP_CRON_ACTUALISATION_DEPOTS')) {
/**
* Mise a jour automatique des depots (CRON)
* true pour autoriser les actualisations automatique
* @var bool
*/
define('_SVP_CRON_ACTUALISATION_DEPOTS', true);
}
// - Periode d'actualisation en nombre d'heures (de 1 a 24)
if (!defined('_SVP_PERIODE_ACTUALISATION_DEPOTS')) {
/**
* Période d'actualisation en nombre d'heures (de 1 a 24)
* @var int
*/
define('_SVP_PERIODE_ACTUALISATION_DEPOTS', 6);
}
/**
* Ajoute la tâche d'actualisation des dépots dans la liste des tâches périodiques
*
* @pipelined taches_generales_cron
*
* @param array $taches_generales
* Tableau des tâches et leur périodicité en seconde
* @return array
* Tableau des tâches et leur périodicité en seconde
*/
function svp_taches_generales_cron($taches_generales) {
// Ajout de la tache CRON de mise a jour reguliere de tous les depots de la base

Loading…
Cancel
Save