Class RestService
Classe principale gérant les services. Paramètres liés dans config.ini : -
serveur.baseURL
Encodage en entrée : utf8 Encodage en sortie : utf8
Methods summary
public
|
|
public
|
|
protected
|
#
getBdd( )
Méthode de connection à la base de données sur demande. Tous les services
web n'ont pas besoin de s'y connecter.
Méthode de connection à la base de données sur demande. Tous les services
web n'ont pas besoin de s'y connecter.
|
protected
|
#
getRestClient( )
Méthode permettant de faire appel à un client REST en fonction des besoins
du service.
Méthode permettant de faire appel à un client REST en fonction des besoins
du service.
|
public
|
#
utiliserParametresBruts( )
Méthode permettant de savoir si le service veut utiliser des paramètres
bruts (issu de la QueryString) ou pas (issu de $_GET).
Méthode permettant de savoir si le service veut utiliser des paramètres
bruts (issu de la QueryString) ou pas (issu de $_GET).
|
protected
|
#
ajouterMessage( string $message )
Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
client. Le message doit être au format texte et en UTF-8.
Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
client. Le message doit être au format texte et en UTF-8.
Parameters
- $message
string
$message le message à envoyer.
|
public
string
|
#
consulter( array $ressources, array $parametres )
Méthode appelée lors d'une requête HTTP de type GET.
Méthode appelée lors d'une requête HTTP de type GET.
Si la consultation est un succès, le code statut HTTP retourné sera 200.
Dans tous les autres cas, la méthode devra retourner le code statut HTTP
adéquate.
Parameters
- $ressources
array
Morceaux de l'url servant à préciser la ressource concerné pour le service
demandé.- $parametres
array
Partie de l'url situé après le '?' servant à paramétrer le service demandé. Returns
string
une chaine indiquant le succès de l'opération et les données demandées.
|
public
mixed
|
#
modifier( array $ressources, array $requeteDonnees )
Méthode appelée lors d'une requête HTTP de type POST.
Méthode appelée lors d'une requête HTTP de type POST.
La ressource à modifier est indiquée via l'url. Les données devant servir
à la mise à jours sont passées dans le corps de la requête. Si la
modification est un succès, la méthode devra retourner "true" et le code
statut HTTP retourné sera 201.
Parameters
- $ressources
array
Morceaux de l'url servant à préciser la ressource concerné pour le service
demandé.- $requeteDonnees
array
les données transférées dans le corps de la requête devant servir à la
modification. Returns
mixed
une chaine indiquant le succès de l'opération ou rien.
|
public
string
|
#
ajouter( array $ressources, array $requeteDonnees )
Méthode appelée lors d'une requête HTTP de type PUT.
Méthode appelée lors d'une requête HTTP de type PUT.
L'identifiant de la ressource à ajouter est indiqué via l'url si on le
connait par avance. Sinon, il doit être créé par le service. Dans ce dernier
cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
Le code statut HTTP retourné sera 201 en cas de succès. Dans le cas contraire,
la méthode devra retourner false.
Parameters
- $ressources
array
Morceaux de l'url servant à préciser la ressource concerné pour le service
demandé.- $requeteDonnees
array
les données transférées dans le corps de la requête devant servir à
l'ajout. Returns
string
l'identifiant créé.
|
public
mixed
|
#
supprimer( array $ressources )
Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
action=DELETE dans le corps de la requete).
Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
action=DELETE dans le corps de la requete).
Si la suppression est un succès, la méthode devra retourner "true" et le
code statut HTTP retourné par RestServeur sera 204. Si la ressource à
supprimer est introuvable, la méthode devra retourner "false" et le code statut
HTTP retourné par RestServeur sera 404. Dans les autres cas de figure ou si
vous souhaitez gérer vos propres codes de retour erreur, retourner la valeur
null ou rien.
Parameters
- $ressources
array
Morceaux de l'url servant à préciser la ressource concerné pour le service
demandé. Returns
mixed
une chaine indiquant le succès de l'opération ou rien.
|
Properties summary
protected
mixed
|
$bdd
|
null |
#
Objet de connection à la base de données.
Objet de connection à la base de données.
Deprecated
Utiliser la methode getBdd().
See
|
protected
boolean
|
$utilisationParametresBruts
|
false |
#
Indique si oui (true) ou non (false), on veut utiliser les paramètres
brutes.
Indique si oui (true) ou non (false), on veut utiliser les paramètres
brutes.
|