Subversion Repositories Applications.framework

Rev

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

Rev 464 Rev 465
1
<!DOCTYPE html>
1
<!DOCTYPE html>
2
<html>
2
<html>
3
<head>
3
<head>
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5
	<meta name="generator" content="ApiGen 2.8.0">
5
	<meta name="generator" content="ApiGen 2.8.0">
6
 
6
 
7
	<title>Class RestService | TBFramework - v0.4</title>
7
	<title>Class RestService</title>
8
 
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?1964084359"></script>
10
	<script type="text/javascript" src="elementlist.js?4111837732"></script>
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
12
 
12
 
13
</head>
13
</head>
14
 
14
 
15
<body>
15
<body>
16
<div id="left">
16
<div id="left">
17
	<div id="menu">
17
	<div id="menu">
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
19
 
19
 
20
 
20
 
21
		<div id="groups">
21
		<div id="groups">
22
			<h3>Packages</h3>
22
			<h3>Packages</h3>
23
			<ul>
23
			<ul>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
25
						</li>
25
						</li>
26
				<li><a href="package-None.html">None</a>
26
				<li><a href="package-None.html">None</a>
27
						</li>
27
						</li>
28
				<li><a href="package-PHP.html">PHP</a>
28
				<li><a href="package-PHP.html">PHP</a>
29
						</li>
29
						</li>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
31
						</li>
31
						</li>
32
			</ul>
32
			</ul>
33
		</div>
33
		</div>
34
 
34
 
35
		<hr>
35
		<hr>
36
 
36
 
37
 
37
 
38
		<div id="elements">
38
		<div id="elements">
39
			<h3>Classes</h3>
39
			<h3>Classes</h3>
40
			<ul>
40
			<ul>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
53
				<li><a href="class-MonService.html">MonService</a></li>
-
 
54
				<li><a href="class-Registre.html">Registre</a></li>
53
				<li><a href="class-Registre.html">Registre</a></li>
55
				<li><a href="class-RestClient.html">RestClient</a></li>
54
				<li><a href="class-RestClient.html">RestClient</a></li>
56
				<li><a href="class-RestServeur.html">RestServeur</a></li>
55
				<li><a href="class-RestServeur.html">RestServeur</a></li>
57
				<li class="active"><a href="class-RestService.html">RestService</a></li>
56
				<li class="active"><a href="class-RestService.html">RestService</a></li>
58
				<li><a href="class-Script.html">Script</a></li>
57
				<li><a href="class-Script.html">Script</a></li>
59
				<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
-
 
60
				<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
-
 
61
				<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
-
 
62
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
58
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
63
				<li><a href="class-Url.html">Url</a></li>
59
				<li><a href="class-Url.html">Url</a></li>
64
			</ul>
60
			</ul>
65
 
61
 
66
 
62
 
67
 
63
 
68
 
64
 
69
 
65
 
70
		</div>
66
		</div>
71
	</div>
67
	</div>
72
</div>
68
</div>
73
 
69
 
74
<div id="splitter"></div>
70
<div id="splitter"></div>
75
 
71
 
76
<div id="right">
72
<div id="right">
77
<div id="rightInner">
73
<div id="rightInner">
78
	<form id="search">
74
	<form id="search">
79
		<input type="hidden" name="cx" value="">
75
		<input type="hidden" name="cx" value="">
80
		<input type="hidden" name="ie" value="UTF-8">
76
		<input type="hidden" name="ie" value="UTF-8">
81
		<input type="text" name="q" class="text">
77
		<input type="text" name="q" class="text">
82
		<input type="submit" value="Search">
78
		<input type="submit" value="Search">
83
	</form>
79
	</form>
84
 
80
 
85
	<div id="navigation">
81
	<div id="navigation">
86
		<ul>
82
		<ul>
87
			<li>
83
			<li>
88
				<a href="index.html" title="Overview"><span>Overview</span></a>
84
				<a href="index.html" title="Overview"><span>Overview</span></a>
89
			</li>
85
			</li>
90
			<li>
86
			<li>
91
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
87
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
92
			</li>
88
			</li>
93
			<li class="active">
89
			<li class="active">
94
<span>Class</span>			</li>
90
<span>Class</span>			</li>
95
		</ul>
91
		</ul>
96
		<ul>
92
		<ul>
97
			<li>
93
			<li>
98
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
94
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
99
			</li>
95
			</li>
100
			<li>
96
			<li>
101
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
97
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
102
			</li>
98
			</li>
