Changeset 82359 in spip-zone


Ignore:
Timestamp:
May 14, 2014, 10:59:44 AM (5 years ago)
Author:
teddy.spip@…
Message:

Ajout de PHPDoc.
c'est "@uses" et non "@use"

Location:
_core_/plugins/svp
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/svp/action/supprimer_depot.php

    r64981 r82359  
    1111 * Action de suppression en base de données d'un dépot et de ses plugins
    1212 *
     13 * @uses  svp_supprimer_depot()
    1314 * @return void
    1415 */
  • _core_/plugins/svp/exec/admin_plugin.php

    r80656 r82359  
    2929 * Affichage de la page de gestion des plugins
    3030 *
    31  * @use actualise_plugins_actifs()
    32  * @use svp_presenter_actions_realisees()
    33  * @use plugin_installes_meta()
    34  * @use plugin_donne_erreurs()
     31 * @uses actualise_plugins_actifs()
     32 * @uses svp_presenter_actions_realisees()
     33 * @uses plugin_installes_meta()
     34 * @uses plugin_donne_erreurs()
     35 * @uses svp_vider_tables()
    3536 *
    3637 * @pipeline_appel affiche_gauche
  • _core_/plugins/svp/formulaires/admin_plugin.php

    r73214 r82359  
    1414 * Chargement du formulaire de gestion des plugins
    1515 *
     16 * @uses  svp_actualiser_paquets_locaux()
    1617 * @param string $voir
    1718 *     Statut des plugins que l'on souhaite voir : actif, inactif, tous
     
    7374 *
    7475 * Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
     76 *
     77 * @uses  svp_decider_verifier_actions_demandees()
    7578 *
    7679 * @param string $voir
     
    146149 * l'action 'actionner' qui les traitera une par une.
    147150 *
     151 * @uses svp_actionner_traiter_actions_demandees()
     152 *
    148153 * @param string $voir
    149154 *     Statut des plugins que l'on souhaite voir : actif, inactif, tous
  • _core_/plugins/svp/formulaires/ajouter_depot.php

    r64981 r82359  
    2828 * déjà été créé.
    2929 *
     30 * @uses  svp_verifier_adresse_depot()
    3031 * @return array
    3132 *     Tableau des erreurs
     
    5859 * ou s'il n'a aucun plugin.
    5960 *
     61 * @uses  svp_ajouter_depot()
    6062 * @return array
    6163 *     Retours du traitement
  • _core_/plugins/svp/formulaires/charger_plugin.php

    r64981 r82359  
    4444 * Si on reçoit une demande de confirmation, on sort sans lever d'erreur !
    4545 *
     46 * @uses svp_decider_verifier_actions_demandees()
    4647 * @return array
    4748 *     Tableau des erreurs
  • _core_/plugins/svp/genie/svp_actualiser_depots.php

    r64981 r82359  
    1616 * @genie svp_actualiser_depots
    1717 *
     18 * @uses  svp_actualiser_depot()
    1819 * @param int $last
    1920 *     Timestamp de la dernière exécution de cette tâche
  • _core_/plugins/svp/inc/svp_depoter_distant.php

    r75241 r82359  
    2626 * son texte est placé dans le paramètre $erreur
    2727 *
     28 * @uses  svp_phraser_depot()
     29 * @uses  svp_actualiser_paquets()
     30 * @uses  svp_base_supprimer_paquets_locaux()
    2831 * @param string $url
    2932 *     URL du fichier XML de description du dépot
     
    105108 * des plugins téléchargeables qui peuvent changer.
    106109 *
     110 * @uses  svp_actualiser_url_plugins()
     111 * @uses  svp_nettoyer_apres_suppression()
     112 * @uses  svp_base_supprimer_paquets_locaux()
     113 *
    107114 * @param int $id
    108115 *     Identifiant du dépot
     
    233240 * XML de description du dépot a changé
    234241 *
     242 * @uses  svp_actualiser_maj_version()
     243 * @uses  svp_actualiser_paquets()
     244 * @uses  svp_phraser_depot()
    235245 * @param int $id
    236246 *     Identifiant du dépot
     
    303313 * Enlève de la base les paquets du dépots qui ne sont plus présents
    304314 * dans la description du XML. Ajoute ou met à jour les autres.
     315 *
     316 * @uses  svp_supprimer_plugins_orphelins()
     317 * @uses  svp_corriger_vmax_plugins()
     318 * @uses  svp_completer_plugins()
     319 * @uses  eclater_plugin_paquet()
     320 * @uses  svp_inserer_multi()
     321 * @uses  svp_completer_plugins_depot()
     322 * @uses  svp_actualiser_url_plugins()
    305323 *
    306324 * @param int $id_depot
     
    676694 * en compilant certaines informations (compatibilités, dates,  branches)
    677695 *
     696 * @uses  svp_completer_plugins()
    678697 * @param int $id_depot
    679698 *     Identifiant du depot à actualiser
     
    692711 * en compilant certaines informations (compatibilités, dates,  branches)
    693712 *
     713 * @uses  compiler_branches_spip()
    694714 * @param array $ids_plugin
    695715 *     Liste d'identifiants de plugins
  • _core_/plugins/svp/inc/svp_depoter_local.php

    r68050 r82359  
    2424 * de toutes les informations locales avec var_mode=vider_paquets_locaux
    2525 * dans l'URL ou en mettant le paramètre $force à true.
     26 *
     27 * @uses  svp_descriptions_paquets_locaux()
     28 * @uses  svp_base_supprimer_paquets_locaux()
     29 * @uses  svp_base_inserer_paquets_locaux()
     30 * @uses  svp_base_modifier_paquets_locaux()
     31 * @uses  svp_base_actualiser_paquets_actifs()
    2632 *
    2733 * @param bool $force
     
    116122 * en ne modifiant que ce qui a changé.
    117123 *
     124 * @uses  svp_supprimer_plugins_orphelins()
     125 * @uses  svp_base_inserer_paquets_locaux()
     126 *
    118127 * @param array $paquets_locaux
    119128 *     Descriptions des paquets (intégrant un hash), stockés par
     
    181190 *     On essaie au mieux de faire des requêtes d'insertions multiples,
    182191 *     mieux gérées par les moteurs SQL (particulièrement pour SQLite)
     192 *
     193 * @uses  preparer_sql_paquet()
     194 * @uses  svp_compiler_multis()
     195 * @uses  eclater_plugin_paquet()
     196 * @uses  svp_rechercher_maj_version()
     197 * @uses  svp_corriger_obsolete_paquets()
    183198 *
    184199 * @param array $paquets_locaux
     
    669684/**
    670685 * Actualise l'information 'maj_version' pour tous les paquets locaux
     686 *
     687 * @uses  svp_rechercher_maj_version()
    671688**/
    672689function svp_actualiser_maj_version() {
  • _core_/plugins/svp/inc/svp_outiller.php

    r67649 r82359  
    9898 * La compatibilité du plugin est le total de toutes les compatibilités.
    9999 *
     100 * @uses  extraire_bornes()
     101 * @uses  construire_intervalle()
    100102 * @param string $intervalle_a
    101103 *     Intervalle de compatibilité
     
    215217 * de compatibilité donné.
    216218 *
     219 * @uses  extraire_bornes()
    217220 * @param string $intervalle
    218221 *     Intervalle de compatibilité, tel que [2.0.0;3.0.0]
  • _core_/plugins/svp/inc/svp_phraser.php

    r75241 r82359  
    8484 * rephrase que les archives ayant changées.
    8585 *
     86 * @uses  svp_aplatir_balises()
     87 * @uses  svp_phraser_archives()
    8688 * @param string $fichier_xml
    8789 *     Chemin local du fichier XML de description du dépot
     
    148150 * - <plugin> ou <paquet> suivant la DTD : le contenu du fichier plugin.xml ou paquet.xml (facultatif)
    149151 *
     152 * @uses  svp_phraser_zip()
     153 * @uses  svp_phraser_traductions()
     154 * @uses  svp_phraser_plugin()
     155 * @uses  plugin_version_compatible()
    150156 * @param array $archives
    151157 *     Tableau de la liste des archives trouvées dans la description d'un dépot
     
    242248 * les traductions du nom, slogan et description
    243249 *
     250 * @uses svp_aplatir_balises()
     251 *
    244252 * @global $balises_multis
     253 * @static array $informer
    245254 *
    246255 * @param string $dtd
     
    304313 *
    305314 * Extrait du XML les informations du zip
     315 *
     316 * @uses svp_aplatir_balises()
    306317 *
    307318 * @param string $contenu
     
    377388 * Effectue un trim() de la valeur trouvée dans l'arbre
    378389 *
     390 * @uses  spip_xml_aplatit()
     391 *
    379392 * @param array $balises
    380393 *     Liste de noms de balises XML.
  • _core_/plugins/svp/inc/svp_rechercher.php

    r64981 r82359  
    2424 * - est triée par nom ou score
    2525 *
     26 * @uses  liste_des_champs()
     27 * @uses  recherche_en_base()
     28 *
    2629 * @param string $phrase
    2730 *     Texte de la recherche
     
    193196 * Récupère les identifiants des plugins déjà installés
    194197 *
    195  * @return int[]
     198 * @uses  liste_plugin_actifs()
     199 * @return array
    196200 *     Liste d'identifiants de plugins
    197201 */
     
    221225 * donnée de SPIP
    222226 *
     227 * @uses  plugin_version_compatible()
    223228 * @param string $intervalle
    224229 *     Intervalle de compatibilité, tel que [2.1;3.0]
  • _core_/plugins/svp/paquet.xml

    r80200 r82359  
    22        prefix="svp"
    33        categorie="maintenance"
    4         version="0.82.6"
     4        version="0.82.7"
    55        etat="stable"
    66        compatibilite="[3.0.0;3.1.*]"
  • _core_/plugins/svp/plugins/fusion_plugin.php

    r64981 r82359  
    2424 * ce qui est le cas de tous les plugin.xml actuellement connus
    2525 *
     26 * @uses  _SVP_VERSION_SPIP_MIN
     27 * @uses  extraire_bornes()
     28 * @uses  fusionner_intervalles()
     29 *
    2630 * @param array $plugins
    2731 *     Arbre des balises plugins présents dans un plugin.xml
  • _core_/plugins/svp/plugins/preparer_sql_plugin.php

    r64981 r82359  
    1919 * pour tenir compte des spécificités de cette DTD et du stockage en bdd.
    2020 *
     21 * @uses  compiler_branches_spip()
    2122 * @param array $plugin
    2223 *     Description de plugin
     
    104105 * @todo Supprimer cette fonction qui ne sert nulle part ?
    105106 *
     107 * @uses  extraire_trads()
     108 *
    106109 * @param string $nom
    107110 *     Le nom
     
    170173 *   espace+tiret comme séparateurs
    171174 *
     175 * @uses  _RACCOURCI_LIEN
     176 *
    172177 * @param string $texte
    173178 *     Texte de la balise
     
    258263 * Expanse les multi en un tableau de textes complets, un par langue
    259264 *
     265 * @uses  _EXTRAIRE_MULTI
    260266 * @param string $texte
    261267 *     Le texte
  • _core_/plugins/svp/svp_fonctions.php

    r81288 r82359  
    6666 * en dépendance sont connus dans notre base.
    6767 *
     68 * @uses svp_afficher_intervalle()
    6869 * @param string $balise_serialisee
    6970 *     Informations des dépendances (tableau sérialisé) tel que stocké
     
    231232 * Indique aussi le nombre de dépots si l'on ne demande pas de dépot particulier.
    232233 *
     234 * @uses svp_compter()
    233235 * @param int $id_depot
    234236 *     Identifiant du dépot
     
    270272 * tel que «78 paquets disponibles»
    271273 *
     274 * @uses svp_compter()
    272275 * @param int $id_depot
    273276 *     Identifiant du dépot
     
    295298 * avec le second paramètre.
    296299 *
     300 * @uses svp_compter()
    297301 * @param int $id_depot
    298302 *     Identifiant du dépot
     
    338342 * tel que «64 plugins disponibles»
    339343 *
     344 * @uses svp_compter()
    340345 * @param int $id_depot
    341346 *     Identifiant du dépot
     
    488493 * en index, associé à sa traduction en valeur.
    489494 *
     495 * @uses svp_traduire_categorie()
     496 *
    490497 * @param string $tri
    491498 *     Type de tri (ordre_cle ou ordre_alpha)
  • _core_/plugins/svp/teleporter/http.php

    r77979 r82359  
    1010/**
    1111 * Téléporter et déballer un composant HTTP
     12 *
     13 * @uses  teleporter_http_recuperer_source()
     14 * @uses  teleporter_nettoyer_vieille_version()
    1215 *
    1316 * @param string $methode
     
    5659 * Récupérer la source et détecter son extension
    5760 *
     61 * @uses  teleporter_http_extension()
     62 *
    5863 * @param string $source
    5964 *     URL de la source HTTP
  • _core_/plugins/svp/teleporter/http_deballe_tgz.php

    r64981 r82359  
    1313 * en utilisant le dossier temporaire $tmp si besoin
    1414 *
     15 * @uses  teleporter_http_charger_tgz()
    1516 * @param string $archive
    1617 *     Chemin du fichier tgz
     
    5657 * Charger un tgz à partir d'un tableau d'options descriptives
    5758 *
     59 * @uses  PclTarList()
     60 * @uses  http_deballe_recherche_racine()
     61 * @uses  PclErrorString()
     62 * @uses  PclTarExtract()
     63 *
    5864 * @param array $quoi
    5965 *     Tableau d'options
  • _core_/plugins/svp/teleporter/http_deballe_zip.php

    r64981 r82359  
    1313 * en utilisant le dossier temporaire $tmp si besoin
    1414 *
     15 * @uses  teleporter_http_charger_zip()
     16 *
    1517 * @param string $archive
    1618 *     Chemin du fichier zip
     
    5456 * Charger un zip à partir d'un tableau d'options descriptives
    5557 *
     58 * @uses  http_deballe_recherche_racine()
     59 *
    5660 * @param array $quoi
    5761 *     Tableau d'options
  • _core_/plugins/svp/teleporter/svn.php

    r68057 r82359  
    1313 * Déployer un repository SVN depuis une source et une révision données
    1414 *
     15 * @uses  teleporter_svn_read()
     16 * @uses  teleporter_nettoyer_vieille_version()
     17 *
    1518 * @param string $methode
    1619 *     Méthode de téléportation : http|git|svn|...
Note: See TracChangeset for help on using the changeset viewer.