Du PHP Doc sur une partie de SVP

+ suppression d'une action qui n'a jamais servi !

action/actionner.php

@@ -1,7 +1,21 @@
 <?php
 
+/**
+ * Gestion de l'action actionner
+ *
+ * @plugin SVP pour SPIP
+ * @license GPL
+ * @package Plugins\SVP\Actions
+ */
+ 
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
+/**
+ * Action effectuant 1 action dans la liste des actions à réaliser
+ * sur les plugins.
+ *
+ * Cette action sera relancée tant qu'il reste des actions à faire
+ */
 function action_actionner_dist() {
 	// droits
 	include_spip('inc/autoriser');

action/actualiser_depot.php

@@ -1,7 +1,15 @@
 <?php
 /**
- * Action de mises a jour en base de donnees des plugins du depot
+ * Gestion de l'action actualiser_depot
  *
+ * @plugin SVP pour SPIP
+ * @license GPL
+ * @package Plugins\SVP\Actions
+ */
+ 
+/**
+ * Action de mise à jour en base de données de la liste des plugins
+ * d'un ou de tous les dépots
  */
 function action_actualiser_depot_dist(){
 
@@ -37,4 +45,4 @@ function action_actualiser_depot_dist(){
 	}
 }
 
-?>
+?>

action/charger_plugins.php

@@ -1,29 +0,0 @@
-<?php
-if (!defined("_ECRIRE_INC_VERSION")) return;
-
-/**
- * Fonction qui 
- * @return 
- */
-function action_charger_plugins_dist() {
-	// Securisation: aucun argument attendu
-
-	include_spip('inc/minipres');
-	// Autorisation
-	if(!autoriser('webmestre')) {
-		echo minipres();
-		exit;
-	}
-
-	$plugins = _request('a_installer');
-	$logs = array();
-	foreach ($plugins as $_plugin) {
-		continue;
-	}
-	
-	include_spip('exec/install');
-	echo minipres('Resultats installation', generer_form_ecrire('admin_plugin&voir=tous', serialize($logs) . bouton_suivant()));
-
-	exit;
-}
-?>

action/editer_depot.php

@@ -10,8 +10,21 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion de l'action editer_depot
+ *
+ * @plugin SVP pour SPIP
+ * @license GPL
+ * @package Plugins\SVP\Actions
+ */
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
+/**
+ * Action de mise à jour des descriptions d'un dépot 
+ *
+ * @return array
+ *     Liste identifiant du dépot, texte d'erreur éventuel
+**/
 function action_editer_depot_dist() {
 
 	$securiser_action = charger_fonction('securiser_action', 'inc');
@@ -52,9 +65,19 @@ function action_editer_depot_dist() {
 	return array($id_depot, $err);
 }
 
-// Appelle toutes les fonctions de modification d'un depot
-// $err est de la forme '&trad_err=1'
-// Cette fonction ne fait rien actuellement sur un depot
+
+/**
+ * Appelle toutes les fonctions de modification d'un dépot
+ * $err est de la forme '&trad_err=1'
+ *
+ * @note
+ *     Cette fonction ne fait rien actuellement !!
+ * 
+ * @param int $id_depot
+ *     Identifiant du dépot
+ * @return string
+ *     Texte d'une eventuelle erreur
+**/
 function depots_set($id_depot) {
 	$err = '';
 
@@ -70,4 +93,4 @@ function depots_set($id_depot) {
 	return $err;
 }
 
-?>
+?>

action/supprimer_depot.php

@@ -1,7 +1,16 @@
 <?php
 /**
- * Action de suppression en base de donnees du depot et de ses plugins
+ * Gestion de l'action supprimer_depot
  *
+ * @plugin SVP pour SPIP
+ * @license GPL
+ * @package Plugins\SVP\Actions
+ */
+ 
+/**
+ * Action de suppression en base de données d'un dépot et de ses plugins
+ *
+ * @return void
  */
 function action_supprimer_depot_dist(){
 
@@ -24,4 +33,4 @@ function action_supprimer_depot_dist(){
 	}
 }
 
-?>
+?>

action/teleporter.php

@@ -1,22 +1,28 @@
 <?php
 /**
- * Plugin S.P
- * Licence IV
- * (c) 2011 vers l'infini et au dela
+ * Gestion de l'action teleporter
+ *
+ * @plugin SVP pour SPIP
+ * @license GPL
+ * @package Plugins\SVP\Actions
  */
+ 
 
 /**
- * Teleporter et deballer un composant
+ * Téléporter et déballer un composant
+ * 
  * @param string $methode
  *   http|git|svn|...
  * @param string $source
- *   url source du composant
+ *   URL source du composant
  * @param string $dest
- *   chemin du repertoire ou deballer le composant. Inclus le dernier segment
+ *   Chemin du répertoire où déballer le composant. Inclus le dernier segment
  * @param array $options
  *   revision => ''
  *   --ignore-externals
- * @return bool\string
+ * @return bool|string
+ *   String : texte d'une erreur
+ *   true si l'opération est correctement réalisée
  */
 function action_teleporter_composant_dist($methode,$source,$dest,$options=array()){
 
@@ -45,10 +51,12 @@ function action_teleporter_composant_dist($methode,$source,$dest,$options=array(
 
 
 /**
- * Verifier et preparer l'arborescence jusqu'au repertoire parent
+ * Vérifier et préparer l'arborescence jusqu'au répertoire parent
  *
  * @param string $dest
  * @return bool|string
+ *     false en cas d'échec
+ *     Chemin du répertoire sinon
  */
 function teleporter_verifier_destination($dest){
 	$dest = rtrim($dest,"/");
@@ -74,6 +82,19 @@ function teleporter_verifier_destination($dest){
 	return $base."/$final";
 }
 
+/**
+ * Déplace un répertoire pour libérer l'emplacement.
+ *
+ * Si le répertoire donné existe, le déplace dans un répertoire de backup.
+ * Si ce backup existe déjà, il est supprimé auparavant.
+ * Retourne le nouveau chemin du répertoire.
+ * 
+ * @param string $dest
+ *     Chemin du répertoire à déplacer
+ * @return string
+ *     Nouveau chemin du répertoire s'il existait,
+ *     Chaîne vide sinon
+**/
 function teleporter_nettoyer_vieille_version($dest){
 	$old = "";
 	if (is_dir($dest)){