Documentation du code de SPIP et de ses plugins

Taxonomie

Documentation

Packages

Application
SPIP

Table of Contents

_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.
_TAXONOMIE_ITIS_CACHE_TIMEOUT  = 86400 * 30 * 6
Période de renouvellement du cache de Wikipedia (365 jours)
_TAXONOMIE_ITIS_ENDPOINT_BASE_URL  = 'http://www.itis.gov/ITISWebService/'
Préfixe des URL du service web de ITIS.
_TAXONOMIE_ITIS_REGEXP_RANKNAME  = '#(%rank_list%):\\s*(([A-Z]\\s+)?[\\w-]+)\\s*(.+)\\s*\\[(\\d+)\\]\\s*$#'
Ligne d'un fichier ITIS hiérachie généré.
_TAXONOMIE_ITIS_SITE_URL  = 'http://www.itis.gov'
URL de la page d'accueil du site ITIS.
_TAXONOMIE_ITIS_TAXON_BASE_URL  = 'http://www.itis.gov/servlet/SingleRpt/SingleRpt?search_topic=TSN&search_value='
URL de base d'une page d'un taxon sur le site d'ITIS.
_TAXONOMIE_IUCN_CACHE_TIMEOUT  = 86400 * 30 * 6
Période de renouvellement du cache de Wikipedia (6 mois)
_TAXONOMIE_IUCN_ENDPOINT_BASE_URL  = 'http://apiv3.iucnredlist.org/api/v3/'
Préfixe des URL du service web de WIKIPEDIA.
_TAXONOMIE_IUCN_REDLIST  = 'https://www.iucnredlist.org/'
URL de base d'une page d'un taxon sur le site de la red list IUCN.
_TAXONOMIE_IUCN_SITE_URL  = 'https://www.iucn.org/'
URL de la page d'accueil du site ITIS.
_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' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subkingdom' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infrakingdom' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superdivision'), 'phylum' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'division'), 'subphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subdivision'), 'infraphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infradivision'), 'superdivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superphylum'), 'division' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'phylum'), 'subdivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subphylum'), 'infradivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infraphylum'), 'superclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'class' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infraclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superorder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'order' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'suborder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infraorder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'section' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''), 'subsection' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superfamily' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'family' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subfamily' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'tribe' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''), 'subtribe' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'genus' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subgenus' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'species' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \true, 'synonyme' => ''), 'subspecies' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'variety' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''), 'subvariety' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'form' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''), 'subform' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'race' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => 'variety'), 'stirp' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'morph' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'aberration' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'unspecified' => array('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_RECHERCHE_MAX_ESPECES  = 35
Nombre de réponses maximal toléré pour continuer en étape 2.
_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.
_TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT  = 86400 * 30
Période de renouvellement du cache de Wikipedia (30 jours)
_TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL  = 'https://%langue%.wikipedia.org/w/api.php'
Préfixe des URL du service web de WIKIPEDIA.
_TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL  = 'https://%langue%.wikipedia.org/wiki/'
URL de base pour construire une page de Wikipedia dans une langue donnée
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_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des alias de tables et des filtres automatiques de champs.
taxonomie_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclaration des objets éditoriaux du plugin. Le plugin ajoute l'objet taxon au travers de la seule table `spip_taxons` qui contient aussi les taxons de type `espèce`.
tester_taxon_merger_traductions()  : mixed
tester_extraire_multi()  : mixed
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.
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_configurer_taxonomie_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose la liste des langues possibles.
formulaires_configurer_taxonomie_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir au moins une langue.
formulaires_creer_espece_charger()  : array<string|int, mixed>
Chargement des données :
formulaires_creer_espece_verifier_1()  : array<string|int, mixed>
Vérification de l'étape 1 du formulaire :
formulaires_creer_espece_verifier_2()  : array<string|int, mixed>
Vérification de l'étape 2 du formulaire : on présente les informations principales du taxon choisi avant que l'utilisateur ne valide définitivement son choix. En particulier, on affiche la hiérarchie du taxon jusqu'au premier taxon de genre et on identifie les taxons qui seront aussi créés dans cette hiérarchie.
formulaires_creer_espece_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_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.
genie_taxonomie_actualiser_itis_dist()  : int
Ce CRON permet de vérifier si les fichiers ITIS ayant servis à créer la base de taxons initiale ont été modifiés et si oui de déclencher une mise à niveau des taxons.
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.
rang_informer_type()  : string
Renvoie le type de rang principal, secondaire ou intercalaire.
rang_est_espece()  : bool
Détermine si un rang est celui d'une espèce ou d'un taxon de rang inférieur.
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.
inc_taxonomie_requeter_dist()  : array<string|int, mixed>
Renvoie, à partir de l'url du service, le tableau des données demandées.
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.
itis_search_tsn()  : array<string|int, mixed>
Recherche un taxon dans la base ITIS par son nom commun ou scientifique et retourne son identifiant unique nommé TSN ou 0 si le taxon n'existe pas.
itis_get_record()  : array<string|int, mixed>
Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.
itis_get_information()  : string|int|array<string|int, mixed>
Renvoie les informations demandées sur un taxon désigné par son identifiant unique TSN.
itis_list_vernaculars()  : array<string|int, mixed>
Renvoie la liste des noms communs définis pour certains taxons dans une langue donnée mais tout règne confondu.
itis_read_hierarchy()  : array<string|int, mixed>
Lit le fichier hiérarchique ITIS des taxons d'un règne et renvoie la liste des taxons retenus.
itis_read_vernaculars()  : array<string|int, mixed>
Lit le fichier des noms communs - tout règne confondu - d'une langue donnée et renvoie un tableau de tous ces noms indexés par leur TSN.
itis_read_ranks()  : array<string|int, mixed>
Lit le fichier des rangs d'un règne donné et construit la hiérarchie de ces mêmes rangs.
itis_find_language()  : string
Renvoie la langue telle que le service ITIS la désigne à partir du code de langue de SPIP.
itis_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent de la base de données d'ITIS.
itis_review_sha()  : array<string|int, mixed>
Calcule le sha de chaque fichier ITIS fournissant des données, à savoir, ceux des règnes et ceux des noms communs par langue.
iucn_get_assessment()  : array<string|int, mixed>
Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.
iucn_find_language()  : string
Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.
iucn_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.
wikipedia_get_page()  : array<string|int, mixed>
Renvoie, à partir d'une phrase de recherche, soit le texte de la page ou d'une section de la page avec ou pas la liste des autres pages possibles, soit la liste des langues de la page.
wikipedia_find_language()  : string
Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.
wikipedia_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.
taxonomie_upgrade()  : void
Fonction d'installation et de mise à jour du plugin.
taxonomie_vider_tables()  : void
Fonction de désinstallation du plugin.
configurer_taxonomie()  : array<string|int, mixed>
Initialise la configuration du plugin.
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()  : array<string|int, mixed>
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.
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()  : mixed
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.

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.

