Documentation du code de SPIP et de ses plugins

Taxonomie

iucn_api.php

Ce fichier contient l'ensemble des constantes et fonctions implémentant le service web de IUCN Red List.

Table of Contents

Constants

_TAXONOMIE_IUCN_CACHE_TIMEOUT  = 86400 * 30 * 6
Période de renouvellement du cache de Wikipedia (6 mois).
_TAXONOMIE_IUCN_ENDPOINT_BASE_URL  = 'http://apiv3.iucnredlist.org/api/v3/'
Préfixe des URL du service web de WIKIPEDIA.
_TAXONOMIE_IUCN_REDLIST  = 'https://www.iucnredlist.org/'
URL de base d'une page d'un taxon sur le site de la red list IUCN.
_TAXONOMIE_IUCN_SITE_URL  = 'https://www.iucn.org/'
URL de la page d'accueil du site ITIS.

Functions

iucn_get_assessment()  : array<string|int, mixed>
Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.
iucn_find_language()  : string
Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.
iucn_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

Constants

_TAXONOMIE_IUCN_CACHE_TIMEOUT

Période de renouvellement du cache de Wikipedia (6 mois).

public mixed _TAXONOMIE_IUCN_CACHE_TIMEOUT = 86400 * 30 * 6

_TAXONOMIE_IUCN_ENDPOINT_BASE_URL

Préfixe des URL du service web de WIKIPEDIA.

public mixed _TAXONOMIE_IUCN_ENDPOINT_BASE_URL = 'http://apiv3.iucnredlist.org/api/v3/'

_TAXONOMIE_IUCN_REDLIST

URL de base d'une page d'un taxon sur le site de la red list IUCN.

public mixed _TAXONOMIE_IUCN_REDLIST = 'https://www.iucnredlist.org/'

Cette URL est fournie dans les credits.

_TAXONOMIE_IUCN_SITE_URL

URL de la page d'accueil du site ITIS.

public mixed _TAXONOMIE_IUCN_SITE_URL = 'https://www.iucn.org/'

Cette URL est fournie dans les credits.

Functions

iucn_get_assessment()

Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.

iucn_get_assessment(array<string|int, mixed> $search) : array<string|int, mixed>
Parameters
$search : array<string|int, mixed>

Tableau contenant le taxon à cherché sous une forme textuelle et numérique:

  • name : chaine de recherche qui est en généralement le nom scientifique du taxon.
  • tsn : identifiant ITIS du taxon, le TSN. Etant donné que ce service s'utilise toujours sur un taxon existant le TSN existe toujours. Il sert à créer le fichier cache.
Tags
uses
cache_est_valide()
uses
iucn_build_url()
uses
inc_taxonomie_requeter_dist()
uses
cache_ecrire()
uses
cache_lire()
Return values
array<string|int, mixed>

Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:

  • nom_scientifique : le nom scientifique complet du taxon tel qu'il doit être affiché (avec capitales).
  • rang : le nom anglais du rang taxonomique du taxon
  • regne : le nom scientifique du règne du taxon en minuscules

iucn_find_language()

Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.

iucn_find_language(string $spip_language) : string
Parameters
$spip_language : string

Code de langue de SPIP. Prend les valeurs fr, en, es, etc. La variable globale $iucn_language définit le transcodage langue IUCNs vers code SPIP.

Return values
string

Langue au sens de IUCN - fre, eng, spa - ou chaine vide sinon.

iucn_credit()

Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

iucn_credit(int $id_taxon, array<string|int, mixed> $informations) : string
Parameters
$id_taxon : int

Id du taxon nécessaire pour construire l'url de la page Wikipedia concernée.

$informations : array<string|int, mixed>

Tableau des informations complémentaires sur la source. Pour IUCN ce tableau fourni le ou les champs remplis avec IUCN.

Return values
string

Phrase de crédit.


        
On this page

Search results