Documentation du code de SPIP et de ses plugins

Taxonomie

CONFIGURATION

Table of Contents

Functions

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

Functions

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.

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.

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)

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.

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.


        
On this page

Search results