_TAXONOMIE_ITIS_CACHE_TIMEOUT

Période de renouvellement du cache de Wikipedia (365 jours)

public mixed _TAXONOMIE_ITIS_CACHE_TIMEOUT = 86400 * 30 * 6

_TAXONOMIE_ITIS_ENDPOINT_BASE_URL

Préfixe des URL du service web de ITIS.

public mixed _TAXONOMIE_ITIS_ENDPOINT_BASE_URL = 'http://www.itis.gov/ITISWebService/'

_TAXONOMIE_ITIS_REGEXP_RANKNAME

Ligne d'un fichier ITIS hiérachie généré.

public mixed _TAXONOMIE_ITIS_REGEXP_RANKNAME = '#(%rank_list%):\\s*(([A-Z]\\s+)?[\\w-]+)\\s*(.+)\\s*\\[(\\d+)\\]\\s*$#'

Il est indispensable de respecter les majuscules des noms de groupe pour éviter de matcher les suborder, infrakingdom...

_TAXONOMIE_ITIS_SITE_URL

URL de la page d'accueil du site ITIS.

public mixed _TAXONOMIE_ITIS_SITE_URL = 'http://www.itis.gov'

Cette URL est fournie dans les credits.

_TAXONOMIE_ITIS_TAXON_BASE_URL

