Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<html><head><title>Docs For Class RestServeur</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: RestServeur</h1>Source Location: /RestServeur.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 web de type (@link(REST, http://fr.wikipedia.org/wiki/Rest).</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: RestServeur.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_consts">Constants</a></h3><ul><li><a href="../Framework/RestServeur.html#constHTTP_CODE_ACCES_NON_AUTORISE">HTTP_CODE_ACCES_NON_AUTORISE</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_CONFLIT">HTTP_CODE_CONFLIT</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_CONTENU_REQUIS">HTTP_CODE_CONTENU_REQUIS</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_CREATION_OK">HTTP_CODE_CREATION_OK</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_ERREUR">HTTP_CODE_ERREUR</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_MAUVAISE_REQUETE">HTTP_CODE_MAUVAISE_REQUETE</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_METHODE_NON_AUTORISE">HTTP_CODE_METHODE_NON_AUTORISE</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_OK">HTTP_CODE_OK</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_RESSOURCE_INTROUVABLE">HTTP_CODE_RESSOURCE_INTROUVABLE</a></li><li><a href="../Framework/RestServeur.html#constHTTP_CODE_SUPPRESSION_OK">HTTP_CODE_SUPPRESSION_OK</a></li><li><a href="../Framework/RestServeur.html#constMETHODE_DELETE">METHODE_DELETE</a></li><li><a href="../Framework/RestServeur.html#constMETHODE_GET">METHODE_GET</a></li><li><a href="../Framework/RestServeur.html#constMETHODE_POST">METHODE_POST</a></li><li><a href="../Framework/RestServeur.html#constMETHODE_PUT">METHODE_PUT</a></li></ul></td><td valign="top"><h3><a href="#class_methods">Methods</a></h3><ul><li><a href="../Framework/RestServeur.html#methodchargerClasse">chargerClasse</a></li><li><a href="../Framework/RestServeur.html#methodenvoyerEnteteStatutHttp">envoyerEnteteStatutHttp</a></li><li><a href="../Framework/RestServeur.html#methodexecuter">executer</a></li><li><a href="../Framework/RestServeur.html#methodgererErreurs">gererErreurs</a></li><li><a href="../Framework/RestServeur.html#method__construct">__construct</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__RestServeur.php.html#a41">41</a>]<br />Classe principale gérant les services web de type (@link(REST, http://fr.wikipedia.org/wiki/Rest).<br /><br /><p>Elle contient : <ul><li>les constantes indiquant les différentes (@link(méthode HTTP, http://fr.wikipedia.org/wiki/Http) prises en compte.</li><li>les @link(codes HTTP des réponses, http://fr.wikipedia.org/wiki/Liste_des_codes_HTTP)</li></ul> Ce serveur REST accepte 4 types de méthodes HTTP : GET, PUT, POST, DELETE. GET et POST ne pose généralement pas de problème pour les clients HTTP mais ce n'est pas forcément le cas pour PUT et DELETE. Vous pouvez donc pour réaliser : <ul><li>DELETE : utiliser la méthode POST avec action=DELETE dans le corps de la requête.</li><li>PUT : utiliser la méthode POST avec une url ne contenant aucune indication de ressource.</li></ul> Une autre solution consiste à utiliser n'importe quelle méthode et à ajouter l'entête "X_HTTP_METHOD_OVERRIDE" avec pour valeur le nom de la méthode que vous souhaitez utiliser. Exemple d'entête : "X_HTTP_METHOD_OVERRIDE: PUT". Exemple : <ol><li><div class="src-line"><span class="src-id">curl </span>-<span class="src-id">v </span>-<span class="src-id">v </span>-<span class="src-id">H </span><span class="src-str">"X_HTTP_METHOD_OVERRIDE: DELETE" "http://www.mondomaine.org/services/apiVersion/[mon-service]/"</span></div></li></ol> Cela fonctionne avec Apache.</p><p>Les classes des services web doivent avoir un nom au format ChatMot "MonService" et être appelée dans l'url par le même nom en minuscule où les mots sont séparés par des tirets "mon-service".</p><p>Paramètres liés dans config.ini : <ul><li>serveur.baseURL : morceau de l'url pour appeler le serveur relative au domaine. Exemple : pour http://www.tela-botanica.org/mon_serveur/</li></ul> mettre : "/mon_serveur/" <ul><li>serveur.baseAlternativeURL : sur le même principe que ci-dessus permet d'affecter une deuxième url (pour gérer des raccourci via htaccess)</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: RestServeur.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>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_methods"></a><h3>Class Methods</h3><div class="tags"><hr /><a name="methodchargerClasse"></a><h3>static method chargerClasse <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a282">282</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>static void chargerClasse(string$classe)</code></td></tr></table></td></tr></table><br />La méthode __autoload() charge dynamiquement les classes trouvées dans le code.<br /><br /><p>Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>le fichier contenant la classe doit être inclu par la fonction.</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">string </td><td><b>$classe</b> </td><td>le nom de la classe appelée.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodenvoyerEnteteStatutHttp"></a><h3>static method envoyerEnteteStatutHttp <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a441">441</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>static void envoyerEnteteStatutHttp(int$code)</code></td></tr></table></td></tr></table><br />Envoyer un entête HTTP (version 1.0) de statut.<br /><br /><p>Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.</p><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">int </td><td><b>$code</b> </td><td>entier indiquant le code du statut de l'entête HTTP à envoyer.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgererErreurs"></a><h3>static method gererErreurs <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a461">461</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>static void gererErreurs()</code></td></tr></table></td></tr></table><br />Si des exceptions ou des erreurs sont soulevées par le serveur ou les services, elles sont gérées par cette méthode.<br /><br /><p>Si nous avec des erreurs d'un type différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyées sur la sortie standard (via echo). Si seulement des erreurs de type E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du paramètre de config "debogage_mode" : <ul><li>Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.</li><li>Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type</li></ul> E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo). <ul><li>Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type</li></ul> E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme. <ul><li>Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).</li></ul></p><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 /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodexecuter"></a><h3>method executer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a299">299</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>void executer()</code></td></tr></table></td></tr></table><br />Execute la requête.<br /><br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="method__construct"></a><h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a167">167</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>RestServeur __construct()</code></td></tr></table></td></tr></table><br />Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse l'url appelée pour trouver le service demandé.<br /><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 /><div class="top">[ <a href="#top">Top</a> ]</div></div></div><br /><hr /><a name="class_consts"></a><h3>Class Constants</h3><div class="tags"><a name="constHTTP_CODE_ACCES_NON_AUTORISE"></a><p></p><h4>HTTP_CODE_ACCES_NON_AUTORISE = <span class="value"> '401'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a75">75</a>]</p>Code HTTP 401 indiquant que l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour accéder à la ressource.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_CONFLIT"></a><p></p><h4>HTTP_CODE_CONFLIT = <span class="value"> '409'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a88">88</a>]</p>Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la ressource.<br /><br /><p>Par exemple, essayer de créer deux fois la même ressource ou bien tenter de modifier une ressource qui a été modifiée par ailleurs.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_CONTENU_REQUIS"></a><p></p><h4>HTTP_CODE_CONTENU_REQUIS = <span class="value"> '411'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a91">91</a>]</p>Code HTTP 411 indiquant que des paramètres passés dans le contenu de la requête sont nécessaires au service.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_CREATION_OK"></a><p></p><h4>HTTP_CODE_CREATION_OK = <span class="value"> '201'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a62">62</a>]</p>Code HTTP 201 indiquant que l'accès à un service web est un succès et que la ressource a été créée ou modifié.<br /><br /><p>L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_ERREUR"></a><p></p><h4>HTTP_CODE_ERREUR = <span class="value"> '500'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a95">95</a>]</p>Code d'erreur HTTP 500 Internal Server Error.<br /><br /><p>L'utiliser quand le serveur ou un service soulève une erreur ou une exception.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_MAUVAISE_REQUETE"></a><p></p><h4>HTTP_CODE_MAUVAISE_REQUETE = <span class="value"> '400'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a71">71</a>]</p>Code HTTP 400 indique que les paramètres envoyés au service contiennent des erreurs.<br /><br /><p>L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source de l'erreur.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_METHODE_NON_AUTORISE"></a><p></p><h4>HTTP_CODE_METHODE_NON_AUTORISE = <span class="value"> '405'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a83">83</a>]</p>Code HTTP 405 indiquant soit : <ul><li>que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.</li></ul><br /><br /><p><ul><li>que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url.</li></ul></p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_OK"></a><p></p><h4>HTTP_CODE_OK = <span class="value"> '200'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a58">58</a>]</p>Code HTTP 200 indiquant le succès de l'accès à un service web par la méthode GET.<br /><br /><p>L'utiliser lors d'une requète de type GET (consulter) pour indiquer le succès de l'opération. Sera renvoyée par défaut par PHP.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_RESSOURCE_INTROUVABLE"></a><p></p><h4>HTTP_CODE_RESSOURCE_INTROUVABLE = <span class="value"> '404'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a78">78</a>]</p>Code HTTP 404 indiquant que la ressource indiquée par l'url est introuvable.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constHTTP_CODE_SUPPRESSION_OK"></a><p></p><h4>HTTP_CODE_SUPPRESSION_OK = <span class="value"> '204'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a66">66</a>]</p>Code HTTP 204 indique que l'accès à un service web est un succès et qu'il n'y a pas de contenu à renvoyer.<br /><br /><p>L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération.</p><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMETHODE_DELETE"></a><p></p><h4>METHODE_DELETE = <span class="value"> 'supprimer'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a50">50</a>]</p>Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMETHODE_GET"></a><p></p><h4>METHODE_GET = <span class="value"> 'consulter'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a44">44</a>]</p>Nom de la méthode appelée dans un service pour éxécuter une requête de type GET.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMETHODE_POST"></a><p></p><h4>METHODE_POST = <span class="value"> 'modifier'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a47">47</a>]</p>Nom de la méthode appelée dans un service pour éxécuter une requête de type POST.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMETHODE_PUT"></a><p></p><h4>METHODE_PUT = <span class="value"> 'ajouter'</span></h4><p>[line <a href="../__filesource/fsource_Framework__RestServeur.php.html#a53">53</a>]</p>Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></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>