Subversion Repositories Applications.framework

Rev

Rev 368 | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 368 Rev 417
Line 12... Line 12...
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 {
Line 21... Line 21...
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
	 */
Line 26... Line 26...
26
	private $bdd = null;
26
	protected $bdd = null;
27
	
27
	
Line -... Line 28...
-
 
28
	/** Objet Rest Client. */
-
 
29
	private $RestClient = null;
-
 
30
	
28
	/** Objet Rest Client. */
31
	/** Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes. */
29
	private $RestClient = null;
32
	protected $utilisationParametresBruts = false;
-
 
33
	
-
 
34
	public function __construct($config) {
-
 
35
		$this->config = $config;
-
 
36
		$this->bdd = new Bdd();
-
 
37
	}
30
	
38
	
Line 31... Line 39...
31
	public function __construct($config) {
39
	public function initialiser() {
32
		$this->config = $config;		
40
		
33
	}
41
	}
Line 52... Line 60...
52
		}
60
		}
53
		return $this->RestClient;
61
		return $this->RestClient;
54
	}
62
	}
Line 55... Line 63...
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
	 */
Line 97... Line 113...
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
	 */