Changeset 92906 in spip-zone


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

Phpdoc de l'api ITIS

File:
1 edited

Legend:

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

    r92891 r92906  
    11<?php
    22/**
    3  * Ce fichier contient l'ensemble des constantes et functions implémentant le service de taxonomie ITIS.
     3 * Ce fichier contient l'ensemble des constantes et fonctions implémentant le service de taxonomie ITIS.
    44 *
    55 * @package SPIP\TAXONOMIE\ITIS
     
    1111        /**
    1212         * Préfixe des URL du service web de ITIS.
    13          * Le service fournit des données au format XML ou JSON
    1413         */
    1514        define('_TAXONOMIE_ITIS_ENDPOINT_BASE_URL', 'http://www.itis.gov/ITISWebService/');
     
    1716if (!defined('_TAXONOMIE_ITIS_TAXON_BASE_URL'))
    1817        /**
    19          * URL à fournir dans la citation du service ITIS.
     18         * URL de base d'une page d'un taxon sur le site d'ITIS.
     19         * Cette URL est fournie dans les credits.
    2020         */
    2121        define('_TAXONOMIE_ITIS_TAXON_BASE_URL', 'http://www.itis.gov/servlet/SingleRpt/SingleRpt?search_topic=TSN&search_value=');
     
    2323if (!defined('_TAXONOMIE_ITIS_SITE_URL'))
    2424        /**
    25          * URL à fournir dans la citation du service ITIS.
     25         * URL de la page d'accueil du site ITIS.
     26         * Cette URL est fournie dans les credits.
    2627         */
    2728        define('_TAXONOMIE_ITIS_SITE_URL', 'http://www.itis.gov');
     
    3738
    3839/**
    39  * Configuration de la correspondance entre langue Wikipedia et code de langue SPIP.
    40  * La langue du service est l'index, le code SPIP est la valeur.
     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.
    4143 */
    4244$GLOBALS['itis_language'] = array(
     
    168170 *
    169171 * @param string        $action
    170  *              Recherche par nom commun ou par nom scientifique. Prend les valeurs 'commonname' ou 'scientificname'
     172 *              Recherche par nom commun ou par nom scientifique. Prend les valeurs `commonname` ou `scientificname`
    171173 * @param string        $recherche
    172174 *              Nom à rechercher précisément. Seul le taxon dont le nom coincidera exactement sera retourné.
     
    219221 * @return array
    220222 *      Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:
    221  *      - 'nom_scientique'  : le nom scientifique du taxon en minuscules
    222  *      - 'rang'            : le nom anglais du rang taxonomique du taxon
    223  *      - 'regne'           : le nom scientifque du règne du taxon en minuscules
    224  *      - 'tsn_parent'      : le tsn du parent du taxon ou 0 si le taxon est un règne
    225  *      - 'auteur'          : la citation d’auteurs et la date de publication
    226  *      - 'nom_commun'      : un tableau indexé par langue (au sens d'ITIS, English, French...) fournissant le nom commun
     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
    227229 *                            dans chacune des langues
    228230 */
     
    271273 * @param string        $action
    272274 *              Type d'information demandé. Prend les valeurs
    273  *      - 'scientificname' : le nom scientifique du taxon
    274  *      - 'kingdomname' : le règne du taxon
    275  *      - 'parent' : le taxon parent dont son tsn
    276  *      - 'rankname' : le rang taxonomique du taxon
    277  *      - 'author' : le ou les auteurs du taxon
    278  *      - 'coremetadata' : les métadonnées (à vérifier)
    279  *              - 'experts' : les experts du taxon
    280  *              - 'commonnames' : le ou les noms communs
    281  *              - 'othersources' : les sources d'information sur le taxon
    282  *              - 'hierarchyfull' : la hiérarchie complète jusqu'au taxon
    283  *              - 'hierarchydown' : la hiérarchie (à vérifier)
     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)
    284286 * @param int           $tsn
    285287 *              Identifiant unique du taxon dans la base ITIS (TSN)
     
    344346 *
    345347 * @param $language
    346  *      Langue au sens d'ITIS écrite en minuscules. Vaut 'french', 'english', 'spanish'...
     348 *      Langue au sens d'ITIS écrite en minuscules. Vaut `french`, `english`, `spanish`...
    347349 *
    348350 * @return array
     
    350352 *      - index     : le TSN du taxon
    351353 *      - valeur    : le tableau des noms communs, chaque nom étant préfixé du code de langue
    352  *                    de SPIP (ex: '[fr]bactéries')
     354 *                    de SPIP (ex: `[fr]bactéries`)
    353355 */
    354356function itis_list_vernaculars($language) {
     
    586588 * @return array
    587589 *      Tableau à deux index principaux:
    588  *      - 'taxons'      : tableau associatif indexé par règne
    589  *      - 'traductions' : tableau associatif par code de langue SPIP
     590 *      - `taxons`      : tableau associatif indexé par règne
     591 *      - `traductions` : tableau associatif par code de langue SPIP
    590592 */
    591593function itis_review_sha() {
     
    621623
    622624/**
    623  * @param $format
    624  * @param $group
    625  * @param $action
    626  * @param $key
     625 * Construire l'URL de la requête ITIS correspondant à la demande utilisateur.
     626 *
     627 * @param string        $format
     628 *              Format du résultat de la requête. Prend les valeurs `json` ou `xml`. Le `json` est recommandé.
     629 * @param string        $group
     630 *              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
     632 *              - `vernacular`  : groupe de l'action fournissant les noms communs d'une langue donnée
     633 *              - `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
     635 * @param string        $action
     636 *              Nom de l'action du service ITIS. Les valeurs dépendent du groupe. Par exemple, pour le groupe
     637 *              `search` les actions sont `commonname` et `scientificname`.
     638 * @param string        $key
     639 *              Clé de recherche qui dépend de l'action demandée. Ce peut être le nom scientifique, le tsn, etc.
     640 *              Cette clé doit être encodée si besoin par l'appelant.
    627641 *
    628642 * @return string
Note: See TracChangeset for help on using the changeset viewer.