REGNE
Table of Contents
Functions
- regne_charger() : bool
- Charge tous les taxons d'un règne donné fourni dans le fichier ITIS, du règne lui-même jusqu'aux taxons de genre.
- regne_vider() : bool
- Supprime de la base de données tous les taxons importés à partir du rapport hiérarchique d'un règne donné.
- regne_existe() : bool
- Retourne l'existence ou pas d'un règne en base de données.
- regne_lister_defaut() : array<string|int, mixed>
- Renvoie la liste des règnes supportés par le plugin.
- regne_repertorier() : array<string|int, mixed>
- Renvoie la liste des règnes effectivement chargés en base de données.
Functions
regne_charger()
Charge tous les taxons d'un règne donné fourni dans le fichier ITIS, du règne lui-même jusqu'aux taxons de genre.
regne_charger(string $regne[, null|array<string|int, mixed> $codes_langue = [] ]) : bool
Les nom communs anglais, français, espagnols, etc, peuvent aussi être chargés en complément mais ne couvrent pas l'ensemble des taxons. Le modifications effectuées manuellement sur ces taxons sont conservées.
Parameters
- $regne : string
-
Nom scientifique du règne en lettres minuscules :
animalia,plantae,fungi. - $codes_langue : null|array<string|int, mixed> = []
-
Tableau des codes des langues (au sens SPIP) à charger pour les noms communs des taxons.
Tags
Return values
bool —true si le chargement a réussi, false sinon
regne_vider()
Supprime de la base de données tous les taxons importés à partir du rapport hiérarchique d'un règne donné.
regne_vider(string $regne) : bool
La meta concernant les informations de chargement du règne est aussi effacée. Les modifications manuelles effectuées sur ces taxons sont effacées : elles doivent donc être préservées au préalable.
Parameters
- $regne : string
-
Nom scientifique du règne en lettres minuscules :
animalia,plantae,fungi.
Tags
Return values
bool —true si le vidage a réussi, false sinon
regne_existe()
Retourne l'existence ou pas d'un règne en base de données.
regne_existe(string $regne[, null|array<string|int, mixed> &$meta_regne = [] ]) : bool
La fonction scrute les taxons importés de la table spip_taxons et non la meta propre au règne.
Parameters
- $regne : string
-
Nom scientifique du règne en lettres minuscules :
animalia,plantae,fungi. - $meta_regne : null|array<string|int, mixed> = []
-
Meta propre au règne, créée lors du chargement de celui-ci et retournée si le règne existe.
Tags
Return values
bool —true si le règne existe, false sinon.
regne_lister_defaut()
Renvoie la liste des règnes supportés par le plugin.
regne_lister_defaut() : array<string|int, mixed>
Return values
array<string|int, mixed> —Liste des noms scientifiques en minuscules des règnes supportés.
regne_repertorier()
Renvoie la liste des règnes effectivement chargés en base de données.
regne_repertorier() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Liste des noms scientifiques (en minuscules) des règnes chargés ou tableau vide.