103
			<li>
99
			<li>
104
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
100
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
105
			</li>
101
			</li>
106
		</ul>
102
		</ul>
107
		<ul>
103
		<ul>
108
		</ul>
104
		</ul>
109
	</div>
105
	</div>
110
 
106
 
111
<div id="content" class="class">
107
<div id="content" class="class">
112
	<h1>Class RestService</h1>
108
	<h1>Class RestService</h1>
113
 
109
 
114
 
110
 
115
	<div class="description">
111
	<div class="description">
116
	
112
	
117
<p>Classe principale gérant les services. Paramètres liés dans config.ini : -
113
<p>Classe principale gérant les services. Paramètres liés dans config.ini : -
118
serveur.baseURL</p>
114
serveur.baseURL</p>
119
 
115
 
120
<p>Encodage en entrée : utf8 Encodage en sortie : utf8</p>
116
<p>Encodage en entrée : utf8 Encodage en sortie : utf8</p>
121
 
117
 
122
	</div>
118
	</div>
123
 
119
 
124
 
120
 
125
 
-
 
126
	<div>
-
 
127
		<h4>Direct known subclasses</h4>
-
 
128
			<a href="class-MonService.html">MonService</a>, 
-
 
129
			<a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a>, 
-
 
130
			<a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a>, 
-
 
131
			<a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a>
-
 
132
	</div>
121
 
133
 
122
 
134
 
123
 
135
 
124
 
136
 
125
 
137
 
126
 
138
 
127
 
139
	<div class="info">
128
	<div class="info">
140
		<b>Abstract</b><br>
129
		<b>Abstract</b><br>
141
		
130
		
142
		
131
		
143
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
132
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
144
 
133
 
145
				<b>Category:</b>
134
				<b>Category:</b>
146
				Php 5.2<br>
135
				Php 5.2<br>
147
				<b>Copyright:</b>
136
				<b>Copyright:</b>
