Ajout de PHPDoc.

c'est "@uses" et non "@use"
spip-3.1 v0.82.7
teddy.spip@gmail.com 10 years ago
parent 95545cba8c
commit 888683d674

@ -10,6 +10,7 @@
/**
* Action de suppression en base de données d'un dépot et de ses plugins
*
* @uses svp_supprimer_depot()
* @return void
*/
function action_supprimer_depot_dist(){

@ -28,10 +28,11 @@ include_spip('inc/presentation');
/**
* Affichage de la page de gestion des plugins
*
* @use actualise_plugins_actifs()
* @use svp_presenter_actions_realisees()
* @use plugin_installes_meta()
* @use plugin_donne_erreurs()
* @uses actualise_plugins_actifs()
* @uses svp_presenter_actions_realisees()
* @uses plugin_installes_meta()
* @uses plugin_donne_erreurs()
* @uses svp_vider_tables()
*
* @pipeline_appel affiche_gauche
* @pipeline_appel affiche_droite

@ -13,6 +13,7 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Chargement du formulaire de gestion des plugins
*
* @uses svp_actualiser_paquets_locaux()
* @param string $voir
* Statut des plugins que l'on souhaite voir : actif, inactif, tous
* @param string $verrouille
@ -73,6 +74,8 @@ function formulaires_admin_plugin_charger_dist($voir='actif', $verrouille='non',
*
* Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
*
* @uses svp_decider_verifier_actions_demandees()
*
* @param string $voir
* Statut des plugins que l'on souhaite voir : actif, inactif, tous
* @param string $verrouille
@ -145,6 +148,8 @@ function formulaires_admin_plugin_verifier_dist($voir='actif', $verrouille='non'
* Si une liste d'action est validée, on redirige de formulaire sur
* l'action 'actionner' qui les traitera une par une.
*
* @uses svp_actionner_traiter_actions_demandees()
*
* @param string $voir
* Statut des plugins que l'on souhaite voir : actif, inactif, tous
* @param string $verrouille

@ -27,6 +27,7 @@ function formulaires_ajouter_depot_charger_dist(){
* Vérifie qu'une adresse valide est soumise et que ce dépot n'a pas
* déjà été créé.
*
* @uses svp_verifier_adresse_depot()
* @return array
* Tableau des erreurs
**/
@ -57,6 +58,7 @@ function formulaires_ajouter_depot_verifier_dist(){
* Retourne une éventuelle erreur si le dépot a un XML mal formé
* ou s'il n'a aucun plugin.
*
* @uses svp_ajouter_depot()
* @return array
* Retours du traitement
**/

@ -43,6 +43,7 @@ function formulaires_charger_plugin_charger_dist(){
*
* Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
*
* @uses svp_decider_verifier_actions_demandees()
* @return array
* Tableau des erreurs
**/

@ -15,6 +15,7 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
*
* @genie svp_actualiser_depots
*
* @uses svp_actualiser_depot()
* @param int $last
* Timestamp de la dernière exécution de cette tâche
* @return int

@ -25,6 +25,9 @@ include_spip('inc/svp_phraser');
* Si une erreur survient (syntaxe XML incorrecte, pas de plugin dans le dépot),
* son texte est placé dans le paramètre $erreur
*
* @uses svp_phraser_depot()
* @uses svp_actualiser_paquets()
* @uses svp_base_supprimer_paquets_locaux()
* @param string $url
* URL du fichier XML de description du dépot
* @param string $erreur
@ -104,6 +107,10 @@ function svp_ajouter_depot($url, &$erreur='') {
* Cette suppression entraîne des recalcul comme les versions maximales
* des plugins téléchargeables qui peuvent changer.
*
* @uses svp_actualiser_url_plugins()
* @uses svp_nettoyer_apres_suppression()
* @uses svp_base_supprimer_paquets_locaux()
*
* @param int $id
* Identifiant du dépot
* @return bool
@ -232,6 +239,9 @@ function svp_nettoyer_apres_suppression($id_depot, $vmax) {
* Actualise les informations uniquement si la signature du fichier
* XML de description du dépot a changé
*
* @uses svp_actualiser_maj_version()
* @uses svp_actualiser_paquets()
* @uses svp_phraser_depot()
* @param int $id
* Identifiant du dépot
* @return bool
@ -303,6 +313,14 @@ function svp_actualiser_depot($id){
* Enlève de la base les paquets du dépots qui ne sont plus présents
* dans la description du XML. Ajoute ou met à jour les autres.
*
* @uses svp_supprimer_plugins_orphelins()
* @uses svp_corriger_vmax_plugins()
* @uses svp_completer_plugins()
* @uses eclater_plugin_paquet()
* @uses svp_inserer_multi()
* @uses svp_completer_plugins_depot()
* @uses svp_actualiser_url_plugins()
*
* @param int $id_depot
* Identifiant du dépot
* @param array $paquets
@ -675,6 +693,7 @@ function svp_inserer_multi(&$insert_plugins, &$insert_paquets, &$insert_contribs
* Complète les informations des plugins contenus dans un depot
* en compilant certaines informations (compatibilités, dates, branches)
*
* @uses svp_completer_plugins()
* @param int $id_depot
* Identifiant du depot à actualiser
**/
@ -691,6 +710,7 @@ function svp_completer_plugins_depot($id_depot) {
* Complète les informations des plugins, d'une liste de plugins donnés,
* en compilant certaines informations (compatibilités, dates, branches)
*
* @uses compiler_branches_spip()
* @param array $ids_plugin
* Liste d'identifiants de plugins
* @return bool

@ -24,6 +24,12 @@
* de toutes les informations locales avec var_mode=vider_paquets_locaux
* dans l'URL ou en mettant le paramètre $force à true.
*
* @uses svp_descriptions_paquets_locaux()
* @uses svp_base_supprimer_paquets_locaux()
* @uses svp_base_inserer_paquets_locaux()
* @uses svp_base_modifier_paquets_locaux()
* @uses svp_base_actualiser_paquets_actifs()
*
* @param bool $force
* - false : n'actualise que les paquets modifiés
* - true : efface et recrée la liste de tous les paquets locaux
@ -115,6 +121,9 @@ function svp_base_supprimer_paquets_locaux() {
* Actualise les informations en base sur les paquets locaux
* en ne modifiant que ce qui a changé.
*
* @uses svp_supprimer_plugins_orphelins()
* @uses svp_base_inserer_paquets_locaux()
*
* @param array $paquets_locaux
* Descriptions des paquets (intégrant un hash), stockés par
* constante, puis par chemin.
@ -181,6 +190,12 @@ function svp_base_modifier_paquets_locaux($paquets_locaux) {
* On essaie au mieux de faire des requêtes d'insertions multiples,
* mieux gérées par les moteurs SQL (particulièrement pour SQLite)
*
* @uses preparer_sql_paquet()
* @uses svp_compiler_multis()
* @uses eclater_plugin_paquet()
* @uses svp_rechercher_maj_version()
* @uses svp_corriger_obsolete_paquets()
*
* @param array $paquets_locaux
* Descriptions des paquets (intégrant un hash), stockés par
* constante, puis par chemin.
@ -668,6 +683,8 @@ function svp_rechercher_maj_version($prefixe, $version, $etatnum) {
/**
* Actualise l'information 'maj_version' pour tous les paquets locaux
*
* @uses svp_rechercher_maj_version()
**/
function svp_actualiser_maj_version() {
$update = array();

@ -97,6 +97,8 @@ $GLOBALS['licences_plugin'] = array(
* d'un plugin ayant plusieurs paquets avec des compatibilités différentes.
* La compatibilité du plugin est le total de toutes les compatibilités.
*
* @uses extraire_bornes()
* @uses construire_intervalle()
* @param string $intervalle_a
* Intervalle de compatibilité
* @param string $intervalle_b
@ -214,6 +216,7 @@ function construire_intervalle($bornes, $dtd='paquet') {
* Retourne la liste des branches de SPIP comprises dans un intervalle
* de compatibilité donné.
*
* @uses extraire_bornes()
* @param string $intervalle
* Intervalle de compatibilité, tel que [2.0.0;3.0.0]
* @return string

@ -83,6 +83,8 @@ $GLOBALS['balises_multis'] = array(
* La fonction met en cache le résultat du phrasage de chaque archive et ne
* rephrase que les archives ayant changées.
*
* @uses svp_aplatir_balises()
* @uses svp_phraser_archives()
* @param string $fichier_xml
* Chemin local du fichier XML de description du dépot
* @return array|bool
@ -147,6 +149,10 @@ function svp_phraser_depot($fichier_xml) {
* - <traductions> : contient la compilation des informations de traduction (facultatif)
* - <plugin> ou <paquet> suivant la DTD : le contenu du fichier plugin.xml ou paquet.xml (facultatif)
*
* @uses svp_phraser_zip()
* @uses svp_phraser_traductions()
* @uses svp_phraser_plugin()
* @uses plugin_version_compatible()
* @param array $archives
* Tableau de la liste des archives trouvées dans la description d'un dépot
* @param array $md5_cache
@ -241,7 +247,10 @@ function svp_phraser_archives($archives,&$md5_cache=array()) {
* Elle phrase la balise <multi> dans le cas d'une DTD paquet qui contient
* les traductions du nom, slogan et description
*
* @uses svp_aplatir_balises()
*
* @global $balises_multis
* @static array $informer
*
* @param string $dtd
* Nom du type de dtd : plugin ou paquet (pour phraser un plugin.xml ou un paquet.xml)
@ -304,6 +313,8 @@ function svp_phraser_plugin($dtd, $contenu) {
*
* Extrait du XML les informations du zip
*
* @uses svp_aplatir_balises()
*
* @param string $contenu
* Description XML de l'archive
* @return array
@ -376,6 +387,8 @@ function svp_phraser_traductions($contenu) {
*
* Effectue un trim() de la valeur trouvée dans l'arbre
*
* @uses spip_xml_aplatit()
*
* @param array $balises
* Liste de noms de balises XML.
* Peut aussi être un tableau indiquant un renommage d'une balise

@ -23,6 +23,9 @@ include_spip('inc/plugin');
* - ne liste pas ceux étant déjà installés (ces paquets peuvent toutefois être affichés)
* - est triée par nom ou score
*
* @uses liste_des_champs()
* @uses recherche_en_base()
*
* @param string $phrase
* Texte de la recherche
* @param string $categorie
@ -192,7 +195,8 @@ function svp_rechercher_plugins_spip($phrase, $categorie, $etat, $depot, $versio
/**
* Récupère les identifiants des plugins déjà installés
*
* @return int[]
* @uses liste_plugin_actifs()
* @return array
* Liste d'identifiants de plugins
*/
function svp_lister_plugins_installes(){
@ -220,6 +224,7 @@ function svp_lister_plugins_installes(){
* Teste la compatibilité d'un intervalle de compatibilité avec une version
* donnée de SPIP
*
* @uses plugin_version_compatible()
* @param string $intervalle
* Intervalle de compatibilité, tel que [2.1;3.0]
* @param string $version_spip

@ -1,7 +1,7 @@
<paquet
prefix="svp"
categorie="maintenance"
version="0.82.6"
version="0.82.7"
etat="stable"
compatibilite="[3.0.0;3.1.*]"
logo="svp-64.png"

@ -23,6 +23,10 @@ include_spip('inc/svp_outiller');
* On limite le traitement a deux balises plugins maximum,
* ce qui est le cas de tous les plugin.xml actuellement connus
*
* @uses _SVP_VERSION_SPIP_MIN
* @uses extraire_bornes()
* @uses fusionner_intervalles()
*
* @param array $plugins
* Arbre des balises plugins présents dans un plugin.xml
* @return array

@ -18,6 +18,7 @@ if (!defined('_ECRIRE_INC_VERSION')) return;
* Les données sont parfois sérialisées, parfois transcodées, parfois compilées
* pour tenir compte des spécificités de cette DTD et du stockage en bdd.
*
* @uses compiler_branches_spip()
* @param array $plugin
* Description de plugin
* @return array
@ -103,6 +104,8 @@ function plugins_preparer_sql_plugin($plugin)
*
* @todo Supprimer cette fonction qui ne sert nulle part ?
*
* @uses extraire_trads()
*
* @param string $nom
* Le nom
* @param string $langue
@ -169,6 +172,8 @@ function normaliser_lien($url) {
* - Interprétation des balises BR et LI et de la virgule et du
* espace+tiret comme séparateurs
*
* @uses _RACCOURCI_LIEN
*
* @param string $texte
* Texte de la balise
* @param string $balise
@ -257,6 +262,7 @@ function normaliser_auteur_licence($texte, $balise) {
/**
* Expanse les multi en un tableau de textes complets, un par langue
*
* @uses _EXTRAIRE_MULTI
* @param string $texte
* Le texte
* @return array

@ -65,6 +65,7 @@ function svp_afficher_etat($etat) {
* Des liens vers les plugins dépendants sont présents lorsque les plugins
* en dépendance sont connus dans notre base.
*
* @uses svp_afficher_intervalle()
* @param string $balise_serialisee
* Informations des dépendances (tableau sérialisé) tel que stocké
* en base dans la table spip_paquets
@ -230,6 +231,7 @@ function svp_afficher_langues($langues, $sep=', '){
* Liste le nombre de plugins et de paquets d'un dépot
* Indique aussi le nombre de dépots si l'on ne demande pas de dépot particulier.
*
* @uses svp_compter()
* @param int $id_depot
* Identifiant du dépot
* @return string
@ -269,6 +271,7 @@ function svp_afficher_statistiques_globales($id_depot=0){
* ou une certaine branche de SPIP et retourne une phrase traduite
* tel que «78 paquets disponibles»
*
* @uses svp_compter()
* @param int $id_depot
* Identifiant du dépot
* Zéro (par défaut) signifie ici : «dans tous les dépots distants»
@ -294,6 +297,7 @@ function svp_compter_telechargements($id_depot=0, $categorie='', $compatible_spi
* plugins et paquets, mais l'on peut demander le total des autres contributions
* avec le second paramètre.
*
* @uses svp_compter()
* @param int $id_depot
* Identifiant du dépot
* Zéro (par défaut) signifie ici : «dans tous les dépots distants»
@ -337,6 +341,7 @@ function svp_compter_depots($id_depot, $contrib='plugin'){
* ou une certaine branche de SPIP et retourne une phrase traduite
* tel que «64 plugins disponibles»
*
* @uses svp_compter()
* @param int $id_depot
* Identifiant du dépot
* Zéro (par défaut) signifie ici : «dans tous les dépots distants»
@ -487,6 +492,8 @@ function balise_SVP_CATEGORIES($p) {
* Retourne un tableau listant chaque type de catégorie
* en index, associé à sa traduction en valeur.
*
* @uses svp_traduire_categorie()
*
* @param string $tri
* Type de tri (ordre_cle ou ordre_alpha)
* @param string $categorie

@ -10,6 +10,9 @@
/**
* Téléporter et déballer un composant HTTP
*
* @uses teleporter_http_recuperer_source()
* @uses teleporter_nettoyer_vieille_version()
*
* @param string $methode
* Méthode de téléportation : http|git|svn|...
* @param string $source
@ -55,6 +58,8 @@ function teleporter_http_dist($methode,$source,$dest,$options=array()){
/**
* Récupérer la source et détecter son extension
*
* @uses teleporter_http_extension()
*
* @param string $source
* URL de la source HTTP
* @param string $dest_tmp

@ -12,6 +12,7 @@
* Déballer le fichier au format tgz dans le répertoire $dest
* en utilisant le dossier temporaire $tmp si besoin
*
* @uses teleporter_http_charger_tgz()
* @param string $archive
* Chemin du fichier tgz
* @param string $dest
@ -55,6 +56,11 @@ function teleporter_http_deballe_tgz_dist($archive, $dest, $tmp){
/**
* Charger un tgz à partir d'un tableau d'options descriptives
*
* @uses PclTarList()
* @uses http_deballe_recherche_racine()
* @uses PclErrorString()
* @uses PclTarExtract()
*
* @param array $quoi
* Tableau d'options
* @return array|bool|int|string

@ -12,6 +12,8 @@
* Déballer le fichier au format zip dans le répertoire $dest
* en utilisant le dossier temporaire $tmp si besoin
*
* @uses teleporter_http_charger_zip()
*
* @param string $archive
* Chemin du fichier zip
* @param string $dest
@ -53,6 +55,8 @@ function teleporter_http_deballe_zip_dist($archive, $dest, $tmp){
/**
* Charger un zip à partir d'un tableau d'options descriptives
*
* @uses http_deballe_recherche_racine()
*
* @param array $quoi
* Tableau d'options
* @return array|bool|int|string

@ -12,6 +12,9 @@
*
* Déployer un repository SVN depuis une source et une révision données
*
* @uses teleporter_svn_read()
* @uses teleporter_nettoyer_vieille_version()
*
* @param string $methode
* Méthode de téléportation : http|git|svn|...
* @param string $source

Loading…
Cancel
Save