URL de base d'une page d'un taxon sur le site d'ITIS.

public mixed _TAXONOMIE_ITIS_TAXON_BASE_URL = 'http://www.itis.gov/servlet/SingleRpt/SingleRpt?search_topic=TSN&search_value='

Cette URL est fournie dans les credits.

_TAXONOMIE_IUCN_CACHE_TIMEOUT

Période de renouvellement du cache de Wikipedia (6 mois)

public mixed _TAXONOMIE_IUCN_CACHE_TIMEOUT = 86400 * 30 * 6

_TAXONOMIE_IUCN_ENDPOINT_BASE_URL

Préfixe des URL du service web de WIKIPEDIA.

public mixed _TAXONOMIE_IUCN_ENDPOINT_BASE_URL = 'http://apiv3.iucnredlist.org/api/v3/'

_TAXONOMIE_IUCN_REDLIST

URL de base d'une page d'un taxon sur le site de la red list IUCN.

public mixed _TAXONOMIE_IUCN_REDLIST = 'https://www.iucnredlist.org/'

Cette URL est fournie dans les credits.

_TAXONOMIE_IUCN_SITE_URL

URL de la page d'accueil du site ITIS.

public mixed _TAXONOMIE_IUCN_SITE_URL = 'https://www.iucn.org/'

Cette URL est fournie dans les credits.

_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' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subkingdom' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infrakingdom' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superdivision'), 'phylum' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'division'), 'subphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subdivision'), 'infraphylum' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infradivision'), 'superdivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'superphylum'), 'division' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => 'phylum'), 'subdivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'subphylum'), 'infradivision' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => 'infraphylum'), 'superclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'class' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infraclass' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superorder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'order' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'suborder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'infraorder' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'section' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''), 'subsection' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'superfamily' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'family' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subfamily' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'tribe' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \false, 'synonyme' => ''), 'subtribe' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'genus' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \false, 'synonyme' => ''), 'subgenus' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \false, 'synonyme' => ''), 'species' => array('type' => \_TAXONOMIE_TYPE_RANG_PRINCIPAL, 'est_espece' => \true, 'synonyme' => ''), 'subspecies' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'variety' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''), 'subvariety' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'form' => array('type' => \_TAXONOMIE_TYPE_RANG_SECONDAIRE, 'est_espece' => \true, 'synonyme' => ''), 'subform' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'race' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => 'variety'), 'stirp' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'morph' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'aberration' => array('type' => \_TAXONOMIE_TYPE_RANG_INTERCALAIRE, 'est_espece' => \true, 'synonyme' => ''), 'unspecified' => array('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_RECHERCHE_MAX_ESPECES

Nombre de réponses maximal toléré pour continuer en étape 2.

public mixed _TAXONOMIE_RECHERCHE_MAX_ESPECES = 35

_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'

_TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT

Période de renouvellement du cache de Wikipedia (30 jours)

public mixed _TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT = 86400 * 30

_TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL

Préfixe des URL du service web de WIKIPEDIA.

public mixed _TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL = 'https://%langue%.wikipedia.org/w/api.php'

_TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL

URL de base pour construire une page de Wikipedia dans une langue donnée

public mixed _TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL = 'https://%langue%.wikipedia.org/wiki/'

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.

Return values
void

taxonomie_declarer_tables_interfaces()

Déclaration des alias de tables et des filtres automatiques de champs.

taxonomie_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur.

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Déclarations d'interface pour le compilateur mises à jour.

taxonomie_declarer_tables_objets_sql()

Déclaration des objets éditoriaux du plugin. Le plugin ajoute l'objet taxon au travers de la seule table `spip_taxons` qui contient aussi les taxons de type `espèce`.

taxonomie_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>