148
				Copyright (c) 2010, Tela Botanica (<a
137
				Copyright (c) 2010, Tela Botanica (<a
149
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
138
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
150
				<b>License:</b>
139
				<b>License:</b>
151
				<a href="GPL">v3 &lt;http://www.gnu.org/licenses/gpl.txt&gt;</a><br>
140
				<a href="GPL">v3 &lt;http://www.gnu.org/licenses/gpl.txt&gt;</a><br>
152
				<b>License:</b>
141
				<b>License:</b>
153
				<a href="CECILL">v2 &lt;http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt&gt;</a><br>
142
				<a href="CECILL">v2 &lt;http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt&gt;</a><br>
154
				<b>Author:</b>
143
				<b>Author:</b>
155
				Jean-Pascal MILCENT &lt;<a
144
				Jean-Pascal MILCENT &lt;<a
156
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
145
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
157
				<b>Version:</b>
146
				<b>Version:</b>
158
				$Id: RestService.php 417 2012-05-15 09:24:12Z jpm $<br>
147
				$Id: RestService.php 417 2012-05-15 09:24:12Z jpm $<br>
159
				<b>Since:</b>
148
				<b>Since:</b>
160
				0.3<br>
149
				0.3<br>
161
				<b>Link:</b>
150
				<b>Link:</b>
162
				/doc/framework/<br>
151
				/doc/framework/<br>
163
		<b>Located at</b> <a href="source-class-RestService.html#2-150" title="Go to source code">framework/RestService.php</a><br>
152
		<b>Located at</b> <a href="source-class-RestService.html#2-150" title="Go to source code">RestService.php</a><br>
164
	</div>
153
	</div>
165
 
154
 
166
 
155
 
167
 
156
 
168
	<table class="summary" id="methods">
157
	<table class="summary" id="methods">
169
	<caption>Methods summary</caption>
158
	<caption>Methods summary</caption>
170
	<tr data-order="__construct" id="___construct">
159
	<tr data-order="__construct" id="___construct">
171
 
160
 
172
		<td class="attributes"><code>
161
		<td class="attributes"><code>
173
			 public 
162
			 public 
174
			
163
			
175
			
164
			
176
			</code>
165
			</code>
177
		</td>
166
		</td>
178
 
167
 
179
		<td class="name"><div>
168
		<td class="name"><div>
180
		<a class="anchor" href="#___construct">#</a>
169
		<a class="anchor" href="#___construct">#</a>
181
		<code><a href="source-class-RestService.html#34-37" title="Go to source code">__construct</a>( <span>mixed <var>$config</var></span> )</code>
170
		<code><a href="source-class-RestService.html#34-37" title="Go to source code">__construct</a>( <span>mixed <var>$config</var></span> )</code>
182
 
171
 
183
		<div class="description short">
172
		<div class="description short">
184
			
173
			
185
		</div>
174
		</div>
186
 
175
 
187
		<div class="description detailed hidden">
176
		<div class="description detailed hidden">
188
			
177
			
189
 
178
 
190
 
179
 
191
 
180
 
192
 
181
 
193
 
182
 
194
 
183
 
195
 
184
 
196
		</div>
185
		</div>
197
		</div></td>
186
		</div></td>
198
	</tr>
187
	</tr>
199
	<tr data-order="initialiser" id="_initialiser">
188
	<tr data-order="initialiser" id="_initialiser">
200
 
189
 
201
		<td class="attributes"><code>
190
		<td class="attributes"><code>
202
			 public 
191
			 public 
203
			
192
			
204
			
193
			
205
			</code>
194
			</code>
206
		</td>
195
		</td>
207
 
196
 
208
		<td class="name"><div>
197
		<td class="name"><div>
209
		<a class="anchor" href="#_initialiser">#</a>
198
		<a class="anchor" href="#_initialiser">#</a>
210
		<code><a href="source-class-RestService.html#39-41" title="Go to source code">initialiser</a>( )</code>
199
		<code><a href="source-class-RestService.html#39-41" title="Go to source code">initialiser</a>( )</code>
211
 
200
 
212
		<div class="description short">
201
		<div class="description short">
213
			
202
			
214
		</div>
203
		</div>
215
 
204
 
216
		<div class="description detailed hidden">
205
		<div class="description detailed hidden">
217
			
206
			
218
 
207
 
219
 
208
 
220
 
209
 
221
 
210
 
222
 
211
 
223
 
212
 
224
 
213
 
225
		</div>
214
		</div>
226
		</div></td>
215
		</div></td>
227
	</tr>
216
	</tr>
228
	<tr data-order="getBdd" id="_getBdd">
217
	<tr data-order="getBdd" id="_getBdd">
229
 
218
 
230
		<td class="attributes"><code>
219
		<td class="attributes"><code>
231
			 protected 
220
			 protected 
232
			
221
			
233
			
222
			
234
			</code>
223
			</code>
235
		</td>
224
		</td>
236
 
225
 
237
		<td class="name"><div>
226
		<td class="name"><div>
238
		<a class="anchor" href="#_getBdd">#</a>
227
		<a class="anchor" href="#_getBdd">#</a>
239
		<code><a href="source-class-RestService.html#43-52" title="Go to source code">getBdd</a>( )</code>
228
		<code><a href="source-class-RestService.html#43-52" title="Go to source code">getBdd</a>( )</code>
240
 
229
 
241
		<div class="description short">
230
		<div class="description short">
242
			
231
			
243
<p>Méthode de connection à la base de données sur demande. Tous les services
232
<p>Méthode de connection à la base de données sur demande. Tous les services
244
web n'ont pas besoin de s'y connecter.</p>
233
web n'ont pas besoin de s'y connecter.</p>
245
 
234
 
246
		</div>
235
		</div>
247
 
236
 
248
		<div class="description detailed hidden">
237
		<div class="description detailed hidden">
249
			
238
			
250
<p>Méthode de connection à la base de données sur demande. Tous les services
239
<p>Méthode de connection à la base de données sur demande. Tous les services
251
web n'ont pas besoin de s'y connecter.</p>
240
web n'ont pas besoin de s'y connecter.</p>
252
 
241
 
253
 
242
 
254
 
243
 
255
 
244
 
256
 
245
 
257
 
246
 
258
 
247
 
259
 
248
 
260
		</div>
249
		</div>
261
		</div></td>
250
		</div></td>
262
	</tr>
251
	</tr>
263
	<tr data-order="getRestClient" id="_getRestClient">
252
	<tr data-order="getRestClient" id="_getRestClient">
264
 
253
 
265
		<td class="attributes"><code>
254
		<td class="attributes"><code>
266
			 protected 
255
			 protected 
267
			
256
			
268
			
257
			
269
			</code>
258
			</code>
270
		</td>
259
		</td>
271
 
260
 
272
		<td class="name"><div>
261
		<td class="name"><div>
273
		<a class="anchor" href="#_getRestClient">#</a>
262
		<a class="anchor" href="#_getRestClient">#</a>
274
		<code><a href="source-class-RestService.html#54-62" title="Go to source code">getRestClient</a>( )</code>
263
		<code><a href="source-class-RestService.html#54-62" title="Go to source code">getRestClient</a>( )</code>
275
 
264
 
276
		<div class="description short">
265
		<div class="description short">
277
			
266
			
278
<p>Méthode permettant de faire appel à un client REST en fonction des besoins
267
<p>Méthode permettant de faire appel à un client REST en fonction des besoins
279
du service.</p>
268
du service.</p>
280
 
269
 
281
		</div>
270
		</div>
282
 
271
 
283
		<div class="description detailed hidden">
272
		<div class="description detailed hidden">
284
			
273
			
285
<p>Méthode permettant de faire appel à un client REST en fonction des besoins
274
<p>Méthode permettant de faire appel à un client REST en fonction des besoins
286
du service.</p>
275
du service.</p>
287
 
276
 
288
 
277
 
289
 
278
 
290
 
279
 
291
 
280
 
292
 
281
 
293
 
282
 
294
 
283
 
295
		</div>
284
		</div>
296
		</div></td>
285
		</div></td>
297
	</tr>
286
	</tr>
298
	<tr data-order="utiliserParametresBruts" id="_utiliserParametresBruts">
287
	<tr data-order="utiliserParametresBruts" id="_utiliserParametresBruts">
299
 
288
 
300
		<td class="attributes"><code>
289
		<td class="attributes"><code>
301
			 public 
290
			 public 
302
			
291
			
303
			
292
			
304
			</code>
293
			</code>
305
		</td>
294
		</td>
306
 
295
 
307
		<td class="name"><div>
296
		<td class="name"><div>
308
		<a class="anchor" href="#_utiliserParametresBruts">#</a>
297
		<a class="anchor" href="#_utiliserParametresBruts">#</a>
309
		<code><a href="source-class-RestService.html#64-70" title="Go to source code">utiliserParametresBruts</a>( )</code>
298
		<code><a href="source-class-RestService.html#64-70" title="Go to source code">utiliserParametresBruts</a>( )</code>
310
 
299
 
311
		<div class="description short">
300
		<div class="description short">
312
			
301
			
313
<p>Méthode permettant de savoir si le service veut utiliser des paramètres
302
<p>Méthode permettant de savoir si le service veut utiliser des paramètres
314
bruts (issu de la QueryString) ou pas (issu de $_GET).</p>
303
bruts (issu de la QueryString) ou pas (issu de $_GET).</p>
315
 
304
 
316
		</div>
305
		</div>
317
 
306
 
318
		<div class="description detailed hidden">
307
		<div class="description detailed hidden">
319
			
308
			
320
<p>Méthode permettant de savoir si le service veut utiliser des paramètres
309
<p>Méthode permettant de savoir si le service veut utiliser des paramètres
321
bruts (issu de la QueryString) ou pas (issu de $_GET).</p>
310
bruts (issu de la QueryString) ou pas (issu de $_GET).</p>
322
 
311
 
323
 
312
 
324
 
313
 
325
 
314
 
326
 
315
 
327
 
316
 
328
 
317
 
329
 
318
 
330
		</div>
319
		</div>
331
		</div></td>
320
		</div></td>
332
	</tr>
321
	</tr>
333
	<tr data-order="ajouterMessage" id="_ajouterMessage">
322
	<tr data-order="ajouterMessage" id="_ajouterMessage">
334
 
323
 
335
		<td class="attributes"><code>
324
		<td class="attributes"><code>
336
			 protected 
325
			 protected 
337
			
326
			
338
			
327
			
339
			</code>
328
			</code>
340
		</td>
329
		</td>
341
 
330
 
342
		<td class="name"><div>
331
		<td class="name"><div>
343
		<a class="anchor" href="#_ajouterMessage">#</a>
332
		<a class="anchor" href="#_ajouterMessage">#</a>
344
		<code><a href="source-class-RestService.html#72-79" title="Go to source code">ajouterMessage</a>( <span>string <var>$message</var></span> )</code>
333
		<code><a href="source-class-RestService.html#72-79" title="Go to source code">ajouterMessage</a>( <span>string <var>$message</var></span> )</code>
345
 
334
 
346
		<div class="description short">
335
		<div class="description short">
347
			
336
			
348
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
337
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
349
client. Le message doit être au format texte et en UTF-8.</p>
338
client. Le message doit être au format texte et en UTF-8.</p>
350
 
339
 
351
		</div>
340
		</div>
352
 
341
 
353
		<div class="description detailed hidden">
342
		<div class="description detailed hidden">
354
			
343
			
355
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
344
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
356
client. Le message doit être au format texte et en UTF-8.</p>
345
client. Le message doit être au format texte et en UTF-8.</p>
357
 
346
 
358
 
347
 
359
 
348
 
360
				<h4>Parameters</h4>
349
				<h4>Parameters</h4>
361
				<div class="list"><dl>
350
				<div class="list"><dl>
362
					<dt><var>$message</var></dt>
351
					<dt><var>$message</var></dt>
363
					<dd><code>string</code><br>$message le message à envoyer.</dd>
352
					<dd><code>string</code><br>$message le message à envoyer.</dd>
364
				</dl></div>
353
				</dl></div>
365
 
354
 
366
 
355
 
367
 
356
 
368
 
357
 
369
 
358
 
370
		</div>
359
		</div>
371
		</div></td>
360
		</div></td>
372
	</tr>
361
	</tr>
373
	<tr data-order="consulter" id="_consulter">
362
	<tr data-order="consulter" id="_consulter">
374
 
363
 
375
		<td class="attributes"><code>
364
		<td class="attributes"><code>
376
			 public 
365
			 public 
377
			string
366
			string
378
			
367
			
379
			</code>
368
			</code>
380
		</td>
369
		</td>
381
 
370
 
382
		<td class="name"><div>
371
		<td class="name"><div>
383
		<a class="anchor" href="#_consulter">#</a>
372
		<a class="anchor" href="#_consulter">#</a>
384
		<code><a href="source-class-RestService.html#81-94" title="Go to source code">consulter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$parametres</var></span> )</code>
373
		<code><a href="source-class-RestService.html#81-94" title="Go to source code">consulter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$parametres</var></span> )</code>
