SPIP Code

Documentation du code de SPIP et de ses plugins

Taxonomie

TAXON

Table of Contents

Functions

formulaires_charger_regne_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose de charger ou vider un des 3 règnes gérés par Taxonomie. Pour le chargement d'un règne, le formulaire propose de choisir les langues vernaculaires à utiliser parmi celles supportées par le plugin.
formulaires_charger_regne_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`vider` ou `charger`) et un règne.
formulaires_charger_regne_traiter()  : array<string|int, mixed>
Exécution du formulaire : le règne choisi est soit vidé, soit chargé jusqu'au rang genre en y intégrant les traductions des noms communs sélectionnées.
formulaires_decrire_taxon_charger()  : array<string|int, mixed>
Chargement des données : le formulaire récupère une page wikipedia pour le descriptif du taxon.
formulaires_decrire_taxon_verifier_1()  : array<string|int, mixed>
Vérification de l'étape 1 du formulaire : si une langue est choisie, on charge la page recherchée et les liens vers les autres pages éventuelles. Si aucun page n'est disponible on renvoie un message d'erreur.
formulaires_decrire_taxon_traiter()  : array<string|int, mixed>
Exécution du formulaire : si une page est choisie et existe le descriptif est inséré dans le taxon concerné et le formulaire renvoie sur la page d'édition du taxon.
formulaires_editer_taxon_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité.
formulaires_editer_taxon_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition de taxon.
formulaires_editer_taxon_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire d'édition de taxon.
formulaires_editer_taxon_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'édition de taxon.
formulaires_nommer_taxon_charger()  : array<string|int, mixed>
Chargement des données : le formulaire récupère une page wikipedia pour le descriptif du taxon.
formulaires_nommer_taxon_verifier()  : array<string|int, mixed>
Vérification du formulaire : on doit au moins choisir un nom commun.
formulaires_nommer_taxon_traiter()  : array<string|int, mixed>
Exécution du formulaire : si une page est choisie et existe le descriptif est inséré dans le taxon concerné et le formulaire renvoie sur la page d'édition du taxon.
taxon_preserver()  : array<string|int, mixed>
Extrait, de la table `spip_taxons`, la liste des taxons non espèce d'un règne donné - importés via un fichier ITIS - ayant fait l'objet d'une modification manuelle et la liste des taxons non espèce créés lors de l'ajout d'une espèce et donc non importés avec le fichier ITIS.
taxon_merger_traductions()  : string
Fusionne les traductions d'une balise `<multi>` avec celles d'une autre balise `<multi>`.
taxon_traduire_champ()  : string
Traduit un champ de la table `spip_taxons` dans la langue du site.
taxon_lister_services()  : array<string|int, mixed>
Renvoie la liste des services de taxonomie utilisés par le plugin en tenant compte de la configuration choisi par le webmestre.
taxonomie_autoriser()  : mixed
Fonction d'appel pour le pipeline.
autoriser_taxon_creer_dist()  : bool
Autorisation de créer un taxon.
autoriser_taxon_modifier_dist()  : bool
Autorisation de modifier un taxon.
autoriser_taxon_supprimer_dist()  : bool
Autorisation de supprimer un taxon - aucun taxon ne peut être supprimé individuellement.
autoriser_taxon_voir_dist()  : bool
Autorisation de voir un taxon.
autoriser_taxon_iconifier_dist()  : bool
Autorisation d'iconifier un taxon.
autoriser_taxon_instituer_dist()  : bool
Autorisation de modifier le statut d'un taxon.
autoriser_taxons_voir_dist()  : bool
Autorisation de voir la liste des taxons.
autoriser_taxons_menu_dist()  : bool
Autorisation sur l'entrée de menu affichant la liste des taxons.
autoriser_especes_menu_dist()  : bool
Autorisation de voir un élément de menu, à savoir celui des espèces.
autoriser_espece_creer_dist()  : bool
Autorisation de créer une espèce.
autoriser_espececreer_menu_dist()  : bool
Autorisation de voir le bouton d'accès rapide de création d'une espèce.
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.
taxonomie_pre_edition()  : array<string|int, mixed>
Surcharge l'action `modifier` d'un taxon en positionnant l'indicateur d'édition à `oui` afin que les modifications manuelles du taxon soient préservées lors d'un prochain rechargement du règne.
taxonomie_post_edition()  : array<string|int, mixed>
Surcharge l'action `instituer` d'un taxon.

