Subversion Repositories Applications.framework

Rev

Rev 300 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
297 jpm 1 
<html>
2 
<head>
3 
<title>Docs For Class RestService</title>
4 
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
5 
<link rel="stylesheet" type="text/css" href="../media/style.css">
6 
</head>
7 
<body>
8 
 
9 
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
10 
  <tr>
11 
    <td class="header_top">Framework</td>
12 
  </tr>
13 
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
14 
  <tr>
15 
    <td class="header_menu">
16 
 
17 
 
18 
                                                                      		  [ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
19 
		  [ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
20 
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
21 
    </td>
22 
  </tr>
23 
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
24 
</table>
25 
 
26 
<table width="100%" border="0" cellpadding="0" cellspacing="0">
27 
  <tr valign="top">
28 
    <td width="200" class="menu">
29 
	<div id="todolist">
30 
			<p><a href="../todolist.html">Todo List</a></p>
31 
	</div>
32 
      <b>Packages:</b><br />
33 
              <a href="../li_Framework.html">Framework</a><br />
34 
              <a href="../li_Utilitaire.html">Utilitaire</a><br />
35 
              <a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
36 
            <br /><br />
37 
                        <b>Files:</b><br />
38 
      	  <div class="package">
39 
			<a href="../Framework/_Bdd.php.html">		Bdd.php
40 
		</a><br>
41 
			<a href="../Framework/_Cache.php.html">		Cache.php
42 
		</a><br>
43 
			<a href="../Framework/_CacheFichier.php.html">		CacheFichier.php
44 
		</a><br>
45 
			<a href="../Framework/_CacheSimple.php.html">		CacheSimple.php
46 
		</a><br>
47 
			<a href="../Framework/_CacheSqlite.php.html">		CacheSqlite.php
48 
		</a><br>
49 
			<a href="../Framework/_Chronometre.php.html">		Chronometre.php
50 
		</a><br>
51 
			<a href="../Framework/_Cli.php.html">		Cli.php
52 
		</a><br>
53 
			<a href="../Framework/_Config.php.html">		Config.php
54 
		</a><br>
55 
			<a href="../Framework/_Controleur.php.html">		Controleur.php
56 
		</a><br>
57 
			<a href="../Framework/_Debug.php.html">		Debug.php
58 
		</a><br>
59 
			<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html">		DiffieHellmanUtil.php
60 
		</a><br>
61 
			<a href="../Framework/_Framework.php.html">		Framework.php
62 
		</a><br>
63 
			<a href="../Framework/_GestionnaireException.php.html">		GestionnaireException.php
64 
		</a><br>
65 
			<a href="../Framework/_I18n.php.html">		I18n.php
66 
		</a><br>
67 
			<a href="../Framework/_Log.php.html">		Log.php
68 
		</a><br>
69 
			<a href="../Framework/_OpenIdClient.php.html">		OpenIdClient.php
70 
		</a><br>
71 
			<a href="../Framework/_Registre.php.html">		Registre.php
72 
		</a><br>
73 
			<a href="../Framework/_RestClient.php.html">		RestClient.php
74 
		</a><br>
75 
			<a href="../Framework/_RestServeur.php.html">		RestServeur.php
76 
		</a><br>
77 
			<a href="../Framework/_RestService.php.html">		RestService.php
78 
		</a><br>
79 
			<a href="../Framework/_Script.php.html">		Script.php
80 
		</a><br>
81 
			<a href="../Framework/_SquelettePhp.php.html">		SquelettePhp.php
82 
		</a><br>
83 
			<a href="../Framework/_Url.php.html">		Url.php
84 
		</a><br>
85 
	  </div><br />
86 
 
87 
 
88 
            <b>Classes:</b><br />
89 
        <div class="package">
90 
		    		<a href="../Framework/Bdd.html">Bdd</a><br />
91 
	    		<a href="../Framework/Cache.html">Cache</a><br />
92 
	    		<a href="../Framework/CacheFichier.html">CacheFichier</a><br />
93 
	    		<a href="../Framework/CacheSimple.html">CacheSimple</a><br />
94 
	    		<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
95 
	    		<a href="../Framework/Chronometre.html">Chronometre</a><br />
96 
	    		<a href="../Framework/Cli.html">Cli</a><br />
97 
	    		<a href="../Framework/Config.html">Config</a><br />
98 
	    		<a href="../Framework/Controleur.html">Controleur</a><br />
99 
	    		<a href="../Framework/Debug.html">Debug</a><br />
100 
	    		<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
101 
	    		<a href="../Framework/Framework.html">Framework</a><br />
102 
	    		<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
103 
	    		<a href="../Framework/I18n.html">I18n</a><br />
104 
	    		<a href="../Framework/Log.html">Log</a><br />
105 
	    		<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
106 
	    		<a href="../Framework/Registre.html">Registre</a><br />
107 
	    		<a href="../Framework/RestClient.html">RestClient</a><br />
108 
	    		<a href="../Framework/RestServeur.html">RestServeur</a><br />
109 
	    		<a href="../Framework/RestService.html">RestService</a><br />
110 
	    		<a href="../Framework/Script.html">Script</a><br />
111 
	    		<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
112 
	    		<a href="../Framework/Url.html">Url</a><br />
113 
	  </div>
114 
                </td>
115 
    <td>
116 
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
117 
 
118 
<h1>Class: RestService</h1>
119 
Source Location: /RestService.php<br /><br />
120 
 
121 
 
122 
<table width="100%" border="0">
123 
<tr><td valign="top">
124 
 
125 
<h3><a href="#class_details">Class Overview</a></h3>
126 
<pre></pre><br />
127 
<div class="description">Classe principale gérant les services.</div><br /><br />
128 
<h4>Author(s):</h4>
129 
<ul>
130 
          <li>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
131 
                                                </ul>
132 
 
133 
 
134 
 
135 
 
136 
 
137 
 
138 
 
139 
<h4>Version:</h4>
140 
<ul>
300 jpm 141 
  <li>$Id: RestService.php 299 2011-01-18 14:03:46Z jpm $</li>
297 jpm 142 
</ul>
143 
 
144 
<h4>Copyright:</h4>
145 
<ul>
146 
  <li>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
147 
</ul>
148 
 
149 
</td>
150 
 
151 
<td valign="top">
152 
<h3><a href="#class_vars">Variables</a></h3>
153 
<ul>
154 
    <li><a href="../Framework/RestService.html#var$bdd">$bdd</a></li>
155 
  </ul>
156 
</td>
157 
 
158 
 
159 
<td valign="top">
160 
<h3><a href="#class_methods">Methods</a></h3>
161 
<ul>
162 
    <li><a href="../Framework/RestService.html#method__construct">__construct</a></li>
163 
    <li><a href="../Framework/RestService.html#methodajouter">ajouter</a></li>
164 
    <li><a href="../Framework/RestService.html#methodconsulter">consulter</a></li>
165 
    <li><a href="../Framework/RestService.html#methodmodifier">modifier</a></li>
166 
    <li><a href="../Framework/RestService.html#methodsupprimer">supprimer</a></li>
167 
  </ul>
168 
</td>
169 
 
170 
</tr></table>
171 
<hr />
172 
 
173 
<table width="100%" border="0"><tr>
174 
 
175 
 
176 
 
177 
 
178 
 
179 
 
180 
</tr></table>
181 
<hr />
182 
 
183 
<a name="class_details"></a>
184 
<h3>Class Details</h3>
185 
<div class="tags">
186 
[line <a href="../__filesource/fsource_Framework__RestService.php.html#a20">20</a>]<br />
187 
Classe principale gérant les services.<br /><br /><p>Paramètres liés dans config.ini : <ul><li>serveur.baseURL</li></ul>  Encodage en entrée : utf8  Encodage en sortie : utf8</p><br /><br /><br />
188 
<h4>Tags:</h4>
189 
<div class="tags">
190 
<table border="0" cellspacing="0" cellpadding="0">
191 
  <tr>
192 
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</td>
193 
  </tr>
194 
  <tr>
300 jpm 195 
    <td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: RestService.php 299 2011-01-18 14:03:46Z jpm $</td>
297 jpm 196 
  </tr>
197 
  <tr>
198 
    <td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</td>
199 
  </tr>
200 
  <tr>
201 
    <td><b>link:</b>&nbsp;&nbsp;</td><td>/doc/framework/</td>
202 
  </tr>
203 
  <tr>
204 
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
205 
  </tr>
206 
  <tr>
207 
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.3</td>
208 
  </tr>
209 
  <tr>
210 
    <td><b>license:</b>&nbsp;&nbsp;</td><td>GPL</td>
211 
  </tr>
212 
  <tr>
213 
    <td><b>license:</b>&nbsp;&nbsp;</td><td>CECILL</td>
214 
  </tr>
215 
</table>
216 
</div>
217 
</div><br /><br />
218 
<div class="top">[ <a href="#top">Top</a> ]</div><br />
219 
 
220 
<hr />
221 
<a name="class_vars"></a>
222 
<h3>Class Variables</h3>
223 
<div class="tags">
224 
	<a name="var$bdd"></a>
225 
	<p></p>
226 
	<h4>$bdd = <span class="value"></span></h4>
227 
	<p>[line <a href="../__filesource/fsource_Framework__RestService.php.html#a23">23</a>]</p>
228 
  Objet de connection à la base de données.<br /><br /><br /><br />
229 
<h4>Tags:</h4>
230 
<div class="tags">
231 
<table border="0" cellspacing="0" cellpadding="0">
232 
  <tr>
233 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
234 
  </tr>
235 
</table>
236 
</div>
237 
 
238 
  <br />
239 
	<div class="tags">
240 
  <table border="0" cellspacing="0" cellpadding="0">
241 
    <tr>
242 
      <td><b>Type:</b>&nbsp;&nbsp;</td>
243 
      <td>mixed</td>
244 
    </tr>
245 
      </table>
246 
	</div><br /><br />
247 
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
248 
</div><br />
249 
 
250 
<hr />
251 
<a name="class_methods"></a>
252 
<h3>Class Methods</h3>
253 
<div class="tags">
254 
 
255 
  <hr />
256 
	<a name="method__construct"></a>
257 
	<h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a25">25</a>]</span></h3>
258 
	<div class="function">
259 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
260 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
261 
		<code>RestService __construct(
262 
 
263 
$config)</code>
264 
    </td></tr></table>
265 
    </td></tr></table><br />
266 
 
267 
		<br /><br />
268 
<h4>Tags:</h4>
269 
<div class="tags">
270 
<table border="0" cellspacing="0" cellpadding="0">
271 
  <tr>
272 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
273 
  </tr>
274 
</table>
275 
</div>
276 
<br /><br />
277 
 
278 
 
279 
        <h4>Parameters:</h4>
280 
    <div class="tags">
281 
    <table border="0" cellspacing="0" cellpadding="0">
282 
          <tr>
283 
        <td class="type">&nbsp;&nbsp;</td>
284 
        <td><b>$config</b>&nbsp;&nbsp;</td>
285 
        <td></td>
286 
      </tr>
287 
        </table>
288 
    </div><br />
289 
        <div class="top">[ <a href="#top">Top</a> ]</div>
290 
  </div>
291 
  <hr />
292 
	<a name="methodajouter"></a>
293 
	<h3>method ajouter <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a73">73</a>]</span></h3>
294 
	<div class="function">
295 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
296 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
297 
		<code>string ajouter(
298 
array
299 
$ressources, array
300 
$requeteDonnees)</code>
301 
    </td></tr></table>
302 
    </td></tr></table><br />
303 
 
304 
		Méthode appelée lors d'une requête HTTP de type PUT.<br /><br /><p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par  le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.  Si l'ajout est un succès, le code statut HTTP retourné devrait être 201.</p><br /><br /><br />
305 
<h4>Tags:</h4>
306 
<div class="tags">
307 
<table border="0" cellspacing="0" cellpadding="0">
308 
  <tr>
309 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>l'identifiant créé.</td>
310 
  </tr>
311 
  <tr>
312 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
313 
  </tr>
314 
</table>
315 
</div>
316 
<br /><br />
317 
 
318 
 
319 
        <h4>Parameters:</h4>
320 
    <div class="tags">
321 
    <table border="0" cellspacing="0" cellpadding="0">
322 
          <tr>
323 
        <td class="type">array&nbsp;&nbsp;</td>
324 
        <td><b>$ressources</b>&nbsp;&nbsp;</td>
325 
        <td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td>
326 
      </tr>
327 
          <tr>
328 
        <td class="type">array&nbsp;&nbsp;</td>
329 
        <td><b>$requeteDonnees</b>&nbsp;&nbsp;</td>
330 
        <td>les données transférées dans le corps de la requête devant servir à l'ajout.</td>
331 
      </tr>
332 
        </table>
333 
    </div><br />
334 
        <div class="top">[ <a href="#top">Top</a> ]</div>
335 
  </div>
336 
  <hr />
337 
	<a name="methodconsulter"></a>
338 
	<h3>method consulter <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a41">41</a>]</span></h3>
339 
	<div class="function">
340 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
341 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
342 
		<code>string consulter(
343 
array
344 
$ressources, array
345 
$parametres)</code>
346 
    </td></tr></table>
347 
    </td></tr></table><br />
348 
 
349 
		Méthode appelée lors d'une requête HTTP de type GET.<br /><br /><p>Si la consultation est un succès, le code statut HTTP retourné devrait être 200.</p><br /><br /><br />
350 
<h4>Tags:</h4>
351 
<div class="tags">
352 
<table border="0" cellspacing="0" cellpadding="0">
353 
  <tr>
354 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>une chaine indiquant le succès de l'opération et les données demandées.</td>
355 
  </tr>
356 
  <tr>
357 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
358 
  </tr>
359 
</table>
360 
</div>
361 
<br /><br />
362 
 
363 
 
364 
        <h4>Parameters:</h4>
365 
    <div class="tags">
366 
    <table border="0" cellspacing="0" cellpadding="0">
367 
          <tr>
368 
        <td class="type">array&nbsp;&nbsp;</td>
369 
        <td><b>$ressources</b>&nbsp;&nbsp;</td>
370 
        <td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td>
371 
      </tr>
372 
          <tr>
373 
        <td class="type">array&nbsp;&nbsp;</td>
374 
        <td><b>$parametres</b>&nbsp;&nbsp;</td>
375 
        <td>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</td>
376 
      </tr>
377 
        </table>
378 
    </div><br />
379 
        <div class="top">[ <a href="#top">Top</a> ]</div>
380 
  </div>
381 
  <hr />
382 
	<a name="methodmodifier"></a>
383 
	<h3>method modifier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a57">57</a>]</span></h3>
384 
	<div class="function">
385 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
386 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
387 
		<code>mixed modifier(
388 
array
389 
$ressources, array
390 
$requeteDonnees)</code>
391 
    </td></tr></table>
392 
    </td></tr></table><br />
393 
 
394 
		Méthode appelée lors d'une requête HTTP de type POST.<br /><br /><p>La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps  de la requête.  Si la modification est un succès, le code statut HTTP retourné devrait être 201.</p><br /><br /><br />
395 
<h4>Tags:</h4>
396 
<div class="tags">
397 
<table border="0" cellspacing="0" cellpadding="0">
398 
  <tr>
399 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>une chaine indiquant le succès de l'opération ou rien.</td>
400 
  </tr>
401 
  <tr>
402 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
403 
  </tr>
404 
</table>
405 
</div>
406 
<br /><br />
407 
 
408 
 
409 
        <h4>Parameters:</h4>
410 
    <div class="tags">
411 
    <table border="0" cellspacing="0" cellpadding="0">
412 
          <tr>
413 
        <td class="type">array&nbsp;&nbsp;</td>
414 
        <td><b>$ressources</b>&nbsp;&nbsp;</td>
415 
        <td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td>
416 
      </tr>
417 
          <tr>
418 
        <td class="type">array&nbsp;&nbsp;</td>
419 
        <td><b>$requeteDonnees</b>&nbsp;&nbsp;</td>
420 
        <td>les données transférées dans le corps de la requête devant servir à la modification.</td>
421 
      </tr>
422 
        </table>
423 
    </div><br />
424 
        <div class="top">[ <a href="#top">Top</a> ]</div>
425 
  </div>
426 
  <hr />
427 
	<a name="methodsupprimer"></a>
428 
	<h3>method supprimer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a86">86</a>]</span></h3>
429 
	<div class="function">
430 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
431 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
432 
		<code>mixed supprimer(
433 
array
434 
$ressources)</code>
435 
    </td></tr></table>
436 
    </td></tr></table><br />
437 
 
438 
		Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).<br /><br /><p>Si la suppression est un succès, le code statut HTTP retourné devrait être 204.</p><br /><br /><br />
439 
<h4>Tags:</h4>
440 
<div class="tags">
441 
<table border="0" cellspacing="0" cellpadding="0">
442 
  <tr>
443 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>une chaine indiquant le succès de l'opération ou rien.</td>
444 
  </tr>
445 
  <tr>
446 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
447 
  </tr>
448 
</table>
449 
</div>
450 
<br /><br />
451 
 
452 
 
453 
        <h4>Parameters:</h4>
454 
    <div class="tags">
455 
    <table border="0" cellspacing="0" cellpadding="0">
456 
          <tr>
457 
        <td class="type">array&nbsp;&nbsp;</td>
458 
        <td><b>$ressources</b>&nbsp;&nbsp;</td>
459 
        <td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td>
460 
      </tr>
461 
        </table>
462 
    </div><br />
463 
        <div class="top">[ <a href="#top">Top</a> ]</div>
464 
  </div>
465 
</div><br />
466 
 
467 
 
468 
        <div class="credit">
469 
		    <hr />
302 jpm 470 
		    Documentation generated on Tue, 18 Jan 2011 15:31:27 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
297 jpm 471 
	      </div>
472 
      </td></tr></table>
473 
    </td>
474 
  </tr>
475 
</table>
476 
 
477 
</body>
478 
</html>