385
 
374
 
386
		<div class="description short">
375
		<div class="description short">
387
			
376
			
388
<p>Méthode appelée lors d'une requête HTTP de type GET.</p>
377
<p>Méthode appelée lors d'une requête HTTP de type GET.</p>
389
 
378
 
390
		</div>
379
		</div>
391
 
380
 
392
		<div class="description detailed hidden">
381
		<div class="description detailed hidden">
393
			
382
			
394
<p>Méthode appelée lors d'une requête HTTP de type GET.</p>
383
<p>Méthode appelée lors d'une requête HTTP de type GET.</p>
395
 
384
 
396
<p>Si la consultation est un succès, le code statut HTTP retourné sera 200.
385
<p>Si la consultation est un succès, le code statut HTTP retourné sera 200.
397
Dans tous les autres cas, la méthode devra retourner le code statut HTTP
386
Dans tous les autres cas, la méthode devra retourner le code statut HTTP
398
adéquate.</p>
387
adéquate.</p>
399
 
388
 
400
 
389
 
401
 
390
 
402
				<h4>Parameters</h4>
391
				<h4>Parameters</h4>
403
				<div class="list"><dl>
392
				<div class="list"><dl>
404
					<dt><var>$ressources</var></dt>
393
					<dt><var>$ressources</var></dt>
