| 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 RestServeur | 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 class="active"><a href="class-RestServeur.html">RestServeur</a></li>
|
|
|
57 |
<li><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 RestServeur</h1>
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
|
|
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
<div class="info">
|
|
|
125 |
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
|
|
|
129 |
|
|
|
130 |
<b>Copyright:</b>
|
|
|
131 |
Copyright (c) 2010, Tela Botanica (<a
|
|
|
132 |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br>
|
|
|
133 |
<b>License:</b>
|
|
|
134 |
<a href="GPL">v3 <http://www.gnu.org/licenses/gpl.txt></a><br>
|
|
|
135 |
<b>License:</b>
|
|
|
136 |
<a href="CECILL">v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt></a><br>
|
|
|
137 |
<b>Author:</b>
|
|
|
138 |
Jean-Pascal MILCENT <<a
|
|
|
139 |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br>
|
|
|
140 |
<b>Located at</b> <a href="source-class-RestServeur.html#42-666" title="Go to source code">framework/RestServeur.php</a><br>
|
|
|
141 |
</div>
|
|
|
142 |
|
|
|
143 |
|
|
|
144 |
|
|
|
145 |
<table class="summary" id="methods">
|
|
|
146 |
<caption>Methods summary</caption>
|
|
|
147 |
<tr data-order="__construct" id="___construct">
|
|
|
148 |
|
|
|
149 |
<td class="attributes"><code>
|
|
|
150 |
public
|
|
|
151 |
|
|
|
152 |
|
|
|
153 |
</code>
|
|
|
154 |
</td>
|
|
|
155 |
|
|
|
156 |
<td class="name"><div>
|
|
|
157 |
<a class="anchor" href="#___construct">#</a>
|
|
|
158 |
<code><a href="source-class-RestServeur.html#192-220" title="Go to source code">__construct</a>( )</code>
|
|
|
159 |
|
|
|
160 |
<div class="description short">
|
|
|
161 |
|
|
|
162 |
<p>Analyse les données envoyées au serveur, enregistre la méthode HTTP
|
|
|
163 |
utilisée pour appeler le serveur et parse l'url appelée pour trouver le
|
|
|
164 |
service demandé.</p>
|
|
|
165 |
|
|
|
166 |
</div>
|
|
|
167 |
|
|
|
168 |
<div class="description detailed hidden">
|
|
|
169 |
|
|
|
170 |
<p>Analyse les données envoyées au serveur, enregistre la méthode HTTP
|
|
|
171 |
utilisée pour appeler le serveur et parse l'url appelée pour trouver le
|
|
|
172 |
service demandé.</p>
|
|
|
173 |
|
|
|
174 |
|
|
|
175 |
|
|
|
176 |
|
|
|
177 |
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
|
181 |
</div>
|
|
|
182 |
</div></td>
|
|
|
183 |
</tr>
|
|
|
184 |
<tr data-order="chargerClasse" id="_chargerClasse">
|
|
|
185 |
|
|
|
186 |
<td class="attributes"><code>
|
|
|
187 |
public static
|
|
|
188 |
|
|
|
189 |
|
|
|
190 |
</code>
|
|
|
191 |
</td>
|
|
|
192 |
|
|
|
193 |
<td class="name"><div>
|
|
|
194 |
<a class="anchor" href="#_chargerClasse">#</a>
|
|
|
195 |
<code><a href="source-class-RestServeur.html#364-382" title="Go to source code">chargerClasse</a>( <span>string <var>$classe</var></span> )</code>
|
|
|
196 |
|
|
|
197 |
<div class="description short">
|
|
|
198 |
|
|
|
199 |
<p>La méthode __autoload() charge dynamiquement les classes trouvées dans le
|
|
|
200 |
code. Cette fonction est appelée par php5 quand il trouve une instanciation de
|
|
|
201 |
classe dans le code.</p>
|
|
|
202 |
|
|
|
203 |
</div>
|
|
|
204 |
|
|
|
205 |
<div class="description detailed hidden">
|
|
|
206 |
|
|
|
207 |
<p>La méthode __autoload() charge dynamiquement les classes trouvées dans le
|
|
|
208 |
code. Cette fonction est appelée par php5 quand il trouve une instanciation de
|
|
|
209 |
classe dans le code.</p>
|
|
|
210 |
|
|
|
211 |
|
|
|
212 |
|
|
|
213 |
<h4>Parameters</h4>
|
|
|
214 |
<div class="list"><dl>
|
|
|
215 |
<dt><var>$classe</var></dt>
|
|
|
216 |
<dd><code>string</code><br>le nom de la classe appelée.</dd>
|
|
|
217 |
</dl></div>
|
|
|
218 |
|
|
|
219 |
<h4>Returns</h4>
|
|
|
220 |
<div class="list">
|
|
|
221 |
<code></code><br>le fichier contenant la classe doit être inclu par la fonction.<br>
|
|
|
222 |
</div>
|
|
|
223 |
|
|
|
224 |
|
|
|
225 |
|
|
|
226 |
|
|
|
227 |
</div>
|
|
|
228 |
</div></td>
|
|
|
229 |
</tr>
|
|
|
230 |
<tr data-order="executer" id="_executer">
|
|
|
231 |
|
|
|
232 |
<td class="attributes"><code>
|
|
|
233 |
public
|
|
|
234 |
|
|
|
235 |
|
|
|
236 |
</code>
|
|
|
237 |
</td>
|
|
|
238 |
|
|
|
239 |
<td class="name"><div>
|
|
|
240 |
<a class="anchor" href="#_executer">#</a>
|
|
|
241 |
<code><a href="source-class-RestServeur.html#384-419" title="Go to source code">executer</a>( )</code>
|
|
|
242 |
|
|
|
243 |
<div class="description short">
|
|
|
244 |
|
|
|
245 |
<p>Execute la requête.</p>
|
|
|
246 |
|
|
|
247 |
</div>
|
|
|
248 |
|
|
|
249 |
<div class="description detailed hidden">
|
|
|
250 |
|
|
|
251 |
<p>Execute la requête.</p>
|
|
|
252 |
|
|
|
253 |
|
|
|
254 |
|
|
|
255 |
|
|
|
256 |
|
|
|
257 |
|
|
|
258 |
|
|
|
259 |
|
|
|
260 |
</div>
|
|
|
261 |
</div></td>
|
|
|
262 |
</tr>
|
|
|
263 |
<tr data-order="envoyerEnteteStatutHttp" id="_envoyerEnteteStatutHttp">
|
|
|
264 |
|
|
|
265 |
<td class="attributes"><code>
|
|
|
266 |
public static
|
|
|
267 |
|
|
|
268 |
|
|
|
269 |
</code>
|
|
|
270 |
</td>
|
|
|
271 |
|
|
|
272 |
<td class="name"><div>
|
|
|
273 |
<a class="anchor" href="#_envoyerEnteteStatutHttp">#</a>
|
|
|
274 |
<code><a href="source-class-RestServeur.html#569-579" title="Go to source code">envoyerEnteteStatutHttp</a>( <span>integer <var>$code</var></span> )</code>
|
|
|
275 |
|
|
|
276 |
<div class="description short">
|
|
|
277 |
|
|
|
278 |
<p>Envoyer un entête HTTP (version 1.0) de statut. Il remplacera
|
|
|
279 |
systématiquement tout entête HTTP de statut précédement envoyé.</p>
|
|
|
280 |
|
|
|
281 |
</div>
|
|
|
282 |
|
|
|
283 |
<div class="description detailed hidden">
|
|
|
284 |
|
|
|
285 |
<p>Envoyer un entête HTTP (version 1.0) de statut. Il remplacera
|
|
|
286 |
systématiquement tout entête HTTP de statut précédement envoyé.</p>
|
|
|
287 |
|
|
|
288 |
|
|
|
289 |
|
|
|
290 |
<h4>Parameters</h4>
|
|
|
291 |
<div class="list"><dl>
|
|
|
292 |
<dt><var>$code</var></dt>
|
|
|
293 |
<dd><code>integer</code><br>$code entier indiquant le code du statut de l'entête HTTP à envoyer.</dd>
|
|
|
294 |
</dl></div>
|
|
|
295 |
|
|
|
296 |
|
|
|
297 |
|
|
|
298 |
|
|
|
299 |
|
|
|
300 |
</div>
|
|
|
301 |
</div></td>
|
|
|
302 |
</tr>
|
|
|
303 |
<tr data-order="gererErreurs" id="_gererErreurs">
|
|
|
304 |
|
|
|
305 |
<td class="attributes"><code>
|
|
|
306 |
public static
|
|
|
307 |
|
|
|
308 |
|
|
|
309 |
</code>
|
|
|
310 |
</td>
|
|
|
311 |
|
|
|
312 |
<td class="name"><div>
|
|
|
313 |
<a class="anchor" href="#_gererErreurs">#</a>
|
|
|
314 |
<code><a href="source-class-RestServeur.html#601-642" title="Go to source code">gererErreurs</a>( )</code>
|
|
|
315 |
|
|
|
316 |
<div class="description short">
|
|
|
317 |
|
|
|
318 |
<p>Si des exceptions ou des erreurs sont soulevées par le serveur ou les
|
|
|
319 |
services, elles sont gérées par cette méthode. Si nous avec des erreurs d'un
|
|
|
320 |
type différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyées
|
|
|
321 |
sur la sortie standard (via echo). Si seulement des erreurs de type
|
|
|
322 |
E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du
|
|
|
323 |
paramètre de config "debogage_mode" :<br />
|
|
|
324 |
- Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où
|
|
|
325 |
ils sont déclenchés dans le code.<br />
|
|
|
326 |
- Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception
|
|
|
327 |
sous forme d'erreur de type<br />
|
|
|
328 |
E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution
|
|
|
329 |
du programme (via echo).<br />
|
|
|
330 |
- Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire
|
|
|
331 |
d'exception sous forme d'erreur de type<br />
|
|
|
332 |
E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES)
|
|
|
333 |
à la fin de l'execution du programme.<br />
|
|
|
334 |
- Autre valeur : les messages sont formatés puis retournés par la fonction de
|
|
|
335 |
débogage (à vous de les afficher).</p>
|
|
|
336 |
|
|
|
337 |
</div>
|
|
|
338 |
|
|
|
339 |
<div class="description detailed hidden">
|
|
|
340 |
|
|
|
341 |
<p>Si des exceptions ou des erreurs sont soulevées par le serveur ou les
|
|
|
342 |
services, elles sont gérées par cette méthode. Si nous avec des erreurs d'un
|
|
|
343 |
type différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyées
|
|
|
344 |
sur la sortie standard (via echo). Si seulement des erreurs de type
|
|
|
345 |
E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du
|
|
|
346 |
paramètre de config "debogage_mode" : - Debug::MODE_ECHO : les messages sont
|
|
|
347 |
affichés en utilisant echo au moment où ils sont déclenchés dans le code. -
|
|
|
348 |
Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception
|
|
|
349 |
sous forme d'erreur de type E_USER_NOTICE et sont renvoyés sur la sortie
|
|
|
350 |
standard à la fin de l'execution du programme (via echo). -
|
|
|
351 |
Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire
|
|
|
352 |
d'exception sous forme d'erreur de type E_USER_NOTICE et sont renvoyés dans un
|
|
|
353 |
entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme. -
|
|
|
354 |
Autre valeur : les messages sont formatés puis retournés par la fonction de
|
|
|
355 |
débogage (à vous de les afficher).</p>
|
|
|
356 |
|
|
|
357 |
|
|
|
358 |
|
|
|
359 |
|
|
|
360 |
|
|
|
361 |
|
|
|
362 |
|
|
|
363 |
|
|
|
364 |
</div>
|
|
|
365 |
</div></td>
|
|
|
366 |
</tr>
|
|
|
367 |
<tr data-order="ajouterMessage" id="_ajouterMessage">
|
|
|
368 |
|
|
|
369 |
<td class="attributes"><code>
|
|
|
370 |
public static
|
|
|
371 |
|
|
|
372 |
|
|
|
373 |
</code>
|
|
|
374 |
</td>
|
|
|
375 |
|
|
|
376 |
<td class="name"><div>
|
|
|
377 |
<a class="anchor" href="#_ajouterMessage">#</a>
|
|
|
378 |
<code><a href="source-class-RestServeur.html#645-654" title="Go to source code">ajouterMessage</a>( <span>string <var>$message</var></span> )</code>
|
|
|
379 |
|
|
|
380 |
<div class="description short">
|
|
|
381 |
|
|
|
382 |
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
|
|
|
383 |
client. Le message doit être au format texte et en UTF-8.</p>
|
|
|
384 |
|
|
|
385 |
</div>
|
|
|
386 |
|
|
|
387 |
<div class="description detailed hidden">
|
|
|
388 |
|
|
|
389 |
<p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au
|
|
|
390 |
client. Le message doit être au format texte et en UTF-8.</p>
|
|
|
391 |
|
|
|
392 |
|
|
|
393 |
|
|
|
394 |
<h4>Parameters</h4>
|
|
|
395 |
<div class="list"><dl>
|
|
|
396 |
<dt><var>$message</var></dt>
|
|
|
397 |
<dd><code>string</code><br>$message le message à envoyer.</dd>
|
|
|
398 |
</dl></div>
|
|
|
399 |
|
|
|
400 |
|
|
|
401 |
|
|
|
402 |
|
|
|
403 |
|
|
|
404 |
</div>
|
|
|
405 |
</div></td>
|
|
|
406 |
</tr>
|
|
|
407 |
</table>
|
|
|
408 |
|
|
|
409 |
|
|
|
410 |
|
|
|
411 |
|
|
|
412 |
|
|
|
413 |
|
|
|
414 |
|
|
|
415 |
|
|
|
416 |
<table class="summary" id="constants">
|
|
|
417 |
<caption>Constants summary</caption>
|
|
|
418 |
<tr data-order="METHODE_GET" id="METHODE_GET">
|
|
|
419 |
|
|
|
420 |
<td class="attributes"><code>string</code></td>
|
|
|
421 |
<td class="name"><code>
|
|
|
422 |
<a href="source-class-RestServeur.html#44-45" title="Go to source code"><b>METHODE_GET</b></a>
|
|
|
423 |
</code></td>
|
|
|
424 |
<td class="value"><code><span class="php-quote">'consulter'</span></code></td>
|
|
|
425 |
<td class="description"><div>
|
|
|
426 |
<a href="#METHODE_GET" class="anchor">#</a>
|
|
|
427 |
|
|
|
428 |
<div class="description short">
|
|
|
429 |
|
|
|
430 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
431 |
type GET.</p>
|
|
|
432 |
|
|
|
433 |
</div>
|
|
|
434 |
|
|
|
435 |
<div class="description detailed hidden">
|
|
|
436 |
|
|
|
437 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
438 |
type GET.</p>
|
|
|
439 |
|
|
|
440 |
|
|
|
441 |
</div>
|
|
|
442 |
</div></td>
|
|
|
443 |
</tr>
|
|
|
444 |
<tr data-order="METHODE_POST" id="METHODE_POST">
|
|
|
445 |
|
|
|
446 |
<td class="attributes"><code>string</code></td>
|
|
|
447 |
<td class="name"><code>
|
|
|
448 |
<a href="source-class-RestServeur.html#47-48" title="Go to source code"><b>METHODE_POST</b></a>
|
|
|
449 |
</code></td>
|
|
|
450 |
<td class="value"><code><span class="php-quote">'modifier'</span></code></td>
|
|
|
451 |
<td class="description"><div>
|
|
|
452 |
<a href="#METHODE_POST" class="anchor">#</a>
|
|
|
453 |
|
|
|
454 |
<div class="description short">
|
|
|
455 |
|
|
|
456 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
457 |
type POST.</p>
|
|
|
458 |
|
|
|
459 |
</div>
|
|
|
460 |
|
|
|
461 |
<div class="description detailed hidden">
|
|
|
462 |
|
|
|
463 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
464 |
type POST.</p>
|
|
|
465 |
|
|
|
466 |
|
|
|
467 |
</div>
|
|
|
468 |
</div></td>
|
|
|
469 |
</tr>
|
|
|
470 |
<tr data-order="METHODE_DELETE" id="METHODE_DELETE">
|
|
|
471 |
|
|
|
472 |
<td class="attributes"><code>string</code></td>
|
|
|
473 |
<td class="name"><code>
|
|
|
474 |
<a href="source-class-RestServeur.html#50-51" title="Go to source code"><b>METHODE_DELETE</b></a>
|
|
|
475 |
</code></td>
|
|
|
476 |
<td class="value"><code><span class="php-quote">'supprimer'</span></code></td>
|
|
|
477 |
<td class="description"><div>
|
|
|
478 |
<a href="#METHODE_DELETE" class="anchor">#</a>
|
|
|
479 |
|
|
|
480 |
<div class="description short">
|
|
|
481 |
|
|
|
482 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
483 |
type DELETE.</p>
|
|
|
484 |
|
|
|
485 |
</div>
|
|
|
486 |
|
|
|
487 |
<div class="description detailed hidden">
|
|
|
488 |
|
|
|
489 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
490 |
type DELETE.</p>
|
|
|
491 |
|
|
|
492 |
|
|
|
493 |
</div>
|
|
|
494 |
</div></td>
|
|
|
495 |
</tr>
|
|
|
496 |
<tr data-order="METHODE_PUT" id="METHODE_PUT">
|
|
|
497 |
|
|
|
498 |
<td class="attributes"><code>string</code></td>
|
|
|
499 |
<td class="name"><code>
|
|
|
500 |
<a href="source-class-RestServeur.html#53-54" title="Go to source code"><b>METHODE_PUT</b></a>
|
|
|
501 |
</code></td>
|
|
|
502 |
<td class="value"><code><span class="php-quote">'ajouter'</span></code></td>
|
|
|
503 |
<td class="description"><div>
|
|
|
504 |
<a href="#METHODE_PUT" class="anchor">#</a>
|
|
|
505 |
|
|
|
506 |
<div class="description short">
|
|
|
507 |
|
|
|
508 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
509 |
type PUT.</p>
|
|
|
510 |
|
|
|
511 |
</div>
|
|
|
512 |
|
|
|
513 |
<div class="description detailed hidden">
|
|
|
514 |
|
|
|
515 |
<p>Nom de la méthode appelée dans un service pour éxécuter une requête de
|
|
|
516 |
type PUT.</p>
|
|
|
517 |
|
|
|
518 |
|
|
|
519 |
</div>
|
|
|
520 |
</div></td>
|
|
|
521 |
</tr>
|
|
|
522 |
<tr data-order="HTTP_CODE_OK" id="HTTP_CODE_OK">
|
|
|
523 |
|
|
|
524 |
<td class="attributes"><code>string</code></td>
|
|
|
525 |
<td class="name"><code>
|
|
|
526 |
<a href="source-class-RestServeur.html#56-59" title="Go to source code"><b>HTTP_CODE_OK</b></a>
|
|
|
527 |
</code></td>
|
|
|
528 |
<td class="value"><code><span class="php-quote">'200'</span></code></td>
|
|
|
529 |
<td class="description"><div>
|
|
|
530 |
<a href="#HTTP_CODE_OK" class="anchor">#</a>
|
|
|
531 |
|
|
|
532 |
<div class="description short">
|
|
|
533 |
|
|
|
534 |
<p>Code HTTP 200 indiquant le succès de l'accès à un service web par la
|
|
|
535 |
méthode GET. L'utiliser lors d'une requète de type GET (consulter) pour
|
|
|
536 |
indiquer le succès de l'opération. Sera renvoyée par défaut par PHP.</p>
|
|
|
537 |
|
|
|
538 |
</div>
|
|
|
539 |
|
|
|
540 |
<div class="description detailed hidden">
|
|
|
541 |
|
|
|
542 |
<p>Code HTTP 200 indiquant le succès de l'accès à un service web par la
|
|
|
543 |
méthode GET. L'utiliser lors d'une requète de type GET (consulter) pour
|
|
|
544 |
indiquer le succès de l'opération. Sera renvoyée par défaut par PHP.</p>
|
|
|
545 |
|
|
|
546 |
|
|
|
547 |
</div>
|
|
|
548 |
</div></td>
|
|
|
549 |
</tr>
|
|
|
550 |
<tr data-order="HTTP_CODE_CREATION_OK" id="HTTP_CODE_CREATION_OK">
|
|
|
551 |
|
|
|
552 |
<td class="attributes"><code>string</code></td>
|
|
|
553 |
<td class="name"><code>
|
|
|
554 |
<a href="source-class-RestServeur.html#61-63" title="Go to source code"><b>HTTP_CODE_CREATION_OK</b></a>
|
|
|
555 |
</code></td>
|
|
|
556 |
<td class="value"><code><span class="php-quote">'201'</span></code></td>
|
|
|
557 |
<td class="description"><div>
|
|
|
558 |
<a href="#HTTP_CODE_CREATION_OK" class="anchor">#</a>
|
|
|
559 |
|
|
|
560 |
<div class="description short">
|
|
|
561 |
|
|
|
562 |
<p>Code HTTP 201 indiquant que l'accès à un service web est un succès et que
|
|
|
563 |
la ressource a été créée ou modifié. L'utiliser lors d'une requète de type
|
|
|
564 |
PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p>
|
|
|
565 |
|
|
|
566 |
</div>
|
|
|
567 |
|
|
|
568 |
<div class="description detailed hidden">
|
|
|
569 |
|
|
|
570 |
<p>Code HTTP 201 indiquant que l'accès à un service web est un succès et que
|
|
|
571 |
la ressource a été créée ou modifié. L'utiliser lors d'une requète de type
|
|
|
572 |
PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p>
|
|
|
573 |
|
|
|
574 |
|
|
|
575 |
</div>
|
|
|
576 |
</div></td>
|
|
|
577 |
</tr>
|
|
|
578 |
<tr data-order="HTTP_CODE_SUPPRESSION_OK" id="HTTP_CODE_SUPPRESSION_OK">
|
|
|
579 |
|
|
|
580 |
<td class="attributes"><code>string</code></td>
|
|
|
581 |
<td class="name"><code>
|
|
|
582 |
<a href="source-class-RestServeur.html#65-68" title="Go to source code"><b>HTTP_CODE_SUPPRESSION_OK</b></a>
|
|
|
583 |
</code></td>
|
|
|
584 |
<td class="value"><code><span class="php-quote">'204'</span></code></td>
|
|
|
585 |
<td class="description"><div>
|
|
|
586 |
<a href="#HTTP_CODE_SUPPRESSION_OK" class="anchor">#</a>
|
|
|
587 |
|
|
|
588 |
<div class="description short">
|
|
|
589 |
|
|
|
590 |
<p>Code HTTP 204 indique que l'accès à un service web est un succès et qu'il
|
|
|
591 |
n'y a pas de contenu à renvoyer. L'utiliser lors d'une requète de type DELETE
|
|
|
592 |
(supprimer) pour indiquer le succès de l'opération si aucun contenu (status)
|
|
|
593 |
ne doit être renvoyé, sinon utiliser 200 OK.</p>
|
|
|
594 |
|
|
|
595 |
</div>
|
|
|
596 |
|
|
|
597 |
<div class="description detailed hidden">
|
|
|
598 |
|
|
|
599 |
<p>Code HTTP 204 indique que l'accès à un service web est un succès et qu'il
|
|
|
600 |
n'y a pas de contenu à renvoyer. L'utiliser lors d'une requète de type DELETE
|
|
|
601 |
(supprimer) pour indiquer le succès de l'opération si aucun contenu (status)
|
|
|
602 |
ne doit être renvoyé, sinon utiliser 200 OK.</p>
|
|
|
603 |
|
|
|
604 |
|
|
|
605 |
</div>
|
|
|
606 |
</div></td>
|
|
|
607 |
</tr>
|
|
|
608 |
<tr data-order="HTTP_CODE_MAUVAISE_REQUETE" id="HTTP_CODE_MAUVAISE_REQUETE">
|
|
|
609 |
|
|
|
610 |
<td class="attributes"><code>string</code></td>
|
|
|
611 |
<td class="name"><code>
|
|
|
612 |
<a href="source-class-RestServeur.html#70-73" title="Go to source code"><b>HTTP_CODE_MAUVAISE_REQUETE</b></a>
|
|
|
613 |
</code></td>
|
|
|
614 |
<td class="value"><code><span class="php-quote">'400'</span></code></td>
|
|
|
615 |
<td class="description"><div>
|
|
|
616 |
<a href="#HTTP_CODE_MAUVAISE_REQUETE" class="anchor">#</a>
|
|
|
617 |
|
|
|
618 |
<div class="description short">
|
|
|
619 |
|
|
|
620 |
<p>Code HTTP 400 indique que les paramètres envoyés au service contiennent des
|
|
|
621 |
erreurs. L'utiliser pour indiquer l'échec de l'accès au service. La réponse
|
|
|
622 |
pourra contenir un message expliquant la source de l'erreur.</p>
|
|
|
623 |
|
|
|
624 |
</div>
|
|
|
625 |
|
|
|
626 |
<div class="description detailed hidden">
|
|
|
627 |
|
|
|
628 |
<p>Code HTTP 400 indique que les paramètres envoyés au service contiennent des
|
|
|
629 |
erreurs. L'utiliser pour indiquer l'échec de l'accès au service. La réponse
|
|
|
630 |
pourra contenir un message expliquant la source de l'erreur.</p>
|
|
|
631 |
|
|
|
632 |
|
|
|
633 |
</div>
|
|
|
634 |
</div></td>
|
|
|
635 |
</tr>
|
|
|
636 |
<tr data-order="HTTP_CODE_ACCES_NON_AUTORISE" id="HTTP_CODE_ACCES_NON_AUTORISE">
|
|
|
637 |
|
|
|
638 |
<td class="attributes"><code>string</code></td>
|
|
|
639 |
<td class="name"><code>
|
|
|
640 |
<a href="source-class-RestServeur.html#75-77" title="Go to source code"><b>HTTP_CODE_ACCES_NON_AUTORISE</b></a>
|
|
|
641 |
</code></td>
|
|
|
642 |
<td class="value"><code><span class="php-quote">'401'</span></code></td>
|
|
|
643 |
<td class="description"><div>
|
|
|
644 |
<a href="#HTTP_CODE_ACCES_NON_AUTORISE" class="anchor">#</a>
|
|
|
645 |
|
|
|
646 |
<div class="description short">
|
|
|
647 |
|
|
|
648 |
<p>Code HTTP 401 indiquant que l'accès à un service web est refusé car
|
|
|
649 |
l'authentification (obligatoire) a échoué pour accéder à la ressource.</p>
|
|
|
650 |
|
|
|
651 |
</div>
|
|
|
652 |
|
|
|
653 |
<div class="description detailed hidden">
|
|
|
654 |
|
|
|
655 |
<p>Code HTTP 401 indiquant que l'accès à un service web est refusé car
|
|
|
656 |
l'authentification (obligatoire) a échoué pour accéder à la ressource.</p>
|
|
|
657 |
|
|
|
658 |
|
|
|
659 |
</div>
|
|
|
660 |
</div></td>
|
|
|
661 |
</tr>
|
|
|
662 |
<tr data-order="HTTP_CODE_RESSOURCE_INTROUVABLE" id="HTTP_CODE_RESSOURCE_INTROUVABLE">
|
|
|
663 |
|
|
|
664 |
<td class="attributes"><code>string</code></td>
|
|
|
665 |
<td class="name"><code>
|
|
|
666 |
<a href="source-class-RestServeur.html#79-80" title="Go to source code"><b>HTTP_CODE_RESSOURCE_INTROUVABLE</b></a>
|
|
|
667 |
</code></td>
|
|
|
668 |
<td class="value"><code><span class="php-quote">'404'</span></code></td>
|
|
|
669 |
<td class="description"><div>
|
|
|
670 |
<a href="#HTTP_CODE_RESSOURCE_INTROUVABLE" class="anchor">#</a>
|
|
|
671 |
|
|
|
672 |
<div class="description short">
|
|
|
673 |
|
|
|
674 |
<p>Code HTTP 404 indiquant que la ressource indiquée par l'url est
|
|
|
675 |
introuvable.</p>
|
|
|
676 |
|
|
|
677 |
</div>
|
|
|
678 |
|
|
|
679 |
<div class="description detailed hidden">
|
|
|
680 |
|
|
|
681 |
<p>Code HTTP 404 indiquant que la ressource indiquée par l'url est
|
|
|
682 |
introuvable.</p>
|
|
|
683 |
|
|
|
684 |
|
|
|
685 |
</div>
|
|
|
686 |
</div></td>
|
|
|
687 |
</tr>
|
|
|
688 |
<tr data-order="HTTP_CODE_METHODE_NON_AUTORISE" id="HTTP_CODE_METHODE_NON_AUTORISE">
|
|
|
689 |
|
|
|
690 |
<td class="attributes"><code>string</code></td>
|
|
|
691 |
<td class="name"><code>
|
|
|
692 |
<a href="source-class-RestServeur.html#82-85" title="Go to source code"><b>HTTP_CODE_METHODE_NON_AUTORISE</b></a>
|
|
|
693 |
</code></td>
|
|
|
694 |
<td class="value"><code><span class="php-quote">'405'</span></code></td>
|
|
|
695 |
<td class="description"><div>
|
|
|
696 |
<a href="#HTTP_CODE_METHODE_NON_AUTORISE" class="anchor">#</a>
|
|
|
697 |
|
|
|
698 |
<div class="description short">
|
|
|
699 |
|
|
|
700 |
<p>Code HTTP 405 indiquant soit :<br />
|
|
|
701 |
- que le service web ne possède pas d'accès la ressource correspondant à la
|
|
|
702 |
méthode HTTP employée.<br />
|
|
|
703 |
- que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée
|
|
|
704 |
par l'url.</p>
|
|
|
705 |
|
|
|
706 |
</div>
|
|
|
707 |
|
|
|
708 |
<div class="description detailed hidden">
|
|
|
709 |
|
|
|
710 |
<p>Code HTTP 405 indiquant soit : - que le service web ne possède pas d'accès
|
|
|
711 |
la ressource correspondant à la méthode HTTP employée. - que la méthode HTTP
|
|
|
712 |
enployée n'est pas en accord avec la ressource indiquée par l'url.</p>
|
|
|
713 |
|
|
|
714 |
|
|
|
715 |
</div>
|
|
|
716 |
</div></td>
|
|
|
717 |
</tr>
|
|
|
718 |
<tr data-order="HTTP_CODE_CONFLIT" id="HTTP_CODE_CONFLIT">
|
|
|
719 |
|
|
|
720 |
<td class="attributes"><code>string</code></td>
|
|
|
721 |
<td class="name"><code>
|
|
|
722 |
<a href="source-class-RestServeur.html#87-90" title="Go to source code"><b>HTTP_CODE_CONFLIT</b></a>
|
|
|
723 |
</code></td>
|
|
|
724 |
<td class="value"><code><span class="php-quote">'409'</span></code></td>
|
|
|
725 |
<td class="description"><div>
|
|
|
726 |
<a href="#HTTP_CODE_CONFLIT" class="anchor">#</a>
|
|
|
727 |
|
|
|
728 |
<div class="description short">
|
|
|
729 |
|
|
|
730 |
<p>Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la
|
|
|
731 |
ressource. Par exemple, essayer de créer deux fois la même ressource ou bien
|
|
|
732 |
tenter de modifier une ressource qui a été modifiée par ailleurs.</p>
|
|
|
733 |
|
|
|
734 |
</div>
|
|
|
735 |
|
|
|
736 |
<div class="description detailed hidden">
|
|
|
737 |
|
|
|
738 |
<p>Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la
|
|
|
739 |
ressource. Par exemple, essayer de créer deux fois la même ressource ou bien
|
|
|
740 |
tenter de modifier une ressource qui a été modifiée par ailleurs.</p>
|
|
|
741 |
|
|
|
742 |
|
|
|
743 |
</div>
|
|
|
744 |
</div></td>
|
|
|
745 |
</tr>
|
|
|
746 |
<tr data-order="HTTP_CODE_CONTENU_REQUIS" id="HTTP_CODE_CONTENU_REQUIS">
|
|
|
747 |
|
|
|
748 |
<td class="attributes"><code>string</code></td>
|
|
|
749 |
<td class="name"><code>
|
|
|
750 |
<a href="source-class-RestServeur.html#92-93" title="Go to source code"><b>HTTP_CODE_CONTENU_REQUIS</b></a>
|
|
|
751 |
</code></td>
|
|
|
752 |
<td class="value"><code><span class="php-quote">'411'</span></code></td>
|
|
|
753 |
<td class="description"><div>
|
|
|
754 |
<a href="#HTTP_CODE_CONTENU_REQUIS" class="anchor">#</a>
|
|
|
755 |
|
|
|
756 |
<div class="description short">
|
|
|
757 |
|
|
|
758 |
<p>Code HTTP 411 indiquant que des paramètres passés dans le contenu de la
|
|
|
759 |
requête sont nécessaires au service.</p>
|
|
|
760 |
|
|
|
761 |
</div>
|
|
|
762 |
|
|
|
763 |
<div class="description detailed hidden">
|
|
|
764 |
|
|
|
765 |
<p>Code HTTP 411 indiquant que des paramètres passés dans le contenu de la
|
|
|
766 |
requête sont nécessaires au service.</p>
|
|
|
767 |
|
|
|
768 |
|
|
|
769 |
</div>
|
|
|
770 |
</div></td>
|
|
|
771 |
</tr>
|
|
|
772 |
<tr data-order="HTTP_CODE_ERREUR" id="HTTP_CODE_ERREUR">
|
|
|
773 |
|
|
|
774 |
<td class="attributes"><code>string</code></td>
|
|
|
775 |
<td class="name"><code>
|
|
|
776 |
<a href="source-class-RestServeur.html#95-97" title="Go to source code"><b>HTTP_CODE_ERREUR</b></a>
|
|
|
777 |
</code></td>
|
|
|
778 |
<td class="value"><code><span class="php-quote">'500'</span></code></td>
|
|
|
779 |
<td class="description"><div>
|
|
|
780 |
<a href="#HTTP_CODE_ERREUR" class="anchor">#</a>
|
|
|
781 |
|
|
|
782 |
<div class="description short">
|
|
|
783 |
|
|
|
784 |
<p>Code d'erreur HTTP 500 Internal Server Error. L'utiliser quand le serveur ou
|
|
|
785 |
un service soulève une erreur ou une exception.</p>
|
|
|
786 |
|
|
|
787 |
</div>
|
|
|
788 |
|
|
|
789 |
<div class="description detailed hidden">
|
|
|
790 |
|
|
|
791 |
<p>Code d'erreur HTTP 500 Internal Server Error. L'utiliser quand le serveur ou
|
|
|
792 |
un service soulève une erreur ou une exception.</p>
|
|
|
793 |
|
|
|
794 |
|
|
|
795 |
</div>
|
|
|
796 |
</div></td>
|
|
|
797 |
</tr>
|
|
|
798 |
<tr data-order="MOTIF_API_VERSION" id="MOTIF_API_VERSION">
|
|
|
799 |
|
|
|
800 |
<td class="attributes"><code>string</code></td>
|
|
|
801 |
<td class="name"><code>
|
|
|
802 |
<a href="source-class-RestServeur.html#99-100" title="Go to source code"><b>MOTIF_API_VERSION</b></a>
|
|
|
803 |
</code></td>
|
|
|
804 |
<td class="value"><code><span class="php-quote">'/^[0-9]+(?:[.][0-9]+)*$/'</span></code></td>
|
|
|
805 |
<td class="description"><div>
|
|
|
806 |
<a href="#MOTIF_API_VERSION" class="anchor">#</a>
|
|
|
807 |
|
|
|
808 |
<div class="description short">
|
|
|
809 |
|
|
|
810 |
<p>Motif de l'epression régulière vérfiant la version de l'API.</p>
|
|
|
811 |
|
|
|
812 |
</div>
|
|
|
813 |
|
|
|
814 |
<div class="description detailed hidden">
|
|
|
815 |
|
|
|
816 |
<p>Motif de l'epression régulière vérfiant la version de l'API.</p>
|
|
|
817 |
|
|
|
818 |
|
|
|
819 |
</div>
|
|
|
820 |
</div></td>
|
|
|
821 |
</tr>
|
|
|
822 |
<tr data-order="MOTIF_SERVICE_NOM" id="MOTIF_SERVICE_NOM">
|
|
|
823 |
|
|
|
824 |
<td class="attributes"><code>string</code></td>
|
|
|
825 |
<td class="name"><code>
|
|
|
826 |
<a href="source-class-RestServeur.html#102-103" title="Go to source code"><b>MOTIF_SERVICE_NOM</b></a>
|
|
|
827 |
</code></td>
|
|
|
828 |
<td class="value"><code><span class="php-quote">'/^[a-z0-9]+(?:[-][a-z0-9]+)*$/'</span></code></td>
|
|
|
829 |
<td class="description"><div>
|
|
|
830 |
<a href="#MOTIF_SERVICE_NOM" class="anchor">#</a>
|
|
|
831 |
|
|
|
832 |
<div class="description short">
|
|
|
833 |
|
|
|
834 |
<p>Motif de l'epression régulière vérfiant le nom du service.</p>
|
|
|
835 |
|
|
|
836 |
</div>
|
|
|
837 |
|
|
|
838 |
<div class="description detailed hidden">
|
|
|
839 |
|
|
|
840 |
<p>Motif de l'epression régulière vérfiant le nom du service.</p>
|
|
|
841 |
|
|
|
842 |
|
|
|
843 |
</div>
|
|
|
844 |
</div></td>
|
|
|
845 |
</tr>
|
|
|
846 |
</table>
|
|
|
847 |
|
|
|
848 |
|
|
|
849 |
|
|
|
850 |
|
|
|
851 |
|
|
|
852 |
|
|
|
853 |
|
|
|
854 |
|
|
|
855 |
|
|
|
856 |
|
|
|
857 |
</div>
|
|
|
858 |
|
|
|
859 |
<div id="footer">
|
|
|
860 |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
|
861 |
</div>
|
|
|
862 |
</div>
|
|
|
863 |
</div>
|
|
|
864 |
</body>
|
|
|
865 |
</html>
|