SPIP Code

Documentation du code de SPIP et de ses plugins

REST Factory

Documentation

Table of Contents

Packages

Application
SPIP

Functions

ezrest_conditionner()  : array<string|int, mixed>
Construit le tableau des conditions SQL à appliquer à la collection.
http_ezrest_erreur_dist()  : Response
Traite les erreurs directement détectées par le serveur HTTP abstrait uniquement.
http_ezrest_get_index_dist()  : Response
Fait un GET sur l'API ezREST seule et renvoie la liste des collections disponibles et les possibilités associées.
http_ezrest_get_collection_dist()  : Response
Fait un GET sur une collection gérée par l'API ezREST.
http_ezrest_get_ressource_dist()  : Response
Fait un GET sur une ressource d'une collection gérée par l'API ezREST.
cache_reponse_vider()  : bool
Vide, pour un plugin utilisateur donné, les caches du type `reponse` éventuellement filtrés.

Functions

ezrest_conditionner()

Construit le tableau des conditions SQL à appliquer à la collection.

ezrest_conditionner(string $plugin, string $collection, array<string, mixed> $filtres, array<string, mixed> $configuration) : array<string|int, mixed>
Parameters
$plugin : string

Préfixe du plugin utilisateur de ezrest et donc fournisseur de la collection.

$collection : string

L'identifiant de la collection concernée.

$filtres : array<string, mixed>

Tableau associatif des critères de filtre (couple nom du critère, valeur du critère)

$configuration : array<string, mixed>

Configuration de la collection concernée.

Tags
uses
ezrest_chercher_service()
used-by
http_ezrest_get_collection_dist()
Return values
array<string|int, mixed> —

Tableau des conditions SQL

http_ezrest_erreur_dist()

Traite les erreurs directement détectées par le serveur HTTP abstrait uniquement.

http_ezrest_erreur_dist(int $code, Request $requete, Response $reponse) : Response

Celles-ci sont mises au format de l'API REST ezREST et fournies au client systématiquement en JSON.

Parameters
$code : int

Le code HTTP de l'erreur à générer

$requete : Request

Objet matérialisant la requête faite au serveur.

$reponse : Response

Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera complétée avant d'être retourné par la fonction.

Tags
uses
ezrest_reponse_initialiser_contenu()
uses
ezrest_reponse_erreur_initialiser()
uses
ezrest_reponse_construire()
Return values
Response —

Retourne l'objet réponse dont le contenu est mis à jour avec les éléments du bloc d'erreur.

http_ezrest_get_index_dist()

Fait un GET sur l'API ezREST seule et renvoie la liste des collections disponibles et les possibilités associées.

http_ezrest_get_index_dist(Request $requete, Response $reponse) : Response

Il ne peut pas y avoir d'erreur à ce niveau de l'API ezREST.

Parameters
$requete : Request

Objet matérialisant la requête faite au serveur.

$reponse : Response

Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera complétée avant d'être retourné par la fonction.

Tags
uses
ezrest_reponse_initialiser_contenu()
uses
ezrest_cache_identifier()
uses
cache_est_valide()
uses
cache_lire()
uses
ezrest_indexer()
uses
cache_ecrire()
uses
ezrest_reponse_construire()
throws
Exception
Return values
Response —

Retourne l'objet réponse dont le contenu est mis à jour avec les éléments du bloc d'erreur.

http_ezrest_get_collection_dist()

Fait un GET sur une collection gérée par l'API ezREST.

http_ezrest_get_collection_dist(Request $requete, Response $reponse) : Response

La requête est du type /ezrest/ccc et renvoie les objets associées contenus dans la base du serveur. Il est possible de filtrer la collection et de compléter la colelction en utilisant le pipeline post_ezcollection.

Parameters
$requete : Request

Objet matérialisant la requête faite au serveur.

$reponse : Response

Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera complétée avant d'être retourné par la fonction.

Tags
uses
ezrest_reponse_initialiser_contenu()
uses
ezrest_collection_verifier()
uses
ezrest_configuration_lire()
uses
ezrest_reponse_informer_plugin()
uses
ezrest_api_verifier_contexte()
uses
ezrest_collection_verifier_filtre()
uses
ezrest_cache_identifier()
uses
cache_est_valide()
uses
cache_lire()
uses
ezrest_conditionner()
uses
ezrest_collectionner()
uses
ezrest_contextualiser()
uses
cache_ecrire()
uses
ezrest_reponse_expliquer_erreur()
uses
ezrest_reponse_construire()
pipeline_appel

post_ezcollection

throws
Exception
Return values
Response —

Objet réponse complétée (status, contenu de la ressource...). La fonction peut lever une erreur sur le contexte lors de l'appel, la collection ou sur les critères de filtre.

http_ezrest_get_ressource_dist()

Fait un GET sur une ressource d'une collection gérée par l'API ezREST.

http_ezrest_get_ressource_dist(Request $requete, Response $reponse) : Response

La requête est du type /ezrest/ccc/rrr et renvoie l'objet de la base désigné.

Il est possible de rajouter des informations en utilisant le pipeline post_ezressource.

Parameters
$requete : Request

Objet matérialisant la requête faite au serveur.

$reponse : Response

Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera complétée avant d'être retourné par la fonction.

Tags
uses
ezrest_reponse_initialiser_contenu()
uses
ezrest_collection_verifier()
uses
ezrest_configuration_lire()
uses
ezrest_reponse_informer_plugin()
uses
ezrest_api_verifier_contexte()
uses
ezrest_collection_verifier_filtre()
uses
ezrest_collection_verifier_ressource()
uses
ezrest_cache_identifier()
uses
cache_est_valide()
uses
cache_lire()
uses
ezrest_ressourcer()
uses
ezrest_contextualiser()
uses
cache_ecrire()
uses
ezrest_reponse_expliquer_erreur()
uses
ezrest_reponse_construire()
pipeline_appel

post_ezressource

throws
Exception
Return values
Response —

Objet réponse complété (status, contenu de la ressource...). La fonction peut lever une erreur sur l'état du serveur, le format de sortie, le type de ressouce et sur l'existence de la ressource demandée.

cache_reponse_vider()

Vide, pour un plugin utilisateur donné, les caches du type `reponse` éventuellement filtrés.

cache_reponse_vider(string $plugin[, null|string $type_requete = '' ][, null|string $collection = '' ]) : bool
Parameters
$plugin : string

Préfixe du plugin utilisateur de ezrest et donc fournisseur de la collection.

$type_requete : null|string = ''

Indique si on demande l'index, une collection ou une ressource.

$collection : null|string = ''

L'identifiant de la collection concernée.

Tags
uses
cache_repertorier()
uses
cache_vider()
Return values
bool —

true si la suppression s'est bien passée, false sinon.

Search results