405
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
394
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
406
demandé.</dd>
395
demandé.</dd>
407
					<dt><var>$parametres</var></dt>
396
					<dt><var>$parametres</var></dt>
408
					<dd><code>array</code><br>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</dd>
397
					<dd><code>array</code><br>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</dd>
409
				</dl></div>
398
				</dl></div>
410
 
399
 
411
				<h4>Returns</h4>
400
				<h4>Returns</h4>
412
				<div class="list">
401
				<div class="list">
413
					<code>string</code><br>une chaine indiquant le succès de l'opération et les données demandées.<br>
402
					<code>string</code><br>une chaine indiquant le succès de l'opération et les données demandées.<br>
414
				</div>
403
				</div>
415
 
404
 
416
 
405
 
417
 
406
 
418
 
407
 
419
		</div>
408
		</div>
420
		</div></td>
409
		</div></td>
421
	</tr>
410
	</tr>
422
	<tr data-order="modifier" id="_modifier">
411
	<tr data-order="modifier" id="_modifier">
423
 
412
 
424
		<td class="attributes"><code>
413
		<td class="attributes"><code>
425
			 public 
414
			 public 
426
			mixed
415
			mixed
427
			
416
			
428
			</code>
417
			</code>
429
		</td>
418
		</td>
430
 
419
 
