Subversion Repositories Applications.framework

Rev

Rev 368 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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