spip-contrib-extensions
/
svp_typologie
101
1
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity
Browse Source

Ajouter les schémas JSON des JSON d'import.

master
Eric Lupinacci 4 years ago
parent
9bc5e43746
commit
4efd57c226
3 changed files with 60 additions and 48 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      affectation_import.schema.json
  2. 69
      inc/svptype_typologie.php
  3. 20
      type_plugin_import.schema.json

19
affectation_import.schema.json
Unescape View File

@ -0,0 +1,19 @@
{
"$schema": "http://json-schema.org/schema#",
"title": "Fichier d'import d'une liste d'affectations type de plugin-plugin",
"description": "Règles de validation du fichier JSON d'import d'une liste d'affectations type de plugin-plugin",
"definitions": {
"affectation": {
"type": "object",
"properties": {
"type": { "type": "string" },
"prefixe": { "type": "string" }
},
"required": ["type", "prefixe"]
}
},
"type": "array",
"items": {
"$ref": "#/definitions/affectation"
}
}

69
inc/svptype_typologie.php
Unescape View File

@ -8,15 +8,13 @@ if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Initialise la configuration des différentes typologies de plugin proposées.
* Cette configuration sert à initialiser l'index `typologies` de la meta `svptype`.
*
* @api
*
* @return array
* Le tableau de la configuration par défaut indexé par l'identifiant de chaque typologie.
* @return array Le tableau de la configuration par défaut indexé par l'identifiant de chaque typologie.
*/
function typologie_plugin_configurer() {
@ -56,7 +54,6 @@ function typologie_plugin_configurer() {
return $configurations_typologie;
}
/**
* Création des groupes de mots matérialisant chaque typologie de plugin.
* 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
@ -111,20 +108,16 @@ function typologie_plugin_creer_groupe() {
}
}
/**
* Importe une liste de types de plugin appartenant à une même typologie.
* Les types de plugin de la liste déjà présents en base de données sont ignorés.
*
* @api
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param array $types
* Tableau des types présenté comme une arborescence ou à plat suivant la typologie.
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
* @param array $types Tableau des types présenté comme une arborescence ou à plat suivant la typologie.
*
* @return bool|int
* Nombre de catégories ajoutées.
* @return bool|int Nombre de catégories ajoutées.
*/
function typologie_plugin_importer($typologie, $types) {
@ -186,18 +179,15 @@ function typologie_plugin_importer($typologie, $types) {
return $types_ajoutes;
}
/**
* Exporte de la base de données les types de plugin appartenant à une même typologie dans un fichier sur
* le serveur.
*
* @api
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
*
* @return bool|string
* Le nom du fichier d'export ou false si erreur.
* @return bool|string Le nom du fichier d'export ou false si erreur.
*/
function typologie_plugin_exporter($typologie) {
@ -258,20 +248,16 @@ function typologie_plugin_exporter($typologie) {
return $retour;
}
/**
* Importe une liste d'affectations (type de plugin, plugin) pour une typologie donnée.
* Les affectations de la liste déjà présentes en base de données sont ignorées.
*
* @api
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param array $affectations
* Tableau des affectations (type de plugin, plugin).
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
* @param array $affectations Tableau des affectations (type de plugin, plugin).
*
* @return int
* Nombre d'affectations ajoutées.
* @return int Nombre d'affectations ajoutées.
*/
function typologie_plugin_importer_affectation($typologie, $affectations) {
@ -328,18 +314,15 @@ function typologie_plugin_importer_affectation($typologie, $affectations) {
return $nb_affectations_ajoutees;
}
/**
* Exporte les affectations (type de plugin, plugin) appartenant à la même typologie dans un fichier sur
* le serveur.
*
* @api
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
*
* @return bool|string
* Le nom du fichier d'export ou false si erreur.
* @return bool|string Le nom du fichier d'export ou false si erreur.
*/
function typologie_plugin_exporter_affectation($typologie) {
@ -381,18 +364,15 @@ function typologie_plugin_exporter_affectation($typologie) {
return $retour;
}
/**
* Lister les fichiers d'export JSON stockés dans le répertoire temporaire idoine.
*
* @api
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
*
* @return array
* Tableau associatif des fichiers d'export fournissant, le chemin complet, le nom sans extension,
* la date et la taille de chaque fichier.
* @return array Tableau associatif des fichiers d'export fournissant, le chemin complet, le nom sans extension,
* la date et la taille de chaque fichier.
*/
function typologie_plugin_lister_export($typologie) {
@ -415,17 +395,14 @@ function typologie_plugin_lister_export($typologie) {
return $exports;
}
/**
* Elabore la collection des types de plugin pour la typologie concernée au format demandé par l'API REST SVP API.
*
* @param string $typologie
* Identifiant de la typologie concernée : categorie, tag...
* @param array $filtres
* Tableau des critères de filtrage additionnels.
* @param string $typologie Identifiant de la typologie concernée : categorie, tag...
* @param array $filtres Tableau des critères de filtrage additionnels.
*
* @return array
* Tableau des types des plugins demandés.
* Tableau des types des plugins demandés.
*/
function typologie_plugin_collectionner($typologie, $filtres) {
@ -494,18 +471,14 @@ function typologie_plugin_collectionner($typologie, $filtres) {
return $types;
}
/**
* Construit la condition SQL issue de l'analyse du critère `{typologie_plugin[ identifiant1, identifiant2]}`.
*
* @param array $typologies
* 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.
* @param string $table
* Identifiant de la table sur laquelle porte la condition, soit `mots` ou `groupes_mots`.
* @param array $typologies 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.
* @param string $table Identifiant de la table sur laquelle porte la condition, soit `mots` ou `groupes_mots`.
*
* @return string
* Condition SQL traduisant le critère (égalité ou IN).
* @return string Condition SQL traduisant le critère (égalité ou IN).
*/
function typologie_plugin_elaborer_critere($typologies, $table) {

20
type_plugin_import.schema.json
Unescape View File

@ -0,0 +1,20 @@
{
"$schema": "http://json-schema.org/schema#",
"title": "Fichier d'import d'une liste de types de plugin",
"description": "Règles de validation du fichier JSON d'import d'une liste de types de plugin",
"definitions": {
"type_plugin": {
"type": "object",
"properties": {
"identifiant": { "type": "string" },
"titre": { "type": "string" },
"descriptif": { "type": "string" }
},
"required": ["identifiant", "titre"]
}
},
"type": "array",
"items": {
"$ref": "#/definitions/type_plugin"
}
}
Write Preview
Loading…
Cancel
Save