431
		<td class="name"><div>
420
		<td class="name"><div>
432
		<a class="anchor" href="#_modifier">#</a>
421
		<a class="anchor" href="#_modifier">#</a>
433
		<code><a href="source-class-RestService.html#96-111" title="Go to source code">modifier</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code>
422
		<code><a href="source-class-RestService.html#96-111" title="Go to source code">modifier</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code>
434
 
423
 
435
		<div class="description short">
424
		<div class="description short">
436
			
425
			
437
<p>Méthode appelée lors d'une requête HTTP de type POST.</p>
426
<p>Méthode appelée lors d'une requête HTTP de type POST.</p>
438
 
427
 
439
		</div>
428
		</div>
440
 
429
 
441
		<div class="description detailed hidden">
430
		<div class="description detailed hidden">
442
			
431
			
443
<p>Méthode appelée lors d'une requête HTTP de type POST.</p>
432
<p>Méthode appelée lors d'une requête HTTP de type POST.</p>
444
 
433
 
445
<p>La ressource à modifier est indiquée via l'url. Les données devant servir
434
<p>La ressource à modifier est indiquée via l'url. Les données devant servir
446
à la mise à jours sont passées dans le corps de la requête. Si la
435
à la mise à jours sont passées dans le corps de la requête. Si la
447
modification est un succès, la méthode devra retourner "true" et le code
436
modification est un succès, la méthode devra retourner "true" et le code
448
statut HTTP retourné sera 201.</p>
437
statut HTTP retourné sera 201.</p>
449
 
438
 
450
 
439
 
451
 
440
 
452
				<h4>Parameters</h4>
441
				<h4>Parameters</h4>
453
				<div class="list"><dl>
442
				<div class="list"><dl>
454
					<dt><var>$ressources</var></dt>
443
					<dt><var>$ressources</var></dt>
455
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
444
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
456
demandé.</dd>
445
demandé.</dd>
457
					<dt><var>$requeteDonnees</var></dt>
446
					<dt><var>$requeteDonnees</var></dt>
458
					<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à la
447
					<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à la
459
modification.</dd>
448
modification.</dd>
460
				</dl></div>
449
				</dl></div>
461
 
450
 
462
				<h4>Returns</h4>
451
				<h4>Returns</h4>
463
				<div class="list">
452
				<div class="list">
464
					<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br>
453
					<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br>
465
				</div>
454
				</div>
466
 
455
 
467
 
456
 
468
 
457
 
469
 
458
 
470
		</div>
459
		</div>
471
		</div></td>
460
		</div></td>
472
	</tr>
461
	</tr>
473
	<tr data-order="ajouter" id="_ajouter">
462
	<tr data-order="ajouter" id="_ajouter">
474
 
463
 
475
		<td class="attributes"><code>
464
		<td class="attributes"><code>
476
			 public 
465
			 public 
477
			string
466
			string
478
			
467
			
479
			</code>
468
			</code>
480
		</td>
469
		</td>
481
 
470
 
482
		<td class="name"><div>
471
		<td class="name"><div>
483
		<a class="anchor" href="#_ajouter">#</a>
472
		<a class="anchor" href="#_ajouter">#</a>
484
		<code><a href="source-class-RestService.html#113-130" title="Go to source code">ajouter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code>
473
		<code><a href="source-class-RestService.html#113-130" title="Go to source code">ajouter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code>
485
 
474
 
486
		<div class="description short">
475
		<div class="description short">
487
			
476
			
488
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p>
477
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p>
489
 
478
 
490
		</div>
479
		</div>
491
 
480
 
492
		<div class="description detailed hidden">
481
		<div class="description detailed hidden">
493
			
482
			
494
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p>
483
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p>
495
 
484
 
496
<p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le
485
<p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le
497
connait par avance. Sinon, il doit être créé par le service. Dans ce dernier
486
connait par avance. Sinon, il doit être créé par le service. Dans ce dernier
498
cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
487
cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
499
Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
488
Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
500
Le code statut HTTP retourné sera 201 en cas de succès. Dans le cas contraire,
489
Le code statut HTTP retourné sera 201 en cas de succès. Dans le cas contraire,
501
la méthode devra retourner false.</p>
490
la méthode devra retourner false.</p>
502
 
491
 
503
 
492
 
504
 
493
 
505
				<h4>Parameters</h4>
494
				<h4>Parameters</h4>
506
				<div class="list"><dl>
495
				<div class="list"><dl>
507
					<dt><var>$ressources</var></dt>