Functions

formulaires_charger_regne_charger()

Chargement des données : le formulaire propose de charger ou vider un des 3 règnes gérés par Taxonomie. Pour le chargement d'un règne, le formulaire propose de choisir les langues vernaculaires à utiliser parmi celles supportées par le plugin.

formulaires_charger_regne_charger() : array<string|int, mixed>
Tags
uses
regne_existe()
Return values
array<string|int, mixed> —

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro.

  • _actions_regnes : (affichage) alias et libellés des actions possibles sur un règne, charger et vider
  • _actions_disable : (affichage) liste des actions désactivées (vider si le règne n`est pas chargé)
  • _action_defaut : (affichage) action sélectionnée par défaut, charger
  • _regnes : (affichage) noms scientifiques et libellés des règnes supportés par le plugin
  • _langues_regne : (affichage) codes de langue SPIP et libellés des langues utilisées (configuration)
  • _langue_defaut : (affichage) la première langue de la liste des langues utilisées

formulaires_charger_regne_verifier()

Vérification des saisies : il est indispensable de choisir une action (`vider` ou `charger`) et un règne.

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

Un rang minimal est toujours sélectionné. La saisie des langues des noms communs est optionnelle.

Return values
array<string|int, mixed> —

Tableau des erreurs sur l'action et/ou le règne ou tableau vide si aucune erreur.

formulaires_charger_regne_traiter()

Exécution du formulaire : le règne choisi est soit vidé, soit chargé jusqu'au rang genre en y intégrant les traductions des noms communs sélectionnées.

formulaires_charger_regne_traiter() : array<string|int, mixed>
Tags
uses
regne_existe()
uses
regne_vider()
uses
regne_charger()
Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

formulaires_decrire_taxon_charger()

Chargement des données : le formulaire récupère une page wikipedia pour le descriptif du taxon.

formulaires_decrire_taxon_charger(int $id_taxon, string $element) : array<string|int, mixed>

Le formulaire propose une page par défaut mais aussi une liste d'autres pages qui matchent avec le taxon.

Parameters
$id_taxon : int

Id du taxon concerné.

$element : string

Elément de contenu qui sera initialisé. Prend les valeurs texte ou descriptif.

Tags
uses
wikipedia_get_page()
uses
convertisseur_texte_spip()
Return values
array<string|int, mixed> —

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro.

  • _langues : tableau des noms de langue utilisables indexé par le code de langue SPIP (étape 1).
  • _langue_defaut : code de langue SPIP par défaut (étape 1).
  • langue : code de langue SPIP choisi lors de l'étape 1
  • _liens : liste des liens possibles pour la recherche (étape 2)
  • _lien_defaut : lien par défaut (étape 2)
  • _page : texte de la page trouvée ou choisie par l'utilisateur (étape 2)
  • _etapes : nombre d'étapes du formulaire, à savoir, 2.

formulaires_decrire_taxon_verifier_1()

Vérification de l'étape 1 du formulaire : si une langue est choisie, on charge la page recherchée et les liens vers les autres pages éventuelles. Si aucun page n'est disponible on renvoie un message d'erreur.

formulaires_decrire_taxon_verifier_1(int $id_taxon, string $element) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$element : string

Elément de contenu qui sera initialisé. Prend les valeurs texte ou descriptif.

Tags
uses
wikipedia_get_page()
uses
convertisseur_texte_spip()
Return values
array<string|int, mixed> —

Message d'erreur si aucune page n'est disponible ou chargement des champs utiles à l'étape 2 sinon. Ces champs sont :

  • _liens : liste des liens possibles pour la recherche (étape 2)
  • _lien_defaut : lien par défaut (étape 2)
  • _page : texte de la page trouvée ou choisie par l'utilisateur (étape 2)

formulaires_decrire_taxon_traiter()

Exécution du formulaire : si une page est choisie et existe le descriptif est inséré dans le taxon concerné et le formulaire renvoie sur la page d'édition du taxon.

formulaires_decrire_taxon_traiter(int $id_taxon, string $element) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$element : string

Elément de contenu qui sera initialisé. Prend les valeurs texte ou descriptif.

Tags
uses
wikipedia_get_page()
uses
convertisseur_texte_spip()
uses
taxon_merger_traductions()
Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

formulaires_editer_taxon_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité.

formulaires_editer_taxon_identifier_dist([null|int|string $id_taxon = 'new' ][, null|string $retour = '' ][, null|int $lier_trad = 0 ][, null|string $config_fonc = '' ][, null|array<string|int, mixed> $row = [] ][, null|string $hidden = '' ]) : string
Parameters
$id_taxon : null|int|string = 'new'

Identifiant du taxon. 'new' pour un nouveau taxon.

$retour : null|string = ''

URL de redirection après le traitement

$lier_trad : null|int = 0

Identifiant éventuel d'un taxon source d'une traduction

$config_fonc : null|string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : null|array<string|int, mixed> = []

Valeurs de la ligne SQL du taxon, si connu

$hidden : null|string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string —

Hash du formulaire

formulaires_editer_taxon_charger_dist()

Chargement du formulaire d'édition de taxon.

formulaires_editer_taxon_charger_dist([null|int|string $id_taxon = 'new' ][, null|string $retour = '' ][, null|int $lier_trad = 0 ][, null|string $config_fonc = '' ][, null|array<string|int, mixed> $row = [] ][, null|string $hidden = '' ]) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut.

Parameters
$id_taxon : null|int|string = 'new'

Identifiant du taxon. 'new' pour un nouveau taxon.

$retour : null|string = ''

URL de redirection après le traitement

$lier_trad : null|int = 0

Identifiant éventuel d'un taxon source d'une traduction

$config_fonc : null|string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : null|array<string|int, mixed> = []

Valeurs de la ligne SQL du taxon, si connu

$hidden : null|string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

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

Environnement du formulaire.

formulaires_editer_taxon_verifier_dist()

Vérifications du formulaire d'édition de taxon.

formulaires_editer_taxon_verifier_dist([null|int|string $id_taxon = 'new' ][, null|string $retour = '' ][, null|int $lier_trad = 0 ][, null|string $config_fonc = '' ][, null|array<string|int, mixed> $row = [] ][, null|string $hidden = '' ]) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs.

Parameters
$id_taxon : null|int|string = 'new'

Identifiant du taxon. 'new' pour un nouveau taxon.

$retour : null|string = ''

URL de redirection après le traitement

$lier_trad : null|int = 0

Identifiant éventuel d'un taxon source d'une traduction

$config_fonc : null|string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : null|array<string|int, mixed> = []

Valeurs de la ligne SQL du taxon, si connu

$hidden : null|string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

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

Tableau des erreurs indexé par le nom du champ en erreur.

formulaires_editer_taxon_traiter_dist()

Traitement du formulaire d'édition de taxon.

formulaires_editer_taxon_traiter_dist([null|int|string $id_taxon = 'new' ][, null|string $retour = '' ][, null|int $lier_trad = 0 ][, null|string $config_fonc = '' ][, null|array<string|int, mixed> $row = [] ][, null|string $hidden = '' ]) : array<string|int, mixed>

Traiter les champs postés.

Parameters
$id_taxon : null|int|string = 'new'

Identifiant du taxon. 'new' pour un nouveau taxon.

$retour : null|string = ''

URL de redirection après le traitement

$lier_trad : null|int = 0

Identifiant éventuel d'un taxon source d'une traduction

$config_fonc : null|string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : null|array<string|int, mixed> = []

Valeurs de la ligne SQL du taxon, si connu

$hidden : null|string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

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

Retours des traitements.

formulaires_nommer_taxon_charger()

Chargement des données : le formulaire récupère une page wikipedia pour le descriptif du taxon.

formulaires_nommer_taxon_charger(int $id_taxon[, null|int $cle_gbif = 0 ]) : array<string|int, mixed>

Le formulaire propose une page par défaut mais aussi une liste d'autres pages qui matchent avec le taxon.

Parameters
$id_taxon : int

Id du taxon concerné.

$cle_gbif : null|int = 0

Identifiant GBIF du taxon ou 0 si pas encore connu.

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

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro.

  • _langues : tableau des noms de langue utilisables indexé par le code de langue SPIP (étape 1).

formulaires_nommer_taxon_verifier()

Vérification du formulaire : on doit au moins choisir un nom commun.

formulaires_nommer_taxon_verifier(int $id_taxon[, null|int $cle_gbif = 0 ]) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$cle_gbif : null|int = 0

Identifiant GBIF du taxon ou 0 si pas encore connu.

Return values
array<string|int, mixed> —

Message d'erreur saisie obligatoire si aucun nom n'est choisi

formulaires_nommer_taxon_traiter()

Exécution du formulaire : si une page est choisie et existe le descriptif est inséré dans le taxon concerné et le formulaire renvoie sur la page d'édition du taxon.

formulaires_nommer_taxon_traiter(int $id_taxon[, null|int $cle_gbif = 0 ]) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$cle_gbif : null|int = 0

Identifiant GBIF du taxon ou 0 si pas encore connu.

Tags
uses
wikipedia_get_page()
uses
convertisseur_texte_spip()
uses
taxon_merger_traductions()
Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

taxon_preserver()

Extrait, de la table `spip_taxons`, la liste des taxons non espèce d'un règne donné - importés via un fichier ITIS - ayant fait l'objet d'une modification manuelle et la liste des taxons non espèce créés lors de l'ajout d'une espèce et donc non importés avec le fichier ITIS.

taxon_preserver(string $regne) : array<string|int, mixed>
Parameters
$regne : string

Nom scientifique du règne en lettres minuscules : animalia, plantae, fungi.

Tags
used-by
regne_charger()
Return values
array<string|int, mixed> —

Liste des taxons modifiées manuellement et créés suite à l'ajout d'une espèce. Chaque élément de la liste est un tableau composé, pour les taxons modifiés manuellement des index tsn, nom_commun, descriptif et pour les taxons créés via une espèce de tous les champs de l'objet taxon, à l'exception de l'id (id_taxon) et de la date de mise à jour (maj).

taxon_merger_traductions()

Fusionne les traductions d'une balise `<multi>` avec celles d'une autre balise `<multi>`.

taxon_merger_traductions(string $multi_prioritaire, string $multi_non_prioritaire) : string

L'une des balise est considérée comme prioritaire ce qui permet de régler le cas où la même langue est présente dans les deux balises. Si on ne trouve pas de balise <multi> dans l'un ou l'autre des paramètres, on considère que le texte est tout même formaté de la façon suivante : texte0[langue1]texte1[langue2]texte2...

Parameters
$multi_prioritaire : string

Balise multi considérée comme prioritaire en cas de conflit sur une langue.

$multi_non_prioritaire : string

Balise multi considérée comme non prioritaire en cas de conflit sur une langue.

Tags
used-by
formulaires_decrire_taxon_traiter()
used-by
formulaires_nommer_taxon_traiter()
Return values
string —

La chaine construite est toujours une balise <multi> complète ou une chaine vide sinon.

taxon_traduire_champ()

Traduit un champ de la table `spip_taxons` dans la langue du site.

taxon_traduire_champ(string $champ) : string
Parameters
$champ : string

Nom du champ dans la base de données.

Return values
string —

Traduction du champ dans la langue du site.

taxon_lister_services()

Renvoie la liste des services de taxonomie utilisés par le plugin en tenant compte de la configuration choisi par le webmestre.

taxon_lister_services() : array<string|int, mixed>
Tags
used-by
taxonomie_apirest_cache_formulaire_charger()
Return values
array<string|int, mixed> —

Tableau des services utilisés sous la forme [alias] = titre du service.

autoriser_taxon_creer_dist()

Autorisation de créer un taxon.

autoriser_taxon_creer_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • Il faut être au moins rédacteur.
Parameters
$faire : string

Action demandée : creer

$type : string

Type d'objet ou élément : taxon

$id : null|int|string

Identifiant du taxon : inutilisé puisque création

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxon_modifier_dist()

Autorisation de modifier un taxon.

autoriser_taxon_modifier_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • il faut pouvoir en créer un
  • et que l'id soit précisé et corresponde à celui d'un taxon existant.
Parameters
$faire : string

Action demandée : modifier

$type : string

Type d'objet ou élément : object taxon

$id : null|int|string

Identifiant du taxon

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxon_supprimer_dist()

Autorisation de supprimer un taxon - aucun taxon ne peut être supprimé individuellement.

autoriser_taxon_supprimer_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée : supprimer

$type : string

Type d'objet ou élément : taxon

$id : null|int|string

Identifiant du taxon

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxon_voir_dist()

Autorisation de voir un taxon.

autoriser_taxon_voir_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • tout le monde est autorisé.
Parameters
$faire : string

Action demandée : voir

$type : string

Type d'objet ou élément : taxon

$id : null|int|string

Identifiant du taxon

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxon_iconifier_dist()

Autorisation d'iconifier un taxon.

autoriser_taxon_iconifier_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • il faut pouvoir modifier le taxon
  • sachant que seules les espèces et les taxons de rang inférieur possède un logo.
Parameters
$faire : string

Action demandée : iconifier

$type : string

Type d'objet ou élément : taxon

$id : null|int|string

Identifiant du taxon

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxon_instituer_dist()

Autorisation de modifier le statut d'un taxon.

autoriser_taxon_instituer_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Cela n'est possible que :

  • si l'auteur possède l'autorisation de modifier le taxon
  • et le taxon est une espèce
  • et que l'espèce est soit une feuille de la hiérarchie soit possède des enfants dont aucun n'est au statut publié.
Parameters
$faire : string

Action demandée : instituer

$type : string

Type d'objet ou élément : taxon

$id : null|int|string

Identifiant du taxon

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxons_voir_dist()

Autorisation de voir la liste des taxons.

autoriser_taxons_voir_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • tout le monde est autorisé.
Parameters
$faire : string

Action demandée : voir

$type : string

Type d'objet ou élément : pas un objet mais _taxons pour indiquer la liste

$id : null|int|string

Identifiant du taxon : inutilisé

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_taxons_menu_dist()

Autorisation sur l'entrée de menu affichant la liste des taxons.

autoriser_taxons_menu_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • même autorisation que voir_taxons, c'est-à-dire, tout le monde.
Parameters
$faire : string

Action demandée : menu

$type : string

Type d'objet ou élément : pas un objet mais _taxons pour indiquer la liste

$id : null|int|string

Identifiant du taxon : inutilisé

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_especes_menu_dist()

Autorisation de voir un élément de menu, à savoir celui des espèces.

autoriser_especes_menu_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • tout le monde est autorisé.
Parameters
$faire : string

Action demandée : menu

$type : string

Type d'objet ou élément : pas un objet mais _especes pour indiquer la liste

$id : null|int|string

Identifiant du taxon : inutilisé

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_espece_creer_dist()

Autorisation de créer une espèce.

autoriser_espece_creer_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • il faut pouvoir créer un taxon (une espèce est un taxon particulier)
  • et qu'un règne est au moins déjà chargé.
Parameters
$faire : string

Action demandée : creer

$type : string

Type d'objet ou élément : pseudo objet espece

$id : null|int|string

Identifiant du taxon : inutilisé puisque création

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

autoriser_espececreer_menu_dist()

Autorisation de voir le bouton d'accès rapide de création d'une espèce.

autoriser_espececreer_menu_dist(string $faire, string $type, null|int|string $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • il faut pouvoir créer une espèce.
Parameters
$faire : string

Action demandée : menu

$type : string

Type d'objet ou élément : élement de menu espececreer

$id : null|int|string

Identifiant du taxon : inutilisé

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation : inutilisé

Return values
bool —

true si l'autorisation est donnée, false sinon

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.

taxonomie_pre_edition()

Surcharge l'action `modifier` d'un taxon en positionnant l'indicateur d'édition à `oui` afin que les modifications manuelles du taxon soient préservées lors d'un prochain rechargement du règne.

taxonomie_pre_edition(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).

Tags
pipeline

pre_edition

Return values
array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

taxonomie_post_edition()

Surcharge l'action `instituer` d'un taxon.

taxonomie_post_edition(array<string|int, mixed> $flux) : array<string|int, mixed>

Si une espèce est instituée à publié, alors ses ascendants de type espèce non encore publiés sont automatiquement publiés.

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

Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).

Tags
pipeline

post_edition

Return values
array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results