Documentation du code de SPIP et de ses plugins

Taxonomie

Application

Table of Contents

Constants

_EXTRAIRE_MULTI  = '@<multi>(.*?)</multi>@sS'
Restaure cette constante à partir de SPIP 4.2.
_TAXONOMIE_LANGUES_POSSIBLES  = 'fr:en:es:pt:de:it'
Liste des langues utilisables pour les noms communs et les textes des taxons.
_TAXONOMIE_RANG_ESPECE  = 'species'
Nom anglais du rang principal `espèce`.
_TAXONOMIE_RANG_GENRE  = 'genus'
Nom anglais du rang principal `genre`.
_TAXONOMIE_RANG_REGNE  = 'kingdom'
Nom anglais du rang principal `règne`.
_TAXONOMIE_RANGS  = ['kingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subkingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infrakingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superdivision'], 'phylum' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'division'], 'subphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subdivision'], 'infraphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infradivision'], 'superdivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superphylum'], 'division' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'phylum'], 'subdivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subphylum'], 'infradivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infraphylum'], 'superclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'class' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infraclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superorder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'order' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'suborder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infraorder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'section' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''], 'subsection' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superfamily' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'family' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subfamily' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'tribe' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''], 'subtribe' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'genus' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subgenus' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'species' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \true, 'synonyme' => ''], 'subspecies' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'variety' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''], 'subvariety' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'form' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''], 'subform' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'race' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => 'variety'], 'stirp' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'morph' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'aberration' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'unspecified' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => '']]
Liste des règnes utilisés par Taxonomie TODO : vérifier les rangs stirp, morph, aberration, unspecified.
_TAXONOMIE_REGNES  = ['animalia', 'plantae', 'fungi']
Liste des règnes utilisés par Taxonomie.
_TAXONOMIE_TYPE_RANG_INTERCALAIRE  = 'intercalaire'
Type de rang selon la nomenclature taxonomique.
_TAXONOMIE_TYPE_RANG_PRINCIPAL  = 'principal'
Type de rang selon la nomenclature taxonomique.
_TAXONOMIE_TYPE_RANG_SECONDAIRE  = 'secondaire'
Type de rang selon la nomenclature taxonomique.

Functions

action_taxon_evaluer_iucn_dist()  : void
Cette action permet de mettre à jour les champs statut_iucn et evaluation_iucn qui fournissent le détail de l'état de conservation de l'espèce.
taxonomie_cache_configurer()  : array<string|int, mixed>
Renvoie la configuration spécifique des types de cache de Taxonomie.
taxonomie_apirest_cache_completer()  : array<string|int, mixed>
Complète la description canonique d'un cache de type `apirest`.
taxonomie_apirest_cache_formulaire_charger()  : array<string|int, mixed>
Effectue le chargement du formulaire de vidage des caches pour le plugin Taxonomie.
taxonomie_ieconfig()  : array<string|int, mixed>
Pipeline ieconfig pour l'import/export des données de configuration du plugin et de certaines données de production.
taxonomie_ieconfig_exporter()  : array<string|int, mixed>
Retourne le tableau d'export du plugin Taxonomie contenant toujours sa configuration et les taxons nécessitant d'être sauvegardés car non créés via les fichiers ITIS.
taxonomie_ieconfig_importer()  : bool
Importe tout ou partie d'un fichier d'export ieconfig contenant les données du noiZetier.
taxonomie_importer_taxons()  : void
Importe les taxons dans la base de données à partir d'une sauvegarde ieconfig.

Constants

_EXTRAIRE_MULTI

Restaure cette constante à partir de SPIP 4.2.

public mixed _EXTRAIRE_MULTI = '@<multi>(.*?)</multi>@sS'

_TAXONOMIE_LANGUES_POSSIBLES

Liste des langues utilisables pour les noms communs et les textes des taxons.

public mixed _TAXONOMIE_LANGUES_POSSIBLES = 'fr:en:es:pt:de:it'

_TAXONOMIE_RANG_ESPECE

Nom anglais du rang principal `espèce`.

public mixed _TAXONOMIE_RANG_ESPECE = 'species'

_TAXONOMIE_RANG_GENRE

Nom anglais du rang principal `genre`.

public mixed _TAXONOMIE_RANG_GENRE = 'genus'

_TAXONOMIE_RANG_REGNE

Nom anglais du rang principal `règne`.

public mixed _TAXONOMIE_RANG_REGNE = 'kingdom'

_TAXONOMIE_RANGS

Liste des règnes utilisés par Taxonomie TODO : vérifier les rangs stirp, morph, aberration, unspecified.

public mixed _TAXONOMIE_RANGS = ['kingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subkingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infrakingdom' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superdivision'], 'phylum' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'division'], 'subphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subdivision'], 'infraphylum' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infradivision'], 'superdivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superphylum'], 'division' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'phylum'], 'subdivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subphylum'], 'infradivision' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infraphylum'], 'superclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'class' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infraclass' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superorder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'order' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'suborder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'infraorder' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'section' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''], 'subsection' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'superfamily' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'family' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subfamily' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'tribe' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''], 'subtribe' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'genus' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''], 'subgenus' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''], 'species' => ['type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \true, 'synonyme' => ''], 'subspecies' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'variety' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''], 'subvariety' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'form' => ['type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''], 'subform' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'race' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => 'variety'], 'stirp' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'morph' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'aberration' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''], 'unspecified' => ['type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => '']]

