Changeset 92909 in spip-zone


Ignore:
Timestamp:
Nov 14, 2015, 10:56:39 AM (4 years ago)
Author:
eric@…
Message:

Phpdoc et indentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/taxonomie/trunk/services/itis/itis_api.php

    r92906 r92909  
    3737
    3838
    39 /**
    40  * @global array        $itis_language
    41  *              Configuration de la correspondance entre langue Wikipedia et code de langue SPIP.
    42  *              La langue du service est l'index, le code SPIP est la valeur.
    43  */
    4439$GLOBALS['itis_language'] = array(
     40        /**
     41         * Configuration de la correspondance entre langue Wikipedia et code de langue SPIP.
     42         * La langue du service est l'index, le code SPIP est la valeur.
     43         */
    4544        'french' => 'fr',
    4645        'english' => 'en',
    4746        'spanish' => 'es'
    4847);
    49 /**
    50  * Configuration de l'api des actions du service web ITIS
    51  */
    5248$GLOBALS['itis_webservice'] = array(
     49        /**
     50         * Configuration de l'api des actions du service web ITIS
     51         */
    5352        'search' => array(
    5453                'commonname' => array(
     
    165164/**
    166165 * Recherche un taxon dans la base ITIS par son nom commun ou scientifique
    167  * et retourne son identifiant unique nommé tsn ou 0 si le taxon n'existe pas.
     166 * et retourne son identifiant unique nommé TSN ou 0 si le taxon n'existe pas.
    168167 *
    169168 * @api
     
    175174 *
    176175 * @return int
    177  *              Identifiant unique tsn dans la base ITIS ou 0 si la recherche échoue
     176 *              Identifiant unique TSN dans la base ITIS ou 0 si la recherche échoue
    178177 */
    179178function itis_search_tsn($action, $recherche) {
     
    212211
    213212/**
    214  * Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique tsn.
     213 * Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.
    215214 *
    216215 * @api
    217216 *
    218217 * @param int   $tsn
    219  *              Identifiant unique du taxon dans la base ITIS (tsn)
     218 *              Identifiant unique du taxon dans la base ITIS, le TSN
    220219 *
    221220 * @return array
    222  *      Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:
    223  *      - `nom_scientique`  : le nom scientifique du taxon en minuscules
    224  *      - `rang`            : le nom anglais du rang taxonomique du taxon
    225  *      - `regne`           : le nom scientifque du règne du taxon en minuscules
    226  *      - `tsn_parent`      : le tsn du parent du taxon ou 0 si le taxon est un règne
    227  *      - `auteur`          : la citation d’auteurs et la date de publication
    228  *      - `nom_commun`      : un tableau indexé par langue (au sens d'ITIS, English, French...) fournissant le nom commun
    229  *                           dans chacune des langues
     221 *              Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:
     222 *              - `nom_scientique`      : le nom scientifique du taxon en minuscules
     223 *              - `rang`                        : le nom anglais du rang taxonomique du taxon
     224 *              - `regne`                       : le nom scientifque du règne du taxon en minuscules
     225 *              - `tsn_parent`          : le TSN du parent du taxon ou 0 si le taxon est un règne
     226 *              - `auteur`                      : la citation d’auteurs et la date de publication
     227 *              - `nom_commun`          : un tableau indexé par langue (au sens d'ITIS en minuscules, `english`, `french`, `spanish`)
     228 *                                                        fournissant le nom commun dans chacune des langues
    230229 */
    231230function itis_get_record($tsn) {
     
    273272 * @param string        $action
    274273 *              Type d'information demandé. Prend les valeurs
    275  *      - `scientificname` : le nom scientifique du taxon
    276  *      - `kingdomname` : le règne du taxon
    277  *      - `parent` : le taxon parent dont son tsn
    278  *      - `rankname` : le rang taxonomique du taxon
    279  *      - `author` : le ou les auteurs du taxon
    280  *      - `coremetadata` : les métadonnées (à vérifier)
    281  *              - `experts` : les experts du taxon
    282  *              - `commonnames` : le ou les noms communs
    283  *              - `othersources` : les sources d'information sur le taxon
    284  *              - `hierarchyfull` : la hiérarchie complète jusqu'au taxon
    285  *              - `hierarchydown` : la hiérarchie (à vérifier)
     274 *              - `scientificname`      : le nom scientifique du taxon
     275 *              - `kingdomname`         : le règne du taxon
     276 *              - `parent`                      : le taxon parent dont son TSN
     277 *              - `rankname`            : le rang taxonomique du taxon
     278 *              - `author`                      : le ou les auteurs du taxon
     279 *              - `coremetadata`        : les métadonnées (à vérifier)
     280 *              - `experts`                     : les experts du taxon
     281 *              - `commonnames`         : le ou les noms communs
     282 *              - `othersources`        : les sources d'information sur le taxon
     283 *              - `hierarchyfull`       : la hiérarchie complète jusqu'au taxon
     284 *              - `hierarchydown`       : la hiérarchie (à vérifier)
    286285 * @param int           $tsn
    287286 *              Identifiant unique du taxon dans la base ITIS (TSN)
     
    346345 *
    347346 * @param $language
    348  *      Langue au sens d'ITIS écrite en minuscules. Vaut `french`, `english`, `spanish`...
     347 *              Langue au sens d'ITIS écrite en minuscules. Vaut `french`, `english`, `spanish`...
    349348 *
    350349 * @return array
    351  *      Tableau des noms communs associés à leur TSN. Le format du tableau est le suivant:
    352  *      - index     : le TSN du taxon
    353  *      - valeur    : le tableau des noms communs, chaque nom étant préfixé du code de langue
    354  *                    de SPIP (ex: `[fr]bactéries`)
     350 *              Tableau des noms communs associés à leur TSN. Le format du tableau est le suivant:
     351 *              - `index`       : le TSN du taxon
     352 *              - `valeur`      : le tableau des noms communs, chaque nom étant préfixé du code de langue
     353 *                                        de SPIP (ex: `[fr]bactéries`)
    355354 */
    356355function itis_list_vernaculars($language) {
     
    392391 *
    393392 * @param string        $kingdom
    394  *              Nom scientifique du règne en lettres minuscules (animalia, plantae, fungi)
     393 *              Nom scientifique du règne en lettres minuscules : `animalia`, `plantae`, `fungi`.
    395394 * @param string        $upto
    396  *              Rang taxonomique minimal jusqu'où charger le règne. Ce rang est fourni en anglais et
    397  *              correspond à : phylum (pour le règne animalia) ou division (pour les règnes fungi et plantae),
    398  *              class, order, family, genus.
     395 *              Rang taxonomique minimal jusqu'où charger le règne. Ce rang est fourni en anglais minusucule et
     396 *              correspond à :
     397 *              - `phylum` (pour le règne Animalia) ou `division` (pour les règnes Fungi et Plantae),
     398 *              - `class`,
     399 *              - `order`,
     400 *              - `family`,
     401 *              - `genus`.
    399402 * @param int           $sha_file
    400403 *              Sha calculé à partir du fichier de taxons correspondant au règne choisi. Le sha est retourné
     
    484487
    485488/**
    486  * Lit le fichier des noms communs (tout règne confondu) d'une langue donnée et renvoie un tableau
     489 * Lit le fichier des noms communs - tout règne confondu - d'une langue donnée et renvoie un tableau
    487490 * de tous ces noms indexés par leur TSN.
    488491 *
     
    490493 *
    491494 * @param string        $language
     495 *              Langue au sens d'ITIS écrite en minuscules. Vaut `french`, `english`, `spanish` etc.
    492496 * @param int           $sha_file
     497 *              Sha calculé à partir du fichier des noms communs choisi. Le sha est retourné
     498 *              par la fonction afin d'être stocké par le plugin.
    493499 *
    494500 * @return array
     
    508514                $lines = file($file);
    509515                if ($lines) {
    510                         // Créer le tableau de sortie à partir du tableau issu du csv (tsn, nom commun)
     516                        // Créer le tableau de sortie à partir du tableau issu du csv (TSN, nom commun)
    511517                        $tag_language = '[' . $itis_language[$language] . ']';
    512518                        foreach ($lines as $_line) {
     
    531537 * @api
    532538 *
    533  * @param string    $language_code
    534  *      Code de langue de SPIP. La variable globale $itis_language définit le transcodage langue ITIS
    535  *     vers code SPIP.
     539 * @param string    $spip_language
     540 *      Code de langue de SPIP. Prend les valeurs `fr`, `en`, `es`, etc.
     541 *              La variable globale `$itis_language` définit le transcodage langue ITIS vers code SPIP.
    536542 *
    537543 * @return string
    538  *      Langue au sens d'ITIS ou chaine vide sinon.
    539  */
    540 function itis_spipcode2language($language_code) {
     544 *      Langue au sens d'ITIS en minuscules - `french`, `english`, `spanish` - ou chaine vide sinon.
     545 */
     546function itis_spipcode2language($spip_language) {
    541547        global $itis_language;
    542548
    543         if (!$language = array_search($language_code,  $itis_language)) {
     549        if (!$language = array_search($spip_language,  $itis_language)) {
    544550                $language = '';
    545551        }
     
    555561 * @api
    556562 *
    557  * @param int   $id_taxon
    558  *      Id du taxon nécessaire pour construire l'url de la page ITIS fournissant une information complète sur
    559  *      le taxon.
    560  * @param array $informations
    561  *      Tableau des informations complémentaires sur la source. Pour ITIS ce tableau est vide.
     563 * @param int   $id_taxon
     564 *              Id du taxon nécessaire pour construire l'url de la page ITIS fournissant une information complète sur
     565 *              le taxon.
     566 * @param array $informations
     567 *              Tableau des informations complémentaires sur la source. Pour ITIS ce tableau est vide.
    562568 *
    563569 * @return string
     
    565571 */
    566572function itis_credit($id_taxon, $informations) {
    567         // On recherche le tsn du taxon afin de construire l'url vers sa page sur ITIS
     573        // On recherche le TSN du taxon afin de construire l'url vers sa page sur ITIS
    568574        $taxon = sql_fetsel('tsn, nom_scientifique', 'spip_taxons', 'id_taxon='. sql_quote($id_taxon));
    569575
     
    629635 * @param string        $group
    630636 *              Groupe d'actions du même type. Prend les valeurs:
    631  *              - `search`              : groupe des actions de recherche du tsn à partir du nom commun ou scientifique
     637 *              - `search`              : groupe des actions de recherche du TSN à partir du nom commun ou scientifique
    632638 *              - `vernacular`  : groupe de l'action fournissant les noms communs d'une langue donnée
    633639 *              - `getfull`             : groupe de l'action fournissant l'ensemble des informations d'un taxon
    634  *              - `get                  : groupe des actions fournissant une information précise sur un taxon
     640 *              - `get`                 : groupe des actions fournissant une information précise sur un taxon
    635641 * @param string        $action
    636642 *              Nom de l'action du service ITIS. Les valeurs dépendent du groupe. Par exemple, pour le groupe
    637643 *              `search` les actions sont `commonname` et `scientificname`.
    638644 * @param string        $key
    639  *              Clé de recherche qui dépend de l'action demandée. Ce peut être le nom scientifique, le tsn, etc.
     645 *              Clé de recherche qui dépend de l'action demandée. Ce peut être le nom scientifique, le TSN, etc.
    640646 *              Cette clé doit être encodée si besoin par l'appelant.
    641647 *
Note: See TracChangeset for help on using the changeset viewer.