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