TODO : vérifier pourquoi le rang serie n'est pas dans la liste de ITIS.

_TAXONOMIE_REGNES

Liste des règnes utilisés par Taxonomie.

public mixed _TAXONOMIE_REGNES = ['animalia', 'plantae', 'fungi']

_TAXONOMIE_TYPE_RANG_INTERCALAIRE

Type de rang selon la nomenclature taxonomique.

public mixed _TAXONOMIE_TYPE_RANG_INTERCALAIRE = 'intercalaire'

_TAXONOMIE_TYPE_RANG_PRINCIPAL

Type de rang selon la nomenclature taxonomique.

public mixed _TAXONOMIE_TYPE_RANG_PRINCIPAL = 'principal'

_TAXONOMIE_TYPE_RANG_SECONDAIRE

Type de rang selon la nomenclature taxonomique.

public mixed _TAXONOMIE_TYPE_RANG_SECONDAIRE = 'secondaire'

Functions

action_taxon_evaluer_iucn_dist()

Cette action permet de mettre à jour les champs statut_iucn et evaluation_iucn qui fournissent le détail de l'état de conservation de l'espèce.

action_taxon_evaluer_iucn_dist() : void

Cette action est réservée aux utilisateurs ayant l'autorisation de modifier un taxon. Elle nécessite un argument, l'id du taxon.

taxonomie_cache_configurer()

Renvoie la configuration spécifique des types de cache de Taxonomie.

taxonomie_cache_configurer(string $plugin) : array<string|int, mixed>
Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

Return values
array<string|int, mixed>

Tableau de la configuration brute des caches du plugin Taxonomie.

taxonomie_apirest_cache_completer()

Complète la description canonique d'un cache de type `apirest`.

taxonomie_apirest_cache_completer(string $plugin, array<string|int, mixed> $cache, string $fichier_cache, array<string|int, mixed> $configuration) : array<string|int, mixed>

Le plugin Taxonomie rajoute le nom scientifique du taxon.

Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

$cache : array<string|int, mixed>

Tableau identifiant le cache pour lequel on veut construire le nom.

$fichier_cache : string

Fichier cache désigné par son chemin complet.

$configuration : array<string|int, mixed>

Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.

Return values
array<string|int, mixed>

Description du cache complétée par un ensemble de données propres au plugin.

taxonomie_apirest_cache_formulaire_charger()

Effectue le chargement du formulaire de vidage des caches pour le plugin Taxonomie.

taxonomie_apirest_cache_formulaire_charger(string $plugin, array<string|int, mixed> $valeurs, array<string|int, mixed> $options, array<string|int, mixed> $configuration) : array<string|int, mixed>

L'intérêt est de permette le rangement des caches par service.

Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

$valeurs : array<string|int, mixed>

Tableau des valeurs du formulaire à compléter

$options : array<string|int, mixed>

Tableau d'options (non utilisé par défaut)

$configuration : array<string|int, mixed>

Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.

Tags
uses
taxon_lister_services()
Return values
array<string|int, mixed>

Tableau des valeurs spécifique au plugin taxonomie.

taxonomie_ieconfig()

Pipeline ieconfig pour l'import/export des données de configuration du plugin et de certaines données de production.

taxonomie_ieconfig(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

taxonomie_ieconfig_exporter()

Retourne le tableau d'export du plugin Taxonomie contenant toujours sa configuration et les taxons nécessitant d'être sauvegardés car non créés via les fichiers ITIS.

taxonomie_ieconfig_exporter() : array<string|int, mixed>

Les taxons concernés sont :

  • les taxons du règne au genre, importés via les fichiers ITIS puis édités manuellement;
  • les taxons ascendants d'une espèce (entre le genre et l'espèce non compris), non inclus dans un fichier ITIS et insérés lors de la création d'une espèce;
  • les taxons de type espèce et descendants créés manuellement.
Return values
array<string|int, mixed>

Tableau d'export pour le pipeline ieconfig_exporter.

taxonomie_ieconfig_importer()

Importe tout ou partie d'un fichier d'export ieconfig contenant les données du noiZetier.

taxonomie_ieconfig_importer(array<string|int, mixed> $importation, array<string|int, mixed> $contenu_import) : bool
Parameters
$importation : array<string|int, mixed>

Tableau associatif des demandes d'importation issues du formulaire ieconfig. Les index et les valeurs possibles sont :

  • configuration : vaut on pour importer ou null sinon
  • pages_explicites : vaut on pour importer ou null sinon
  • compositions_virtuelles : vaut remplacer, ajouter ou fusionner pour importer ou null sinon.
  • noisettes : vaut remplacer ou ajouter pour importer ou null sinon.
$contenu_import : array<string|int, mixed>

Tableau des données du noiZetier issues du fichier d'import.

Return values
bool

true si l'importation s'est bien passée, false sinon.

taxonomie_importer_taxons()

Importe les taxons dans la base de données à partir d'une sauvegarde ieconfig.

taxonomie_importer_taxons(array<string|int, mixed> $taxons, string $action[, null|bool $taxons_edites = false ]) : void
Parameters
$taxons : array<string|int, mixed>

Liste des taxons à importer

$action : string

Action d'importation : fusionner ou ajouter

$taxons_edites : null|bool = false

Indique si il faut traiter les taxons édités


        
On this page

Search results