\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

Summary

Methods
Properties
Constants
__construct()
initialiser()
utiliserParametresBruts()
consulter()
modifier()
ajouter()
supprimer()
No public properties found
No constants found
getBdd()
getRestClient()
ajouterMessage()
$bdd
$utilisationParametresBruts
N/A
No private methods found
$RestClient
N/A

Properties

$bdd

$bdd

Objet de connection à la base de données.

$utilisationParametresBruts

$utilisationParametresBruts

Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes.

$RestClient

$RestClient

Objet Rest Client.

Methods

__construct()

__construct( $config)

Parameters

$config

initialiser()

initialiser()

utiliserParametresBruts()

utiliserParametresBruts()

Méthode permettant de savoir si le service veut utiliser des paramètres bruts (issu de la QueryString) ou pas (issu de $_GET).

consulter()

consulter( $ressources,  $parametres) : string

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
$parametres

Returns

string —

une chaine indiquant le succès de l'opération et les données demandées.

modifier()

modifier( $ressources,  $requeteDonnees) : mixed

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
$requeteDonnees

Returns

mixed —

une chaine indiquant le succès de l'opération ou rien.

ajouter()

ajouter( $ressources,  $requeteDonnees) : string

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
$requeteDonnees

Returns

string —

l'identifiant créé.

supprimer()

supprimer( $ressources) : mixed

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

Returns

mixed —

une chaine indiquant le succès de l'opération ou rien.

getBdd()

getBdd()

Méthode de connection à la base de données sur demande.

Tous les services web n'ont pas besoin de s'y connecter.

getRestClient()

getRestClient()

Méthode permettant de faire appel à un client REST en fonction des besoins du service.

ajouterMessage()

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.

Parameters

string $message

le message à envoyer.