L'objet taxon est défini comme une arborescence de taxons du règne au rang le plus petit dans le règne. Les taxons de rang égal ou inférieur à l'espèce font aussi partie de cette table. Les champs principaux sont les suivants : - nom_scientifique est le nom en latin. Il est unique pour un rang taxonomique donné. - rang taxonomique est une valeur parmi kingdom, phylum, class, order, family, genus, species... - nom_commun est le nom vulgaire, si possible normalisé par une commission officielle. Il peut coïncider ou pas avec le nom vernaculaire. - auteur est une information composée d'un ou plusieurs noms complétés par une date (ex : Linneus, 1798). - tsn est l'identifiant numérique unique du taxon dans la base taxonomique ITIS. - tsn_parent permet de créer l'arborescence taxonomique du règne conformément à l'organisation de la base ITIS. - espece indique si oui ou non le taxon à un rang supérieur ou inférieur ou égal à species.

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

Description des tables de la base.

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Description des tables de la base complétée par celles du plugin.

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, 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 : 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.

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_configurer_taxonomie_charger()

Chargement des données : le formulaire propose la liste des langues possibles.

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

L'utilisateur doit cocher les langues qu'il souhaite utiliser parmi les langues possibles.

Return values
array<string|int, mixed>

Tableau des données à charger par le formulaire (affichage ou données de configuration).

  • _langues : (affichage) codes de langue et libellés des langues possibles.
  • langues_utilisees : (configuration) la liste des langues utilisées. Par défaut, le plugin propose la langue française.

formulaires_configurer_taxonomie_verifier()

Vérification des saisies : il est indispensable de choisir au moins une langue.

formulaires_configurer_taxonomie_verifier() : array<string|int, mixed>
Return values
array<string|int, mixed>

Tableau des erreurs d'absence de langue saisie ou tableau vide si aucune erreur.

formulaires_creer_espece_charger()

Chargement des données :

formulaires_creer_espece_charger() : array<string|int, mixed>
Tags
uses
regne_repertorier()
Return values
array<string|int, mixed>

Tableau des données à charger par le formulaire dans l'étape 1.

  • type_recherche : (saisie) type de la recherche par nom scientifique (scientificname) ou nom commun (commonname).
  • correspondance : (saisie) indique si on doit rechercher le texte exact ou pas.
  • recherche : (saisie) texte de la recherche.
  • regne : (saisie) règne d'appartenance de l'espèce pour limiter le scope de recherche.
  • _types_recherche : (affichage) recherche par nom scientifique ou par nom commun.
  • _type_recherche_defaut : (affichage) le type de recherche par défaut est toujours nom_scientifique.
  • _regnes : (affichage) liste des règnes déjà chargés dans la base de taxonomie.
  • _regne_defaut : (affichage) le règne par défaut qui est toujours le premier de la liste.
  • _etapes : (affichage) nombre d'étapes du formulaire, à savoir, 3.

formulaires_creer_espece_verifier_1()

Vérification de l'étape 1 du formulaire :

formulaires_creer_espece_verifier_1() : array<string|int, mixed>
Tags
uses
itis_search_tsn()
uses
itis_get_record()
Return values
array<string|int, mixed>

Message d'erreur si aucun taxon disponible ou si il existe une erreur dans les saisies. Sinon, chargement des champs utiles à l'étape 2 :

  • _taxons : (affichage) liste des taxons correspondant à la recherche (tsn, nom scientifique et rang).
  • _taxon_defaut : (affichage) tsn du taxon choisi par défaut.

formulaires_creer_espece_verifier_2()

Vérification de l'étape 2 du formulaire : on présente les informations principales du taxon choisi avant que l'utilisateur ne valide définitivement son choix. En particulier, on affiche la hiérarchie du taxon jusqu'au premier taxon de genre et on identifie les taxons qui seront aussi créés dans cette hiérarchie.

formulaires_creer_espece_verifier_2() : array<string|int, mixed>
Tags
uses
itis_get_record()
uses
itis_get_information()
uses
rang_est_espece()
Return values
array<string|int, mixed>

Message d'erreur si le service ITIS ne renvoie pas les informations demandées (a priori jamais). Sinon, chargement des champs utiles à l'étape 3 :

  • _espece : (affichage) toutes les informations ITIS sur l'espèce.
  • _parents : (affichage) toutes les informations ITIS sur l'ascendance de l'espèce jusqu'au genre.

