API
Table of Contents
Functions
- typologie_plugin_configurer() : array<string|int, mixed>
- Initialise la configuration des différentes typologies de plugin proposées.
- typologie_plugin_creer_groupe() : void
- Création des groupes de mots matérialisant chaque typologie de plugin.
- typologie_plugin_vider() : bool
- Supprime, pour une typologie donnée, l'ensemble des types de plugin ou l'ensemble des affectations plugin-type de plugin.
- typologie_plugin_importer() : int
- Importe une liste de types de plugin appartenant à une même typologie.
- typologie_plugin_exporter() : string
- Exporte de la base de données les types de plugin appartenant à une même typologie dans un fichier sur le serveur.
- typologie_plugin_importer_affectation() : int
- Importe une liste d'affectations (type de plugin, plugin) pour une typologie donnée.
- typologie_plugin_exporter_affectation() : string
- Exporte les affectations (type de plugin, plugin) appartenant à la même typologie dans un fichier sur le serveur.
- typologie_plugin_export_lister() : array<string|int, mixed>
- Lister les fichiers d'export JSON stockés dans le répertoire temporaire idoine.
- typologie_plugin_collectionner() : array<string|int, mixed>
- Elabore la collection des types de plugin pour la typologie concernée au format demandé par l'API REST Factory.
- typologie_plugin_calculer_critere() : string
- Construit la condition SQL issue de l'analyse du critère `{typologie_plugin[ identifiant1, identifiant2]}`.
Functions
typologie_plugin_configurer()
Initialise la configuration des différentes typologies de plugin proposées.
typologie_plugin_configurer() : array<string|int, mixed>
Cette configuration sert à initialiser l'index typologies de la meta svptype.
Return values
array<string|int, mixed> —Le tableau de la configuration par défaut indexé par l'identifiant de chaque typologie.
typologie_plugin_creer_groupe()
Création des groupes de mots matérialisant chaque typologie de plugin.
typologie_plugin_creer_groupe() : void
Si le groupe existe déjà on ne fait rien, sinon on le crée en stockant l'id du groupe obtenu dans la configuration idoine.
typologie_plugin_vider()
Supprime, pour une typologie donnée, l'ensemble des types de plugin ou l'ensemble des affectations plugin-type de plugin.
typologie_plugin_vider(string $typologie[, null|string $vue = 'liste' ]) : bool
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
- $vue : null|string = 'liste'
-
Nature des données à supprimer. Prend les valeurs :
- liste : pour les types de plugin,
- affectation : pour les affectations plugin-type de plugin.
Return values
bool —True si le vidage s'est bien passé, false sinon.
typologie_plugin_importer()
Importe une liste de types de plugin appartenant à une même typologie.
typologie_plugin_importer(string $typologie, array<string|int, mixed> $types) : int
Les types de plugin de la liste déjà présents en base de données sont ignorés.
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
- $types : array<string|int, mixed>
-
Tableau des types présenté comme une arborescence ou à plat suivant la typologie.
Return values
int —Nombre de catégories ajoutées.
typologie_plugin_exporter()
Exporte de la base de données les types de plugin appartenant à une même typologie dans un fichier sur le serveur.
typologie_plugin_exporter(string $typologie) : string
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
Return values
string —Le nom du fichier d'export ou vide si erreur.
typologie_plugin_importer_affectation()
Importe une liste d'affectations (type de plugin, plugin) pour une typologie donnée.
typologie_plugin_importer_affectation(string $typologie, array<string|int, mixed> $affectations) : int
Les affectations de la liste déjà présentes en base de données sont ignorées.
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
- $affectations : array<string|int, mixed>
-
Tableau des affectations (type de plugin, plugin).
Return values
int —Nombre d'affectations ajoutées.
typologie_plugin_exporter_affectation()
Exporte les affectations (type de plugin, plugin) appartenant à la même typologie dans un fichier sur le serveur.
typologie_plugin_exporter_affectation(string $typologie) : string
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
Return values
string —Le nom du fichier d'export ou vide si erreur.
typologie_plugin_export_lister()
Lister les fichiers d'export JSON stockés dans le répertoire temporaire idoine.
typologie_plugin_export_lister(string $typologie) : array<string|int, mixed>
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
Return values
array<string|int, mixed> —Tableau associatif des fichiers d'export fournissant, le chemin complet, le nom sans extension, la date et la taille de chaque fichier.
typologie_plugin_collectionner()
Elabore la collection des types de plugin pour la typologie concernée au format demandé par l'API REST Factory.
typologie_plugin_collectionner(string $typologie, array<string|int, mixed> $filtres) : array<string|int, mixed>
Parameters
- $typologie : string
-
Identifiant de la typologie concernée : categorie, tag...
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels.
Return values
array<string|int, mixed> —Tableau des types des plugins demandés.
typologie_plugin_calculer_critere()
Construit la condition SQL issue de l'analyse du critère `{typologie_plugin[ identifiant1, identifiant2]}`.
typologie_plugin_calculer_critere(array<string|int, mixed> $typologies, string $table) : string
Parameters
- $typologies : array<string|int, mixed>
-
Liste des identifiants de typologie passé en argument du critère. Si la liste est vide on intègre toutes les typologies dans la condition.
- $table : string
-
Identifiant de la table sur laquelle porte la condition, soit
motsougroupes_mots.
Return values
string —Condition SQL traduisant le critère (égalité ou IN).