Documentation du code de SPIP et de ses plugins

Taxonomie

gbif_api.php

Ce fichier contient l'ensemble des constantes et fonctions implémentant le service de taxonomie ITIS.

Table of Contents

Constants

_TAXONOMIE_GBIF_CACHE_TIMEOUT  = 86400 * 30 * 6
Période de renouvellement du cache de GBIF (6 mois).
_TAXONOMIE_GBIF_ENDPOINT_BASE_URL  = 'https://api.gbif.org/v1/'
Préfixe des URL du service web de GBIF.org.
_TAXONOMIE_GBIF_SITE_URL  = 'https://www.gbif.org/fr/'
URL de la page d'accueil du site ITIS.

Functions

gbif_get_vernaculars()  : array<string|int, mixed>
Renvoie les noms vernaculaires dans l'ensemble des langages supportés par Taxonomie pour un taxon identifié par son nom scientifique.
gbif_get_taxonkey()  : int
Renvoie l'identifiant unique GBIF nommé taxonKey à partir du nom scientique du taxon.
gbif_find_language()  : string
Renvoie la langue telle que le service ITIS la désigne à partir du code de langue de SPIP.
gbif_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent de la base de données d'ITIS.

Constants

_TAXONOMIE_GBIF_CACHE_TIMEOUT

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

public mixed _TAXONOMIE_GBIF_CACHE_TIMEOUT = 86400 * 30 * 6

_TAXONOMIE_GBIF_ENDPOINT_BASE_URL

Préfixe des URL du service web de GBIF.org.

public mixed _TAXONOMIE_GBIF_ENDPOINT_BASE_URL = 'https://api.gbif.org/v1/'

_TAXONOMIE_GBIF_SITE_URL

URL de la page d'accueil du site ITIS.

public mixed _TAXONOMIE_GBIF_SITE_URL = 'https://www.gbif.org/fr/'

Cette URL est fournie dans les credits.

Functions

gbif_get_vernaculars()

Renvoie les noms vernaculaires dans l'ensemble des langages supportés par Taxonomie pour un taxon identifié par son nom scientifique.

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

Tableau contenant le taxon à chercher:

  • taxon_key : identifiant numérique unique GBIF.
  • tsn : identifiant ITIS du taxon, le TSN. Il sert uniquement à créer le fichier cache.
Tags
uses
cache_est_valide()
uses
itis_build_url()
uses
inc_taxonomie_requeter_dist()
uses
cache_ecrire()
uses
cache_lire()
Return values
array<string|int, mixed>

Tableau des noms vernaculaires indexés par le code spip du langage.

gbif_get_taxonkey()

Renvoie l'identifiant unique GBIF nommé taxonKey à partir du nom scientique du taxon.

gbif_get_taxonkey(string $nom_scientifique) : int
Parameters
$nom_scientifique : string

Chaine de recherche représentant le nom scientifique du taxon.

Tags
uses
gbif_build_url()
uses
inc_taxonomie_requeter_dist()
Return values
int

Identifiant numérique unique du taxon ou 0 sinon.

gbif_find_language()

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

gbif_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 $GLOBALS['itis_language'] définit le transcodage langue ITIS vers code SPIP.

Return values
string

Langue au sens d'ITIS en minuscules - french, english, spanish - ou chaine vide sinon.

gbif_credit()

Construit la phrase de crédits précisant que les données fournies proviennent de la base de données d'ITIS.

gbif_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 GBIF.

$informations : array<string|int, mixed>

Tableau des informations complémentaires sur la source. Pour GBIF ce tableau est vide.

Return values
string

Phrase de crédit.


        
On this page

Search results