formulaires_creer_espece_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_creer_espece_traiter() : array<string|int, mixed>
Tags
uses
itis_get_record()
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([int|string $id_taxon = 'new' ][, string $retour = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : string
Parameters
$id_taxon : int|string = 'new'

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

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$config_fonc : string = ''

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

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du taxon, si connu

$hidden : 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([int|string $id_taxon = 'new' ][, string $retour = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

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

Parameters
$id_taxon : int|string = 'new'

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

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$config_fonc : string = ''

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

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du taxon, si connu

$hidden : 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([int|string $id_taxon = 'new' ][, string $retour = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

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

Parameters
$id_taxon : int|string = 'new'

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

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$config_fonc : string = ''

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

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du taxon, si connu

$hidden : 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([int|string $id_taxon = 'new' ][, string $retour = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Traiter les champs postés.

Parameters
$id_taxon : int|string = 'new'

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

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$config_fonc : string = ''

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

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du taxon, si connu

$hidden : 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, int $cle_gbif) : 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 : int

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, int $cle_gbif) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$cle_gbif : int

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, int $cle_gbif) : array<string|int, mixed>
Parameters
$id_taxon : int

Id du taxon concerné.

$cle_gbif : int

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.

genie_taxonomie_actualiser_itis_dist()

Ce CRON permet de vérifier si les fichiers ITIS ayant servis à créer la base de taxons initiale ont été modifiés et si oui de déclencher une mise à niveau des taxons.

genie_taxonomie_actualiser_itis_dist(int $last) : int

Etant donné que les sha des fichiers sont enregistrés dans la meta de chaque règne, la fonction compare ces valeurs aux sha des fichiers embarqués dans le plugin. Les fichiers des taxons de chaque règne ainsi que les fichiers de traductions sont pris en compte. Si un fichier a changé on recharge le ou les règnes concernés.

Parameters
$last : int

Timestamp de la date de dernier appel de la tâche.

Tags
uses
itis_review_sha()
uses
regne_existe()
uses
regne_charger()
Return values
int

Timestamp de la date du prochain appel de la tâche.

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[, array<string|int, mixed> $codes_langue = array() ]) : 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 : array<string|int, mixed> = array()

Tableau des codes des langues (au sens SPIP) à charger pour les noms communs des taxons.

Tags
uses
regne_existe()
uses
taxon_preserver()
uses
regne_vider()
uses
itis_read_hierarchy()
uses
itis_find_language()
uses
itis_read_vernaculars()
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.

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, 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 : 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.

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.

rang_informer_type()

Renvoie le type de rang principal, secondaire ou intercalaire.

rang_informer_type(string $rang) : string
Parameters
$rang : string

Nom anglais du rang en minuscules.

Return values
string

principal, secondaire ou intercalaire si le rang est valide, chaine vide sinon.

rang_est_espece()

Détermine si un rang est celui d'une espèce ou d'un taxon de rang inférieur.

rang_est_espece(string $rang) : bool
Parameters
$rang : string

Nom anglais du rang en minuscules.

Return values
bool

true si le rang est celui d'une espèce ou d'un taxon de rang inférieur, false sinon.

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.

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.

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>
Return values
array<string|int, mixed>

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

inc_taxonomie_requeter_dist()

Renvoie, à partir de l'url du service, le tableau des données demandées.

inc_taxonomie_requeter_dist(string $url[, int|null $taille_max = null ]) : array<string|int, mixed>

Le service utilise dans ce cas une chaine JSON qui est décodée pour fournir le tableau de sortie. Le flux retourné par le service est systématiquement transcodé dans le charset du site avant d'être décodé.

Parameters
$url : string

URL complète de la requête au service web concerné.

$taille_max : int|null = null

Taille maximale du flux récupéré suite à la requête. null désigne la taille par défaut.

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

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 = array() ]) : string
Parameters
$id_taxon : int

Id du taxon nécessaire pour construire l'url de la page GBIF.

$informations : array<string|int, mixed> = array()

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

Return values
string

Phrase de crédit.

itis_search_tsn()

Recherche un taxon dans la base ITIS par son nom commun ou scientifique et retourne son identifiant unique nommé TSN ou 0 si le taxon n'existe pas.

itis_search_tsn(string $action, string $search[, bool $strict = true ]) : array<string|int, mixed>

Selon le critère de correspondance de la recherche (stricte ou pas) la fonction retourne un ou plusieurs taxons.

Parameters
$action : string

Recherche par nom commun ou par nom scientifique. Prend les valeurs commonname, scientificname ou commonnamebegin.

$search : string

Nom à rechercher précisément. Seul le taxon dont le nom coincidera exactement sera retourné.

$strict : bool = true

true indique une correspondance stricte de la chaine recherchée ce qui a pour conséquence de renvoyer une seule valeur de TSN. false indique une correspondance partielle et peut donc renvoyer plusieurs TSN.

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

Si la recherche est stricte, la fonction retourne l'identifiant unique TSN dans la base ITIS ou 0 si la recherche échoue. Sinon, la fonction retourne une liste de couples de valeurs (TNS, valeur trouvée).

itis_get_record()

Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.

itis_get_record(int $tsn) : array<string|int, mixed>
Parameters
$tsn : int

Identifiant unique du taxon dans la base ITIS, le TSN

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>

Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:

  • nom_scientifique : le nom scientifique complet du taxon tel qu'il doit être affiché (avec capitales).
  • rang : le nom anglais du rang taxonomique du taxon
  • regne : le nom scientifique du règne du taxon en minuscules
  • tsn_parent : le TSN du parent du taxon ou 0 si le taxon est un règne
  • auteur : la citation d’auteurs et la date de publication
  • nom_commun : un tableau indexé par langue (au sens d'ITIS en minuscules, english, french, spanish...) fournissant le nom commun dans chacune des langues
  • credibilite : Information sur la crédibilité des informations du taxon
  • usage_valide : Indication sur la validité de l'utilisation du taxon
  • zone_geographique : un tableau indexé par langue unique english des zones géographiques où le taxon est localisé. Les zones sont libellées en anglais.

itis_get_information()

Renvoie les informations demandées sur un taxon désigné par son identifiant unique TSN.

itis_get_information(string $action, int $tsn) : string|int|array<string|int, mixed>
Parameters
$action : string

Type d'information demandé. Prend les valeurs

  • scientificname : le nom scientifique du taxon
  • kingdomname : le règne du taxon
  • parent : le taxon parent dont son TSN
  • rankname : le rang taxonomique du taxon
  • author : le ou les auteurs du taxon
  • coremetadata : les métadonnées (à vérifier)
  • experts : les experts du taxon
  • commonnames : le ou les noms communs
  • othersources : les sources d'information sur le taxon
  • hierarchyfull : la hiérarchie complète jusqu'au taxon et ses descendants directs
  • hierarchyup : la hiérarchie limitée au parent direct
$tsn : int

Identifiant unique du taxon dans la base ITIS (TSN)

Tags
uses
cache_est_valide()
uses
itis_build_url()
uses
inc_taxonomie_requeter_dist()
uses
cache_ecrire()
uses
cache_lire()
Return values
string|int|array<string|int, mixed>

Chaine ou tableau caractéristique du type d'information demandé.

itis_list_vernaculars()

Renvoie la liste des noms communs définis pour certains taxons dans une langue donnée mais tout règne confondu.

itis_list_vernaculars( $language) : array<string|int, mixed>

Peu de taxons sont traduits dans la base ITIS, seules le français, l'anglais et l'espagnol sont réellement utilisables. Pour l'anglais, le nombre de taxons est très important car les 4 règnes non supportés par le plugin Taxonomie sont fortement traduits.

Parameters
$language :

Langue au sens d'ITIS écrite en minuscules. Vaut french, english, spanish...

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

Tableau des noms communs associés à leur TSN. Le format du tableau est le suivant:

  • l'index représente le TSN du taxon,
  • la valeur fournit le tableau des noms communs, chaque nom étant préfixé du code de langue de SPIP (ex: [fr]bactéries)

itis_read_hierarchy()

Lit le fichier hiérarchique ITIS des taxons d'un règne et renvoie la liste des taxons retenus.

itis_read_hierarchy(string $kingdom, array<string|int, mixed> $ranks_hierarchy, string &$sha_file) : array<string|int, mixed>
Parameters
$kingdom : string

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

$ranks_hierarchy : array<string|int, mixed>

Liste des rangs disponibles pour le règne concerné structurée comme une hiérarchie du règne aux rangs inférieurs. Cette liste contient tous les rangs principaux, secondaires et intercalaires. Le tableau est de la forme [nom anglais du rang en minuscules] = détails du rang

$sha_file : string

Sha calculé à partir du fichier de taxons correspondant au règne choisi. Le sha est retourné par la fonction afin d'être stocké par le plugin.

Return values
array<string|int, mixed>

Chaque élément du tableau est un taxon. Un taxon est un tableau associatif dont chaque index correspond à un champ de la table spip_taxons. Le tableau est ainsi prêt pour une insertion en base de données.

itis_read_vernaculars()

Lit le fichier des noms communs - tout règne confondu - d'une langue donnée et renvoie un tableau de tous ces noms indexés par leur TSN.

itis_read_vernaculars(string $language, string &$sha_file) : array<string|int, mixed>

La base de données ITIS contient souvent plusieurs traductions d'une même langue pour un taxon donné. Cette fonction met à jour séquentiellement les traductions sans s'en préoccuper. De fait, c'est la dernière traduction rencontrée qui sera fournie dans le tableau de sortie.

Parameters
$language : string

Langue au sens d'ITIS écrite en minuscules. Vaut french, english, spanish etc.

$sha_file : string

Sha calculé à partir du fichier des noms communs choisi. Le sha est retourné par la fonction afin d'être stocké par le plugin.

Return values
array<string|int, mixed>

Tableau des noms communs d'une langue donnée indexé par TSN. Le nom commun est préfixé par le tag de langue SPIP pour être utilisé simplement dans une balise <multi>.

itis_read_ranks()

Lit le fichier des rangs d'un règne donné et construit la hiérarchie de ces mêmes rangs.

itis_read_ranks(string $kingdom, string &$sha_file) : array<string|int, mixed>
Parameters
$kingdom : string

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

$sha_file : string

Sha calculé à partir du fichier de taxons correspondant au règne choisi. Le sha est retourné par la fonction afin d'être stocké par le plugin.

Return values
array<string|int, mixed>

Tableau des rangs identifiés par leur nom scientifique en anglais et organisé comme une hiérarchie du règne au rang de plus bas niveau.

itis_find_language()

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

itis_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.

itis_credit()

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

itis_credit(int $id_taxon[, array<string|int, mixed> $informations = array() ]) : string
Parameters
$id_taxon : int

Id du taxon nécessaire pour construire l'url de la page ITIS fournissant une information complète sur le taxon.

$informations : array<string|int, mixed> = array()

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

Return values
string

Phrase de crédit.

itis_review_sha()

Calcule le sha de chaque fichier ITIS fournissant des données, à savoir, ceux des règnes et ceux des noms communs par langue.

itis_review_sha() : array<string|int, mixed>
Return values
array<string|int, mixed>

Tableau à deux index principaux:

  • taxons : tableau associatif indexé par règne
  • traductions : tableau associatif par code de langue SPIP

iucn_get_assessment()

Renvoie l'ensemble des informations sur un taxon désigné par son identifiant unique TSN.

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

Tableau contenant le taxon à cherché sous une forme textuelle et numérique:

  • name : chaine de recherche qui est en généralement le nom scientifique du taxon.
  • tsn : identifiant ITIS du taxon, le TSN. Etant donné que ce service s'utilise toujours sur un taxon existant le TSN existe toujours. Il sert à créer le fichier cache.
Tags
uses
cache_est_valide()
uses
iucn_build_url()
uses
inc_taxonomie_requeter_dist()
uses
cache_ecrire()
uses
cache_lire()
Return values
array<string|int, mixed>

Si le taxon est trouvé, le tableau renvoyé possède les index associatifs suivants:

  • nom_scientifique : le nom scientifique complet du taxon tel qu'il doit être affiché (avec capitales).
  • rang : le nom anglais du rang taxonomique du taxon
  • regne : le nom scientifique du règne du taxon en minuscules

iucn_find_language()

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

iucn_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 $iucn_language définit le transcodage langue IUCNs vers code SPIP.

Return values
string

Langue au sens de IUCN - fre, eng, spa - ou chaine vide sinon.

iucn_credit()

Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

iucn_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 Wikipedia concernée.

$informations : array<string|int, mixed>

Tableau des informations complémentaires sur la source. Pour IUCN ce tableau fourni le ou les champs remplis avec IUCN.

Return values
string

Phrase de crédit.

wikipedia_get_page()

Renvoie, à partir d'une phrase de recherche, soit le texte de la page ou d'une section de la page avec ou pas la liste des autres pages possibles, soit la liste des langues de la page.

wikipedia_get_page(array<string|int, mixed> $search, string $spip_language[, int $section = null ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>

Cette phrase de recherche est toujours le nom scientifique du taxon dans l'utilisation qui en est faite par le plugin Taxonomie. Le résultat de la requête est mis en cache pour une durée de plusieurs jours afin d'être servi à nouveau sans accès à Wikipedia.

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

Tableau contenant le taxon à cherché sous une forme textuelle et numérique:

  • name : chaine de recherche qui est en généralement le nom scientifique du taxon.
  • tsn : identifiant ITIS du taxon, le TSN. Etant donné que ce service s'utilise toujours sur un taxon existant le TSN existe toujours. Il sert à créer le fichier cache.
$spip_language : string

Code de langue SPIP dans lequel on souhaite récupérer la page Wikipedia.

$section : int = null

Section de page dont le texte est à renvoyer. Entier supérieur ou égal à 0 ou null pour tout la page.

$options : array<string|int, mixed> = array()

Tableau d'options qui peut contenir les index suivants :

  • reload : force le recalcul du cache. Cet argument est optionnel.
Tags
uses
cache_est_valide()
uses
wikipedia_build_url()
uses
inc_taxonomie_requeter()
uses
cache_ecrire()
uses
cache_lire()
Return values
array<string|int, mixed>

Texte trouvé rédigé en mediawiki ou chaine vide sinon. Pour traduire le texte en SPIP il est nécessaire d'utiliser le plugin Convertisseur. Néanmoins, le texte même traduit doit être remanié manuellement.

wikipedia_find_language()

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

wikipedia_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 $wikipedia_language définit le transcodage langue Wikipedia vers code SPIP.

Return values
string

Langue au sens de Wikipedia - fr, en, es - ou chaine vide sinon.

wikipedia_credit()

Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

wikipedia_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 Wikipedia concernée.

$informations : array<string|int, mixed>

Tableau des informations complémentaires sur la source. Pour Wikipedia ce tableau fourni le ou les champs remplis avec Wikipedia.

Return values
string

Phrase de crédit.

taxonomie_upgrade()

Fonction d'installation et de mise à jour du plugin.

taxonomie_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma du plugin est composé d'une table spip_taxons et d'une configuration.

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données (déclaré dans paquet.xml)

Return values
void

taxonomie_vider_tables()

Fonction de désinstallation du plugin.

taxonomie_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP.

Return values
void

configurer_taxonomie()

Initialise la configuration du plugin.

configurer_taxonomie() : array<string|int, mixed>
Return values
array<string|int, mixed>

Le tableau de la configuration par défaut qui servira à initialiser la meta taxonomie.

taxonomie_autoriser()

Fonction d'appel pour le pipeline.

taxonomie_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_taxon_creer_dist()

Autorisation de créer un taxon.

autoriser_taxon_creer_dist(string $faire, string $type, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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, int|string|null $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 : int|string|null

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[, int $tsn_parent = null ][, string $ordre = 'descendant' ]) : array<string|int, mixed>
Parameters
$id_taxon : int

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

$tsn_parent : 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 : 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[, 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 : 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, int $id_taxon) : array<string|int, mixed>
Parameters
$statut : string

Statut du taxon, prop, publieou poubelle.

$id_taxon : int

Id du taxon.

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

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
Return values
array<string|int, mixed>

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

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

taxonomie_importer_taxons()

taxonomie_importer_taxons(mixed $taxons, mixed $action[, mixed $taxons_edites = false ]) : mixed
Parameters
$taxons : mixed
$action : mixed
$taxons_edites : mixed = false
Return values
mixed

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

pre_edition

Return values
array<string|int, mixed>

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

Search results