APIREST
Table of Contents
Functions
- boussoles_api_verifier_contexte() : bool
- Détermine si le serveur est capable de répondre aux requêtes SVP.
- boussoles_collectionner() : array<string|int, mixed>
- Récupère la liste boussoles avec toutes les informations possibles y compris leur nom en mode balise multi.
- boussoles_ressourcer() : array<string|int, mixed>
- Retourne la description complète d'une boussole (sites, traductions, logos).
Functions
boussoles_api_verifier_contexte()
Détermine si le serveur est capable de répondre aux requêtes SVP.
boussoles_api_verifier_contexte(array<string|int, mixed> &$erreur) : bool
Pour cela on vérifie si le serveur a été activé et qu'il est prêt à répondre.
Parameters
- $erreur : array<string|int, 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_nokelement: type d'objet sur lequel porte l'erreur, soitserveurvaleur: la valeur du mode runtime
Return values
bool —true si la valeur est valide, false sinon.
boussoles_collectionner()
Récupère la liste boussoles avec toutes les informations possibles y compris leur nom en mode balise multi.
boussoles_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des boussoles dont l'index est l'identifiant de la boussole.
boussoles_ressourcer()
Retourne la description complète d'une boussole (sites, traductions, logos).
boussoles_ressourcer(string $boussole, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $boussole : string
-
Identifiant de la boussole.
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —La description de la boussole, de ses sites et toutes les traductions associées.