496
					<dt><var>$ressources</var></dt>
508
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
497
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
509
demandé.</dd>
498
demandé.</dd>
510
					<dt><var>$requeteDonnees</var></dt>
499
					<dt><var>$requeteDonnees</var></dt>
511
					<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à
500
					<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à
512
l'ajout.</dd>
501
l'ajout.</dd>
513
				</dl></div>
502
				</dl></div>
514
 
503
 
515
				<h4>Returns</h4>
504
				<h4>Returns</h4>
516
				<div class="list">
505
				<div class="list">
517
					<code>string</code><br>l'identifiant créé.<br>
506
					<code>string</code><br>l'identifiant créé.<br>
518
				</div>
507
				</div>
519
 
508
 
520
 
509
 
521
 
510
 
522
 
511
 
523
		</div>
512
		</div>
524
		</div></td>
513
		</div></td>
525
	</tr>
514
	</tr>
526
	<tr data-order="supprimer" id="_supprimer">
515
	<tr data-order="supprimer" id="_supprimer">
527
 
516
 
528
		<td class="attributes"><code>
517
		<td class="attributes"><code>
529
			 public 
518
			 public 
530
			mixed
519
			mixed
531
			
520
			
532
			</code>
521
			</code>
533
		</td>
522
		</td>
534
 
523
 
535
		<td class="name"><div>
524
		<td class="name"><div>
536
		<a class="anchor" href="#_supprimer">#</a>
525
		<a class="anchor" href="#_supprimer">#</a>
537
		<code><a href="source-class-RestService.html#132-149" title="Go to source code">supprimer</a>( <span>array <var>$ressources</var></span> )</code>
526
		<code><a href="source-class-RestService.html#132-149" title="Go to source code">supprimer</a>( <span>array <var>$ressources</var></span> )</code>
538
 
527
 
539
		<div class="description short">
528
		<div class="description short">
540
			
529
			
541
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
530
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
542
action=DELETE dans le corps de la requete).</p>
531
action=DELETE dans le corps de la requete).</p>
543
 
532
 
544
		</div>
533
		</div>
545
 
534
 
546
		<div class="description detailed hidden">
535
		<div class="description detailed hidden">
547
			
536
			
548
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
537
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec
549
action=DELETE dans le corps de la requete).</p>
538
action=DELETE dans le corps de la requete).</p>
550
 
539
 
551
<p>Si la suppression est un succès, la méthode devra retourner "true" et le
540
<p>Si la suppression est un succès, la méthode devra retourner "true" et le
552
code statut HTTP retourné par RestServeur sera 204. Si la ressource à
541
code statut HTTP retourné par RestServeur sera 204. Si la ressource à
553
supprimer est introuvable, la méthode devra retourner "false" et le code statut
542
supprimer est introuvable, la méthode devra retourner "false" et le code statut
554
HTTP retourné par RestServeur sera 404. Dans les autres cas de figure ou si
543
HTTP retourné par RestServeur sera 404. Dans les autres cas de figure ou si
555
vous souhaitez gérer vos propres codes de retour erreur, retourner la valeur
544
vous souhaitez gérer vos propres codes de retour erreur, retourner la valeur
556
null ou rien.</p>
545
null ou rien.</p>
557
 
546
 
558
 
547
 
559
 
548
 
560
				<h4>Parameters</h4>
549
				<h4>Parameters</h4>
561
				<div class="list"><dl>
550
				<div class="list"><dl>
562
					<dt><var>$ressources</var></dt>
551
					<dt><var>$ressources</var></dt>
563
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
552
					<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service
564
demandé.</dd>
553
demandé.</dd>
565
				</dl></div>
554
				</dl></div>
566
 
555
 
567
				<h4>Returns</h4>
556
				<h4>Returns</h4>
568
				<div class="list">
557
				<div class="list">
569
					<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br>
558
					<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br>
570
				</div>
559
				</div>
571
 
560
 
572
 
561
 
573
 
562
 
574
 
563
 
575
		</div>
564
		</div>
576
		</div></td>
565
		</div></td>
577
	</tr>
566
	</tr>
578
	</table>
567
	</table>
579
 
568
 
580
 
569
 
581
 
570
 
582
 
571
 
583
 
572
 
584
 
573
 
585
 
574
 
586
 
575
 
587
 
576
 
588
 
577
 
589
 
578
 
590
 
579
 
591
	<table class="summary" id="properties">
580
	<table class="summary" id="properties">
