Changeset 93019 in spip-zone


Ignore:
Timestamp:
Nov 19, 2015, 8:26:55 PM (4 years ago)
Author:
eric@…
Message:

Phpdoc des formulaires.

Location:
_plugins_/taxonomie/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/taxonomie/trunk/formulaires/charger_taxonomie.php

    r92951 r93019  
    11<?php
    22/**
    3  * Gestion du formulaire de chargement d'un règne
     3 * Gestion du formulaire de chargement des taxons d'un règne.
    44 *
    55 * @package    SPIP\TAXONOMIE\OBJET
     
    99
    1010/**
     11 * Chargement des données : le formulaire propose la liste des boussoles accessibles
     12 * à partir des serveurs que le site client a déclaré.
     13 *
     14 * @uses taxonomie_regne_existe()
     15 * @uses lister_rangs()
     16 *
    1117 * @return array
     18 *              Le tableau des données à charger par le formulaire. Toutes les données sont utilisées
     19 *              pour l'affichage du formulaire uniquement. Aucune donnée chargée n'est un champ de saisie.
     20 *
     21 *              - `_actions_regnes`             : alias et libellés des actions possibles sur un règne, `charger` et `vider`
     22 *              - `_actions_disable`    : liste des actions désactivées (`vider` si le règne n`est pas chargé)
     23 *              - `_action_defaut`              : action sélectionnée par défaut, `charger`
     24 *              - `_regnes`                             : noms scientifiques et libellés des règnes supportés par le plugin
     25 *              - `_rangs`                              : noms anglais et libellés des rangs du `phylum` au `genus`
     26 *              - `_rang_defaut`                : nom anglais du rang sélectionné par défaut, `genus`
     27 *              - `_langues_regne`              : codes de langue SPIP et libellés des langues utilisées (configuration)
     28 *              - `_langue_defaut`              : la première langue de la liste des langues utilisées
    1229 */
    1330function formulaires_charger_taxonomie_charger() {
     
    5875
    5976/**
     77 * Vérification des saisies : il est indispensable de choisir une action (`vider` ou `charger`) et
     78 * un règne.
     79 * Un rang minimal est toujours sélectionné. La saisie des langues des noms communs est optionnelle.
     80 *
    6081 * @return array
     82 *              Tableau des erreurs sur l'action et/ou le règne ou tableau vide si aucune erreur.
    6183 */
    6284function formulaires_charger_taxonomie_verifier() {
     
    7395
    7496/**
     97 * Exécution du formulaire : le règne choisi est soit vidé, soit chargé jusqu'au rang minimal
     98 * choisi en y intégrant les traductions des noms communs sélectionnées.
     99 *
     100 * @uses taxonomie_regne_existe()
     101 * @uses taxonomie_vider_regne()
     102 * @uses taxonomie_charger_regne()
     103 *
    75104 * @return array
     105 *              Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou
     106 *              d'erreur. L'indicateur editable est toujours à vrai.
    76107 */
    77108function formulaires_charger_taxonomie_traiter() {
  • _plugins_/taxonomie/trunk/formulaires/configurer_taxonomie.php

    r92951 r93019  
    99
    1010/**
     11 * Chargement des données : le formulaire propose la liste des boussoles accessibles
     12 * à partir des serveurs que le site client a déclaré.
     13 *
     14 * @uses lister_rangs()
     15 *
    1116 * @return array
     17 *              le tableau des données à charger par le formulaire :
     18 *
     19 *              - 'boussole' : l'alias de la boussole choisie
     20 *              - '_boussoles' : la liste des boussoles accessibles
     21 *              - 'message_erreur' : message d'erreur éventuel retourné par un des serveurs interrogés
     22 *              - 'editable' : booleen à false si une erreur est survenue
    1223 */
    1324function formulaires_configurer_taxonomie_charger() {
     
    2738
    2839/**
     40 * Vérification des saisies : aucune nécessaire, le formulaire ne proposnt que des boutons
     41 * radio dont un est toujours actif.
     42 *
    2943 * @return array
     44 *              Tableau des erreur toujours vide.
    3045 */
    3146function formulaires_configurer_taxonomie_verifier() {
  • _plugins_/taxonomie/trunk/taxonomie_fonctions.php

    r92946 r93019  
    270270 * @api
    271271 * @filtre
    272  * @uses ${service}_credit, fonction de formatage des crédits propre à chaque service
     272 * @uses ${service}_credit fonction de formatage des crédits propre à chaque service
    273273 *
    274274 * @param int           $id_taxon
Note: See TracChangeset for help on using the changeset viewer.