Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<html><head><title>Docs For Class RestService</title><meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/><link rel="stylesheet" type="text/css" href="../media/style.css"></head><body><table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"><tr><td class="header_top">Framework</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr><tr><td class="header_menu">[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ][ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ][ <a href="../elementindex.html" class="menu">all elements</a> ]</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr></table><table width="100%" border="0" cellpadding="0" cellspacing="0"><tr valign="top"><td width="200" class="menu"><div id="todolist"><p><a href="../todolist.html">Todo List</a></p></div><b>Packages:</b><br /><a href="../li_Framework.html">Framework</a><br /><a href="../li_Utilitaire.html">Utilitaire</a><br /><a href="../li_Zend_OpenId.html">Zend_OpenId</a><br /><br /><br /><b>Files:</b><br /><div class="package"><a href="../Framework/_Bdd.php.html"> Bdd.php</a><br><a href="../Framework/_Cache.php.html"> Cache.php</a><br><a href="../Framework/_CacheFichier.php.html"> CacheFichier.php</a><br><a href="../Framework/_CacheSimple.php.html"> CacheSimple.php</a><br><a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php</a><br><a href="../Framework/_Chronometre.php.html"> Chronometre.php</a><br><a href="../Framework/_Cli.php.html"> Cli.php</a><br><a href="../Framework/_Config.php.html"> Config.php</a><br><a href="../Framework/_Controleur.php.html"> Controleur.php</a><br><a href="../Framework/_Debug.php.html"> Debug.php</a><br><a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php</a><br><a href="../Framework/_Framework.php.html"> Framework.php</a><br><a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php</a><br><a href="../Framework/_I18n.php.html"> I18n.php</a><br><a href="../Framework/_Log.php.html"> Log.php</a><br><a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php</a><br><a href="../Framework/_Registre.php.html"> Registre.php</a><br><a href="../Framework/_RestClient.php.html"> RestClient.php</a><br><a href="../Framework/_RestServeur.php.html"> RestServeur.php</a><br><a href="../Framework/_RestService.php.html"> RestService.php</a><br><a href="../Framework/_Script.php.html"> Script.php</a><br><a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php</a><br><a href="../Framework/_Url.php.html"> Url.php</a><br></div><br /><b>Classes:</b><br /><div class="package"><a href="../Framework/Bdd.html">Bdd</a><br /><a href="../Framework/Cache.html">Cache</a><br /><a href="../Framework/CacheFichier.html">CacheFichier</a><br /><a href="../Framework/CacheSimple.html">CacheSimple</a><br /><a href="../Framework/CacheSqlite.html">CacheSqlite</a><br /><a href="../Framework/Chronometre.html">Chronometre</a><br /><a href="../Framework/Cli.html">Cli</a><br /><a href="../Framework/Config.html">Config</a><br /><a href="../Framework/Controleur.html">Controleur</a><br /><a href="../Framework/Debug.html">Debug</a><br /><a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br /><a href="../Framework/Framework.html">Framework</a><br /><a href="../Framework/GestionnaireException.html">GestionnaireException</a><br /><a href="../Framework/I18n.html">I18n</a><br /><a href="../Framework/Log.html">Log</a><br /><a href="../Framework/OpenIdClient.html">OpenIdClient</a><br /><a href="../Framework/Registre.html">Registre</a><br /><a href="../Framework/RestClient.html">RestClient</a><br /><a href="../Framework/RestServeur.html">RestServeur</a><br /><a href="../Framework/RestService.html">RestService</a><br /><a href="../Framework/Script.html">Script</a><br /><a href="../Framework/SquelettePhp.html">SquelettePhp</a><br /><a href="../Framework/Url.html">Url</a><br /></div></td><td><table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"><h1>Class: RestService</h1>Source Location: /RestService.php<br /><br /><table width="100%" border="0"><tr><td valign="top"><h3><a href="#class_details">Class Overview</a></h3><pre></pre><br /><div class="description">Classe principale gérant les services.</div><br /><br /><h4>Author(s):</h4><ul><li>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li></ul><h4>Version:</h4><ul><li>$Id: RestService.php 299 2011-01-18 14:03:46Z jpm $</li></ul><h4>Copyright:</h4><ul><li>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li></ul></td><td valign="top"><h3><a href="#class_vars">Variables</a></h3><ul><li><a href="../Framework/RestService.html#var$bdd">$bdd</a></li></ul></td><td valign="top"><h3><a href="#class_methods">Methods</a></h3><ul><li><a href="../Framework/RestService.html#method__construct">__construct</a></li><li><a href="../Framework/RestService.html#methodajouter">ajouter</a></li><li><a href="../Framework/RestService.html#methodconsulter">consulter</a></li><li><a href="../Framework/RestService.html#methodmodifier">modifier</a></li><li><a href="../Framework/RestService.html#methodsupprimer">supprimer</a></li></ul></td></tr></table><hr /><table width="100%" border="0"><tr></tr></table><hr /><a name="class_details"></a><h3>Class Details</h3><div class="tags">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a20">20</a>]<br />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 /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>author:</b> </td><td>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></td></tr><tr><td><b>version:</b> </td><td>$Id: RestService.php 299 2011-01-18 14:03:46Z jpm $</td></tr><tr><td><b>copyright:</b> </td><td>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</td></tr><tr><td><b>link:</b> </td><td>/doc/framework/</td></tr><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>since:</b> </td><td>0.3</td></tr><tr><td><b>license:</b> </td><td>GPL</td></tr><tr><td><b>license:</b> </td><td>CECILL</td></tr></table></div></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><hr /><a name="class_vars"></a><h3>Class Variables</h3><div class="tags"><a name="var$bdd"></a><p></p><h4>$bdd = <span class="value"></span></h4><p>[line <a href="../__filesource/fsource_Framework__RestService.php.html#a23">23</a>]</p>Objet de connection à la base de données.<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>Type:</b> </td><td>mixed</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></div><br /><hr /><a name="class_methods"></a><h3>Class Methods</h3><div class="tags"><hr /><a name="method__construct"></a><h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a25">25</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>RestService __construct($config)</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$config</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodajouter"></a><h3>method ajouter <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a73">73</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>string ajouter(array$ressources, array$requeteDonnees)</code></td></tr></table></td></tr></table><br />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 /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>l'identifiant créé.</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$ressources</b> </td><td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td></tr><tr><td class="type">array </td><td><b>$requeteDonnees</b> </td><td>les données transférées dans le corps de la requête devant servir à l'ajout.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodconsulter"></a><h3>method consulter <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a41">41</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>string consulter(array$ressources, array$parametres)</code></td></tr></table></td></tr></table><br />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 /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>une chaine indiquant le succès de l'opération et les données demandées.</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$ressources</b> </td><td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td></tr><tr><td class="type">array </td><td><b>$parametres</b> </td><td>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodmodifier"></a><h3>method modifier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a57">57</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>mixed modifier(array$ressources, array$requeteDonnees)</code></td></tr></table></td></tr></table><br />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 /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>une chaine indiquant le succès de l'opération ou rien.</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$ressources</b> </td><td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td></tr><tr><td class="type">array </td><td><b>$requeteDonnees</b> </td><td>les données transférées dans le corps de la requête devant servir à la modification.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodsupprimer"></a><h3>method supprimer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestService.php.html#a86">86</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>mixed supprimer(array$ressources)</code></td></tr></table></td></tr></table><br />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 /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>une chaine indiquant le succès de l'opération ou rien.</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$ressources</b> </td><td>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div></div><br /><div class="credit"><hr />Documentation generated on Tue, 18 Jan 2011 15:31:27 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a></div></td></tr></table></td></tr></table></body></html>