ezrest.php
Le fichier contient l'ensemble des constantes et fonctions implémentant l'API REST ezREST qui permet de définir une couche applicative standard pour développer des API REST selon le modèle imposé par le serveur HTTP abstrait.
Table of Contents
Functions
- 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.
Functions
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
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
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
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
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.