592
	<caption>Properties summary</caption>
581
	<caption>Properties summary</caption>
593
	<tr data-order="bdd" id="$bdd">
582
	<tr data-order="bdd" id="$bdd">
594
		<td class="attributes"><code>
583
		<td class="attributes"><code>
595
			protected  
584
			protected  
596
			mixed
585
			mixed
597
		</code></td>
586
		</code></td>
598
 
587
 
599
		<td class="name">
588
		<td class="name">
600
				<a href="source-class-RestService.html#22-26" title="Go to source code"><var>$bdd</var></a>
589
				<a href="source-class-RestService.html#22-26" title="Go to source code"><var>$bdd</var></a>
601
		</td>
590
		</td>
602
		<td class="value"><code><span class="php-keyword1">null</span></code></td>
591
		<td class="value"><code><span class="php-keyword1">null</span></code></td>
603
		<td class="description"><div>
592
		<td class="description"><div>
604
			<a href="#$bdd" class="anchor">#</a>
593
			<a href="#$bdd" class="anchor">#</a>
605
 
594
 
606
			<div class="description short">
595
			<div class="description short">
607
				
596
				
608
<p>Objet de connection à la base de données.</p>
597
<p>Objet de connection à la base de données.</p>
609
 
598
 
610
			</div>
599
			</div>
611
 
600
 
612
			<div class="description detailed hidden">
601
			<div class="description detailed hidden">
613
				
602
				
614
<p>Objet de connection à la base de données.</p>
603
<p>Objet de connection à la base de données.</p>
615
 
604
 
616
 
605
 
617
					<h4>Deprecated</h4>
606
					<h4>Deprecated</h4>
618
					<div class="list">
607
					<div class="list">
619
							Utiliser la methode getBdd().<br>
608
							Utiliser la methode getBdd().<br>
620
					</div>
609
					</div>
621
					<h4>See</h4>
610
					<h4>See</h4>
622
					<div class="list">
611
					<div class="list">
623
							<code><code><a href="class-RestService.html#_getBdd">RestService::getBdd()</a></code></code><br>
612
							<code><code><a href="class-RestService.html#_getBdd">RestService::getBdd()</a></code></code><br>
624
					</div>
613
					</div>
625
			</div>
614
			</div>
626
		</div></td>
615
		</div></td>
627
	</tr>
616
	</tr>
628
	<tr data-order="utilisationParametresBruts" id="$utilisationParametresBruts">
617
	<tr data-order="utilisationParametresBruts" id="$utilisationParametresBruts">
629
		<td class="attributes"><code>
618
		<td class="attributes"><code>
630
			protected  
619
			protected  
631
			boolean
620
			boolean
632
		</code></td>
621
		</code></td>
633
 
622
 
634
		<td class="name">
623
		<td class="name">
635
				<a href="source-class-RestService.html#31-32" title="Go to source code"><var>$utilisationParametresBruts</var></a>
624
				<a href="source-class-RestService.html#31-32" title="Go to source code"><var>$utilisationParametresBruts</var></a>
636
		</td>
625
		</td>
637
		<td class="value"><code><span class="php-keyword1">false</span></code></td>
626
		<td class="value"><code><span class="php-keyword1">false</span></code></td>
638
		<td class="description"><div>
627
		<td class="description"><div>
639
			<a href="#$utilisationParametresBruts" class="anchor">#</a>
628
			<a href="#$utilisationParametresBruts" class="anchor">#</a>
640
 
629
 
641
			<div class="description short">
630
			<div class="description short">
642
				
631
				
643
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres
632
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres
644
brutes.</p>
633
brutes.</p>
645
 
634
 
646
			</div>
635
			</div>
647
 
636
 
648
			<div class="description detailed hidden">
637
			<div class="description detailed hidden">
649
				
638
				
650
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres
639
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres
651
brutes.</p>
640
brutes.</p>
652
 
641
 
653
 
642
 
654
			</div>
643
			</div>
655
		</div></td>
644
		</div></td>
656
	</tr>
645
	</tr>
657
	</table>
646
	</table>
658
 
647
 
659
 
648
 
660
 
649
 
661
 
650
 
662
 
651
 
663
 
652
 
664
</div>
653
</div>
665
 
654
 
666
	<div id="footer">
655
	<div id="footer">
667
		TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
656
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
668
	</div>
657
	</div>
669
</div>
658
</div>
670
</div>
659
</div>
671
</body>
660
</body>
672
</html>
661
</html>