Documentation du code de SPIP et de ses plugins

Taxonomie

taxonomie_fonctions.php

Ce fichier contient les fonctions d'API du plugin Taxonomie utilisées comme filtre dans les squelettes.

Les autres fonctions de l'API sont dans le fichier inc/taxonomie.

Table of Contents

Functions

taxon_informer_ascendance()  : array<string|int, mixed>
Fournit l'ascendance taxonomique d'un taxon donné, par consultation dans la base de données.
taxon_crediter()  : array<string|int, mixed>
Fournit les phrases de crédit des sources d'information ayant permis de compléter le taxon.
taxon_afficher_statut()  : string
Affiche la puce de statut d'un taxon sans proposer le formulaire de changement de statut.
taxon_formater_evaluation_iucn()  : array<string|int, mixed>
Formate les éléments de l'évaluation IUCN pour un affichage.
regne_repertorier()  : array<string|int, mixed>
Renvoie la liste des règnes effectivement chargés en base de données.

Functions

taxon_informer_ascendance()

Fournit l'ascendance taxonomique d'un taxon donné, par consultation dans la base de données.

taxon_informer_ascendance(int $id_taxon[, null|int $tsn_parent = null ][, null|string $ordre = 'descendant' ]) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon pour lequel il faut fournir l'ascendance.

$tsn_parent : null|int = null

TSN du parent correspondant au taxon id_taxon. Ce paramètre permet d'optimiser le traitement mais n'est pas obligatoire. Si il n'est pas connu lors de l'appel il faut passer null.

$ordre : null|string = 'descendant'

Classement de la liste des taxons : descendant(défaut) ou ascendant.

Tags
filtre
Return values
array<string|int, mixed>

Liste des taxons ascendants. Chaque taxon est un tableau associatif contenant les informations suivantes : id_taxon, tsn_parent, nom_scientifique, nom_commun, rang, statut et l'indicateur d'espèce espèce.

taxon_crediter()

Fournit les phrases de crédit des sources d'information ayant permis de compléter le taxon.

taxon_crediter(int $id_taxon[, null|string $sources_specifiques = null ]) : array<string|int, mixed>

La référence ITIS n'est pas répétée dans le champ sources de chaque taxon car elle est à la base de chaque règne. Elle est donc insérée par la fonction.

Parameters
$id_taxon : int

Id du taxon pour lequel il faut fournir les crédits

$sources_specifiques : null|string = null

Tableau sérialisé des sources possibles autres qu'ITIS (CINFO, WIKIPEDIA...) telles qu'enregistrées en base de données dans le champ sources. Ce paramètre permet d'optimiser le traitement mais n'est pas obligatoire.

Tags
filtre
Return values
array<string|int, mixed>

Tableau des phrases de crédits indexées par source.

taxon_afficher_statut()

Affiche la puce de statut d'un taxon sans proposer le formulaire de changement de statut.

taxon_afficher_statut(string $statut[, null|int $id_taxon = 0 ]) : string
Parameters
$statut : string

Statut du taxon, prop, publieou poubelle.

$id_taxon : null|int = 0

Id du taxon.

Tags
filtre
Return values
string

Image de la puce.

taxon_formater_evaluation_iucn()

Formate les éléments de l'évaluation IUCN pour un affichage.

taxon_formater_evaluation_iucn(array<string|int, mixed> $evaluation) : array<string|int, mixed>

Renvoie un tableau vide si le taxon n'a pas été encore évalué.

Parameters
$evaluation : array<string|int, mixed>

Tableau des éléments de l'évaluation

Tags
filtre
Return values
array<string|int, mixed>

Le tableau formaté ou vide.

regne_repertorier()

Renvoie la liste des règnes effectivement chargés en base de données.

regne_repertorier() : array<string|int, mixed>
Tags
filtre
used-by
formulaires_creer_espece_charger()
Return values
array<string|int, mixed>

Liste des noms scientifiques (en minuscules) des règnes chargés ou tableau vide.


        
On this page

Search results