svpapi.php
Ce fichier contient l'ensemble des fonctions de service spécifiques à une ou plusieurs collections.
Table of Contents
Functions
- svpapi_api_verifier_contexte() : bool
- Détermine si le serveur est capable de répondre aux requêtes SVP.
- svpapi_reponse_informer_plugin() : array<string|int, mixed>
- Compléte le bloc d'information du plugin en supprimant le schéma du plugin SVP API qui n'existe pas par celui du plugin SVP sur lequel s'appuie SVP API.
- plugins_collectionner() : array<string|int, mixed>
- Récupère la liste des plugins de la table spip_plugins éventuellement filtrés par les critères additionnels positionnés dans la requête.
- plugins_ressourcer() : array<string|int, mixed>
- Retourne la description complète d'un plugin et de ses paquets.
- plugins_conditionner_compatible_spip() : string
- Construit la condition SQL inhérente au critère de filtre `compatible_spip`.
- plugins_verifier_filtre_compatible_spip() : bool
- Détermine si la valeur du critère compatibilité SPIP est valide.
- plugins_verifier_ressource_prefixe() : bool
- Détermine si la valeur du préfixe de plugin est valide.
- paquets_collectionner() : array<string|int, mixed>
- Récupère la liste des paquets hébergés par le serveur.
- paquets_conditionner_compatible_spip() : string
- Construit la condition SQL inhérente au critère de filtre `compatible_spip`.
- depots_collectionner() : array<string|int, mixed>
- Récupère la liste des dépôts hébergés par le serveur.
Functions
svpapi_api_verifier_contexte()
Détermine si le serveur est capable de répondre aux requêtes SVP.
svpapi_api_verifier_contexte(array<string, mixed> &$erreur) : bool
Pour cela on vérifie si le serveur est en mode run-time ou pas. On considère qu'un serveur en mode run-time n'est pas valide pour traiter les requêtes car la liste des plugins et des paquets n'est pas complète.
Parameters
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. Les index mis à jour sont uniquement les suivants car les autres sont initialisés par l'appelant :
-
type: identifiant de l'erreur 501, soitruntime_nok -
element: type d'objet sur lequel porte l'erreur, soitserveur -
valeur: la valeur du mode runtime
-
Return values
bool —true si la valeur est valide, false sinon.
svpapi_reponse_informer_plugin()
Compléte le bloc d'information du plugin en supprimant le schéma du plugin SVP API qui n'existe pas par celui du plugin SVP sur lequel s'appuie SVP API.
svpapi_reponse_informer_plugin(array<string|int, mixed> $contenu) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu de la réponse dans son état après initialisation.
Return values
array<string|int, mixed> —Le contenu de la réponse avec l'index schema supprimé et remplacé par l'index schema_svp.
plugins_collectionner()
Récupère la liste des plugins de la table spip_plugins éventuellement filtrés par les critères additionnels positionnés dans la requête.
plugins_collectionner(array<string|int, mixed> $conditions, array<string, mixed> $filtres, array<string, mixed> $configuration) : array<string|int, mixed>
Les plugins fournis sont toujours issus d'un dépôt hébergé par le serveur ce qui exclu les plugins installés sur le serveur et non liés à un dépôt (par exemple un zip personnel). Chaque objet plugin est présenté comme un tableau dont tous les champs sont accessibles comme un type PHP simple, entier, chaine ou tableau.
Parameters
- $conditions : array<string|int, mixed>
-
Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.
- $filtres : array<string, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string, mixed>
-
Configuration de la collection.
Tags
Return values
array<string|int, mixed> —Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.
plugins_ressourcer()
Retourne la description complète d'un plugin et de ses paquets.
plugins_ressourcer(string $prefixe, array<string, mixed> $filtres, array<string, mixed> $configuration) : array<string|int, mixed>
Parameters
- $prefixe : string
-
La valeur du préfixe du plugin.
- $filtres : array<string, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string, mixed>
-
Configuration de la collection.
Return values
array<string|int, mixed> —La description du plugin et de ses paquets, les champs étant tous normalisés (désérialisés).
plugins_conditionner_compatible_spip()
Construit la condition SQL inhérente au critère de filtre `compatible_spip`.
plugins_conditionner_compatible_spip(mixed $version) : string
Parameters
- $version : mixed
-
La valeur du critère compatibilite SPIP : une version, une branche ou une liste de branches séparées par des virgules.
Return values
string —Condition SQL du filtre.
plugins_verifier_filtre_compatible_spip()
Détermine si la valeur du critère compatibilité SPIP est valide.
plugins_verifier_filtre_compatible_spip(mixed $valeur, array<string, mixed> &$erreur) : bool
La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec un numéro de version ou de branche.
Parameters
- $valeur : mixed
-
La valeur du critère compatibilite SPIP
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur.
Return values
bool —true si la valeur est valide, false sinon.
plugins_verifier_ressource_prefixe()
Détermine si la valeur du préfixe de plugin est valide.
plugins_verifier_ressource_prefixe(string $prefixe, array<string, mixed> &$erreur) : bool
La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec celui d'un nom de variable.
Parameters
- $prefixe : string
-
La valeur du préfixe
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur.
Return values
bool —true si la valeur est valide, false sinon.
paquets_collectionner()
Récupère la liste des paquets hébergés par le serveur.
paquets_collectionner(array<string|int, mixed> $conditions, array<string, mixed> $filtres, array<string, mixed> $configuration) : array<string|int, mixed>
C'est la requête de base pour l'installation des plugins par SVP.
Parameters
- $conditions : array<string|int, mixed>
-
Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.
- $filtres : array<string, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string, mixed>
-
Configuration de la collection.
Return values
array<string|int, mixed> —Tableau des paquets. Les champs de type id ou maj ne sont pas renvoyés.
paquets_conditionner_compatible_spip()
Construit la condition SQL inhérente au critère de filtre `compatible_spip`.
paquets_conditionner_compatible_spip(mixed $version) : string
Parameters
- $version : mixed
-
La valeur du critère compatibilite SPIP : une version, une branche ou une liste de branches séparées par des virgules.
Return values
string —Condition SQL du filtre.
depots_collectionner()
Récupère la liste des dépôts hébergés par le serveur.
depots_collectionner(array<string|int, mixed> $conditions, array<string, mixed> $filtres, array<string, mixed> $configuration) : array<string|int, mixed>
Contrairement aux plugins et paquets les champs d'un dépôt ne nécessitent aucun formatage.
Parameters
- $conditions : array<string|int, mixed>
-
Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.
- $filtres : array<string, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string, mixed>
-
Configuration de la collection.
Return values
array<string|int, mixed> —Tableau des dépôts. Les champs de type id ou maj ne sont pas renvoyés.