Subversion Repositories Applications.framework

Rev

Rev 362 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
232 jpm 1
<?php
2
/**
3
 * Classe principale gérant les services.
4
 * Paramètres liés dans config.ini :
5
 *  - serveur.baseURL
6
 *
7
 * Encodage en entrée : utf8
8
 * Encodage en sortie : utf8
9
 *
10
 * @category	Php 5.2
11
 * @package	Framework
12
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
13
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
14
 * @license	GPL v3 <http://www.gnu.org/licenses/gpl.txt>
15
 * @license	CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
241 jpm 16
 * @since 		0.3
17
 * @version	$Id: RestService.php 368 2011-10-03 12:46:34Z jpm $
360 jpm 18
 * @link		http://www.tela-botanica.org/wikini/DevInformatiques/wakka.php?wiki=AppliBaseDocV3RestServeur
232 jpm 19
 */
287 jpm 20
abstract class RestService {
232 jpm 21
 
360 jpm 22
	/** Objet de connection à la base de données.
23
	 * @deprecated Utiliser la methode getBdd().
24
	 * @see getBdd()
25
	 */
362 jpm 26
	private $bdd = null;
237 jpm 27
 
360 jpm 28
	/** Objet Rest Client. */
29
	private $RestClient = null;
30
 
232 jpm 31
	public function __construct($config) {
360 jpm 32
		$this->config = $config;
232 jpm 33
	}
34
 
360 jpm 35
	/**
36
	 * Méthode de connection à la base de données sur demande.
37
	 * Tous les services web n'ont pas besoin de s'y connecter.
38
	 */
39
	protected function getBdd() {
40
		if (! isset($this->bdd)) {
361 jpm 41
			$this->bdd = new Bdd();
360 jpm 42
		}
43
		return $this->bdd;
44
	}
45
 
46
	/**
47
	 * Méthode permettant de faire appel à un client REST en fonction des besoins du service.
48
	 */
49
	protected function getRestClient() {
50
		if (! isset($this->RestClient)) {
51
			$this->RestClient = new RestClient();
52
		}
53
		return $this->RestClient;
54
	}
368 jpm 55
 
56
	/**
57
	 * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
58
	 * Le message doit être au format texte et en UTF-8.
59
	 * @param string $message le message à envoyer.
60
	 */
61
	protected function ajouterMessage($message) {
62
		RestServeur::ajouterMessage($message);
63
	}
360 jpm 64
 
232 jpm 65
	/**
66
	 * Méthode appelée lors d'une requête HTTP de type GET.
67
	 *
360 jpm 68
	 * Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,
69
	 * la méthode devra retourner le code statut HTTP adéquate.
232 jpm 70
	 *
71
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
72
	 * @param array Partie de l'url situé après le '?' servant à paramétrer le service demandé.
73
	 * @return string une chaine indiquant le succès de l'opération et les données demandées.
74
	 */
75
	public function consulter($ressources, $parametres) {
287 jpm 76
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
360 jpm 77
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la consultation.");
232 jpm 78
	}
79
 
80
	/**
81
	 * Méthode appelée lors d'une requête HTTP de type POST.
82
	 *
83
	 * La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps
84
	 * de la requête.
360 jpm 85
	 * Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.
232 jpm 86
	 *
87
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
88
	 * @param array les données transférées dans le corps de la requête devant servir à la modification.
89
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
90
	 */
91
	public function modifier($ressources, $requeteDonnees) {
287 jpm 92
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
360 jpm 93
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la modification.");
94
		return false;
232 jpm 95
	}
96
 
97
	/**
98
	 * Méthode appelée lors d'une requête HTTP de type PUT.
99
	 *
100
	 * L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par
101
	 * le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
360 jpm 102
	 * Si l'ajout est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.
232 jpm 103
	 *
104
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
105
	 * @param array les données transférées dans le corps de la requête devant servir à l'ajout.
106
	 * @return string l'identifiant créé.
107
	 */
108
	public function ajouter($ressources, $requeteDonnees) {
287 jpm 109
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
360 jpm 110
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la création.");
111
		return false;
232 jpm 112
	}
113
 
114
	/**
115
	 * Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).
116
	 *
360 jpm 117
	 * Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par
118
	 * RestServeur sera 204.
119
	 * Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP
120
	 * retourné par RestServeur sera 404.
121
	 * Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner
122
	 * la valeur null ou rien.
232 jpm 123
	 *
124
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
125
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
126
	 */
127
	public function supprimer($ressources) {
287 jpm 128
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
360 jpm 129
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la suppression.");
130
		return null;
232 jpm 131
	}
132
}
133
?>