Subversion Repositories Applications.framework

Rev

Rev 366 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 366 Rev 368
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 366 2011-09-30 08:20:45Z jpm $
 17 
 * @version	$Id: RestService.php 368 2011-10-03 12:46:34Z jpm $
18 
 * @link		/doc/framework/
 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 
	protected $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
30
31 
	public function __construct($config) {
 31 
	public function __construct($config) {
32 
		$this->config = $config;
 32 
		$this->config = $config;
33 
		$this->bdd = new Bdd();
 33 
		$this->bdd = new Bdd();
34 
	}
 34 
	}
35
35
36 
	/**
36 
	/**
37 
	 * Méthode de connection à la base de données sur demande.
 37 
	 * Méthode de connection à la base de données sur demande.
38 
	 * Tous les services web n'ont pas besoin de s'y connecter.
 38 
	 * Tous les services web n'ont pas besoin de s'y connecter.
39 
	 */
 39 
	 */
40 
	protected function getBdd() {
 40 
	protected function getBdd() {
41 
		if (! isset($this->bdd)) {
 41 
		if (! isset($this->bdd)) {
42 
			$this->bdd = new Bdd();
 42 
			$this->bdd = new Bdd();
43 
		}
 43 
		}
44 
		return $this->bdd;
 44 
		return $this->bdd;
45 
	}
 45 
	}
46
46
47 
	/**
47 
	/**
48 
	 * Méthode permettant de faire appel à un client REST en fonction des besoins du service.
 48 
	 * Méthode permettant de faire appel à un client REST en fonction des besoins du service.
49 
	 */
 49 
	 */
50 
	protected function getRestClient() {
 50 
	protected function getRestClient() {
51 
		if (! isset($this->RestClient)) {
 51 
		if (! isset($this->RestClient)) {
52 
			$this->RestClient = new RestClient();
 52 
			$this->RestClient = new RestClient();
53 
		}
 53 
		}
54 
		return $this->RestClient;
 54 
		return $this->RestClient;
55 
	}
 55 
	}
- 
 
 56
- 
 
 57 
	/**
- 
 
 58 
	 * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
- 
 
 59 
	 * Le message doit être au format texte et en UTF-8.
- 
 
 60 
	 * @param string $message le message à envoyer.
- 
 
 61 
	 */
- 
 
 62 
	protected function ajouterMessage($message) {
- 
 
 63 
		RestServeur::ajouterMessage($message);
- 
 
 64 
	}
56
65
57 
	/**
 66 
	/**
58 
	 * Méthode appelée lors d'une requête HTTP de type GET.
 67 
	 * Méthode appelée lors d'une requête HTTP de type GET.
59 
	 *
68 
	 *
60 
	 * Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,
 69 
	 * Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,
61 
	 * la méthode devra retourner le code statut HTTP adéquate.
 70 
	 * la méthode devra retourner le code statut HTTP adéquate.
62 
	 *
71 
	 *
63 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
 72 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
64 
	 * @param array Partie de l'url situé après le '?' servant à paramétrer le service demandé.
 73 
	 * @param array Partie de l'url situé après le '?' servant à paramétrer le service demandé.
65 
	 * @return string une chaine indiquant le succès de l'opération et les données demandées.
 74 
	 * @return string une chaine indiquant le succès de l'opération et les données demandées.
66 
	 */
 75 
	 */
67 
	public function consulter($ressources, $parametres) {
 76 
	public function consulter($ressources, $parametres) {
68 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
 77 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
69 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la consultation.");
 78 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la consultation.");
70 
	}
 79 
	}
71
80
72 
	/**
 81 
	/**
73 
	 * Méthode appelée lors d'une requête HTTP de type POST.
 82 
	 * Méthode appelée lors d'une requête HTTP de type POST.
74 
	 *
83 
	 *
75 
	 * La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps
 84 
	 * La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps
76 
	 * de la requête.
 85 
	 * de la requête.
77 
	 * Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.
 86 
	 * Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.
78 
	 *
87 
	 *
79 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
 88 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
80 
	 * @param array les données transférées dans le corps de la requête devant servir à la modification.
 89 
	 * @param array les données transférées dans le corps de la requête devant servir à la modification.
81 
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
 90 
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
82 
	 */
 91 
	 */
83 
	public function modifier($ressources, $requeteDonnees) {
 92 
	public function modifier($ressources, $requeteDonnees) {
84 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
 93 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
85 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la modification.");
 94 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la modification.");
86 
		return false;
 95 
		return false;
87 
	}
 96 
	}
88
97
89 
	/**
 98 
	/**
90 
	 * Méthode appelée lors d'une requête HTTP de type PUT.
 99 
	 * Méthode appelée lors d'une requête HTTP de type PUT.
91 
	 *
 100 
	 *
92 
	 * L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par
101 
	 * L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par
93 
	 * le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
 102 
	 * le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
94 
	 * Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
 103 
	 * Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
95 
	 * Le code statut HTTP retourné sera 201 en cas de succès.
 104 
	 * Le code statut HTTP retourné sera 201 en cas de succès.
96 
	 * Dans le cas contraire, la méthode devra retourner false.
 105 
	 * Dans le cas contraire, la méthode devra retourner false.
97 
	 *
106 
	 *
98 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
 107 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
99 
	 * @param array les données transférées dans le corps de la requête devant servir à l'ajout.
 108 
	 * @param array les données transférées dans le corps de la requête devant servir à l'ajout.
100 
	 * @return string l'identifiant créé.
 109 
	 * @return string l'identifiant créé.
101 
	 */
 110 
	 */
102 
	public function ajouter($ressources, $requeteDonnees) {
 111 
	public function ajouter($ressources, $requeteDonnees) {
103 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
 112 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
104 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la création.");
 113 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la création.");
105 
		return false;
 114 
		return false;
106 
	}
 115 
	}
107
116
108 
	/**
 117 
	/**
109 
	 * Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).
 118 
	 * Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).
110 
	 *
119 
	 *
111 
	 * Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par
 120 
	 * Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par
112 
	 * RestServeur sera 204.
 121 
	 * RestServeur sera 204.
113 
	 * Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP
 122 
	 * Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP
114 
	 * retourné par RestServeur sera 404.
 123 
	 * retourné par RestServeur sera 404.
115 
	 * Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner
 124 
	 * Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner
116 
	 * la valeur null ou rien.
 125 
	 * la valeur null ou rien.
117 
	 *
126 
	 *
118 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
 127 
	 * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
119 
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
 128 
	 * @return mixed une chaine indiquant le succès de l'opération ou rien.
120 
	 */
 129 
	 */
121 
	public function supprimer($ressources) {
 130 
	public function supprimer($ressources) {
122 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
 131 
		RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
123 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la suppression.");
 132 
		RestServeur::ajouterMessage("Le service '".get_class($this)."' n'autorise pas la suppression.");
124 
		return null;
 133 
		return null;
125 
	}
 134 
	}
126 
}
 135 
}
127 
?>
 136 
?>