Rev 464 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="ApiGen 2.8.0"><title>Class RestServeur</title><script type="text/javascript" src="resources/combined.js?4205936287"></script><script type="text/javascript" src="elementlist.js?4111837732"></script><link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"></head><body><div id="left"><div id="menu"><a href="index.html" title="Overview"><span>Overview</span></a><div id="groups"><h3>Packages</h3><ul><li class="active"><a href="package-Framework.html">Framework</a></li><li><a href="package-None.html">None</a></li><li><a href="package-PHP.html">PHP</a></li><li><a href="package-Utilitaire.html">Utilitaire</a></li></ul></div><hr><div id="elements"><h3>Classes</h3><ul><li><a href="class-Bdd.html">Bdd</a></li><li><a href="class-Cache.html">Cache</a></li><li><a href="class-CacheSimple.html">CacheSimple</a></li><li><a href="class-Chronometre.html">Chronometre</a></li><li><a href="class-Cli.html">Cli</a></li><li><a href="class-Config.html">Config</a></li><li><a href="class-Controleur.html">Controleur</a></li><li><a href="class-Debug.html">Debug</a></li><li><a href="class-Framework.html">Framework</a></li><li><a href="class-GestionnaireException.html">GestionnaireException</a></li><li><a href="class-I18n.html">I18n</a></li><li><a href="class-Log.html">Log</a></li><li><a href="class-Registre.html">Registre</a></li><li><a href="class-RestClient.html">RestClient</a></li><li class="active"><a href="class-RestServeur.html">RestServeur</a></li><li><a href="class-RestService.html">RestService</a></li><li><a href="class-Script.html">Script</a></li><li><a href="class-SquelettePhp.html">SquelettePhp</a></li><li><a href="class-Url.html">Url</a></li></ul></div></div></div><div id="splitter"></div><div id="right"><div id="rightInner"><form id="search"><input type="hidden" name="cx" value=""><input type="hidden" name="ie" value="UTF-8"><input type="text" name="q" class="text"><input type="submit" value="Search"></form><div id="navigation"><ul><li><a href="index.html" title="Overview"><span>Overview</span></a></li><li><a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a></li><li class="active"><span>Class</span> </li></ul><ul><li><a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a></li><li><a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a></li><li><a href="todo.html" title="Todo list"><span>Todo</span></a></li></ul><ul></ul></div><div id="content" class="class"><h1>Class RestServeur</h1><div class="info"><b>Package:</b> <a href="package-Framework.html">Framework</a><br><b>Copyright:</b>Copyright (c) 2010, Tela Botanica (<ahref="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br><b>License:</b><a href="GPL">v3 <http://www.gnu.org/licenses/gpl.txt></a><br><b>License:</b><a href="CECILL">v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt></a><br><b>Author:</b>Jean-Pascal MILCENT <<ahref="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br><b>Located at</b> <a href="source-class-RestServeur.html#42-666" title="Go to source code">RestServeur.php</a><br></div><table class="summary" id="methods"><caption>Methods summary</caption><tr data-order="__construct" id="___construct"><td class="attributes"><code>public</code></td><td class="name"><div><a class="anchor" href="#___construct">#</a><code><a href="source-class-RestServeur.html#192-220" title="Go to source code">__construct</a>( )</code><div class="description short"><p>Analyse les données envoyées au serveur, enregistre la méthode HTTPutilisée pour appeler le serveur et parse l'url appelée pour trouver leservice demandé.</p></div><div class="description detailed hidden"><p>Analyse les données envoyées au serveur, enregistre la méthode HTTPutilisée pour appeler le serveur et parse l'url appelée pour trouver leservice demandé.</p></div></div></td></tr><tr data-order="chargerClasse" id="_chargerClasse"><td class="attributes"><code>public static</code></td><td class="name"><div><a class="anchor" href="#_chargerClasse">#</a><code><a href="source-class-RestServeur.html#364-382" title="Go to source code">chargerClasse</a>( <span>string <var>$classe</var></span> )</code><div class="description short"><p>La méthode __autoload() charge dynamiquement les classes trouvées dans lecode. Cette fonction est appelée par php5 quand il trouve une instanciation declasse dans le code.</p></div><div class="description detailed hidden"><p>La méthode __autoload() charge dynamiquement les classes trouvées dans lecode. Cette fonction est appelée par php5 quand il trouve une instanciation declasse dans le code.</p><h4>Parameters</h4><div class="list"><dl><dt><var>$classe</var></dt><dd><code>string</code><br>le nom de la classe appelée.</dd></dl></div><h4>Returns</h4><div class="list"><code></code><br>le fichier contenant la classe doit être inclu par la fonction.<br></div></div></div></td></tr><tr data-order="executer" id="_executer"><td class="attributes"><code>public</code></td><td class="name"><div><a class="anchor" href="#_executer">#</a><code><a href="source-class-RestServeur.html#384-419" title="Go to source code">executer</a>( )</code><div class="description short"><p>Execute la requête.</p></div><div class="description detailed hidden"><p>Execute la requête.</p></div></div></td></tr><tr data-order="envoyerEnteteStatutHttp" id="_envoyerEnteteStatutHttp"><td class="attributes"><code>public static</code></td><td class="name"><div><a class="anchor" href="#_envoyerEnteteStatutHttp">#</a><code><a href="source-class-RestServeur.html#569-579" title="Go to source code">envoyerEnteteStatutHttp</a>( <span>integer <var>$code</var></span> )</code><div class="description short"><p>Envoyer un entête HTTP (version 1.0) de statut. Il remplacerasystématiquement tout entête HTTP de statut précédement envoyé.</p></div><div class="description detailed hidden"><p>Envoyer un entête HTTP (version 1.0) de statut. Il remplacerasystématiquement tout entête HTTP de statut précédement envoyé.</p><h4>Parameters</h4><div class="list"><dl><dt><var>$code</var></dt><dd><code>integer</code><br>$code entier indiquant le code du statut de l'entête HTTP à envoyer.</dd></dl></div></div></div></td></tr><tr data-order="gererErreurs" id="_gererErreurs"><td class="attributes"><code>public static</code></td><td class="name"><div><a class="anchor" href="#_gererErreurs">#</a><code><a href="source-class-RestServeur.html#601-642" title="Go to source code">gererErreurs</a>( )</code><div class="description short"><p>Si des exceptions ou des erreurs sont soulevées par le serveur ou lesservices, elles sont gérées par cette méthode. Si nous avec des erreurs d'untype différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyéessur la sortie standard (via echo). Si seulement des erreurs de typeE_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu duparamètre de config "debogage_mode" :<br />- Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment oùils sont déclenchés dans le code.<br />- Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exceptionsous forme d'erreur de type<br />E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'executiondu programme (via echo).<br />- Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaired'exception sous forme d'erreur de type<br />E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES)à la fin de l'execution du programme.<br />- Autre valeur : les messages sont formatés puis retournés par la fonction dedébogage (à vous de les afficher).</p></div><div class="description detailed hidden"><p>Si des exceptions ou des erreurs sont soulevées par le serveur ou lesservices, elles sont gérées par cette méthode. Si nous avec des erreurs d'untype différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyéessur la sortie standard (via echo). Si seulement des erreurs de typeE_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu duparamètre de config "debogage_mode" : - Debug::MODE_ECHO : les messages sontaffichés en utilisant echo au moment où ils sont déclenchés dans le code. -Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exceptionsous forme d'erreur de type E_USER_NOTICE et sont renvoyés sur la sortiestandard à la fin de l'execution du programme (via echo). -Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaired'exception sous forme d'erreur de type E_USER_NOTICE et sont renvoyés dans unentête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme. -Autre valeur : les messages sont formatés puis retournés par la fonction dedébogage (à vous de les afficher).</p></div></div></td></tr><tr data-order="ajouterMessage" id="_ajouterMessage"><td class="attributes"><code>public static</code></td><td class="name"><div><a class="anchor" href="#_ajouterMessage">#</a><code><a href="source-class-RestServeur.html#645-654" title="Go to source code">ajouterMessage</a>( <span>string <var>$message</var></span> )</code><div class="description short"><p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé auclient. Le message doit être au format texte et en UTF-8.</p></div><div class="description detailed hidden"><p>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé auclient. Le message doit être au format texte et en UTF-8.</p><h4>Parameters</h4><div class="list"><dl><dt><var>$message</var></dt><dd><code>string</code><br>$message le message à envoyer.</dd></dl></div></div></div></td></tr></table><table class="summary" id="constants"><caption>Constants summary</caption><tr data-order="METHODE_GET" id="METHODE_GET"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#44-45" title="Go to source code"><b>METHODE_GET</b></a></code></td><td class="value"><code><span class="php-quote">'consulter'</span></code></td><td class="description"><div><a href="#METHODE_GET" class="anchor">#</a><div class="description short"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype GET.</p></div><div class="description detailed hidden"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype GET.</p></div></div></td></tr><tr data-order="METHODE_POST" id="METHODE_POST"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#47-48" title="Go to source code"><b>METHODE_POST</b></a></code></td><td class="value"><code><span class="php-quote">'modifier'</span></code></td><td class="description"><div><a href="#METHODE_POST" class="anchor">#</a><div class="description short"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype POST.</p></div><div class="description detailed hidden"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype POST.</p></div></div></td></tr><tr data-order="METHODE_DELETE" id="METHODE_DELETE"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#50-51" title="Go to source code"><b>METHODE_DELETE</b></a></code></td><td class="value"><code><span class="php-quote">'supprimer'</span></code></td><td class="description"><div><a href="#METHODE_DELETE" class="anchor">#</a><div class="description short"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype DELETE.</p></div><div class="description detailed hidden"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype DELETE.</p></div></div></td></tr><tr data-order="METHODE_PUT" id="METHODE_PUT"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#53-54" title="Go to source code"><b>METHODE_PUT</b></a></code></td><td class="value"><code><span class="php-quote">'ajouter'</span></code></td><td class="description"><div><a href="#METHODE_PUT" class="anchor">#</a><div class="description short"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype PUT.</p></div><div class="description detailed hidden"><p>Nom de la méthode appelée dans un service pour éxécuter une requête detype PUT.</p></div></div></td></tr><tr data-order="HTTP_CODE_OK" id="HTTP_CODE_OK"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#56-59" title="Go to source code"><b>HTTP_CODE_OK</b></a></code></td><td class="value"><code><span class="php-quote">'200'</span></code></td><td class="description"><div><a href="#HTTP_CODE_OK" class="anchor">#</a><div class="description short"><p>Code HTTP 200 indiquant le succès de l'accès à un service web par laméthode GET. L'utiliser lors d'une requète de type GET (consulter) pourindiquer le succès de l'opération. Sera renvoyée par défaut par PHP.</p></div><div class="description detailed hidden"><p>Code HTTP 200 indiquant le succès de l'accès à un service web par laméthode GET. L'utiliser lors d'une requète de type GET (consulter) pourindiquer le succès de l'opération. Sera renvoyée par défaut par PHP.</p></div></div></td></tr><tr data-order="HTTP_CODE_CREATION_OK" id="HTTP_CODE_CREATION_OK"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#61-63" title="Go to source code"><b>HTTP_CODE_CREATION_OK</b></a></code></td><td class="value"><code><span class="php-quote">'201'</span></code></td><td class="description"><div><a href="#HTTP_CODE_CREATION_OK" class="anchor">#</a><div class="description short"><p>Code HTTP 201 indiquant que l'accès à un service web est un succès et quela ressource a été créée ou modifié. L'utiliser lors d'une requète de typePUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p></div><div class="description detailed hidden"><p>Code HTTP 201 indiquant que l'accès à un service web est un succès et quela ressource a été créée ou modifié. L'utiliser lors d'une requète de typePUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p></div></div></td></tr><tr data-order="HTTP_CODE_SUPPRESSION_OK" id="HTTP_CODE_SUPPRESSION_OK"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#65-68" title="Go to source code"><b>HTTP_CODE_SUPPRESSION_OK</b></a></code></td><td class="value"><code><span class="php-quote">'204'</span></code></td><td class="description"><div><a href="#HTTP_CODE_SUPPRESSION_OK" class="anchor">#</a><div class="description short"><p>Code HTTP 204 indique que l'accès à un service web est un succès et qu'iln'y a pas de contenu à renvoyer. L'utiliser lors d'une requète de type DELETE(supprimer) pour indiquer le succès de l'opération si aucun contenu (status)ne doit être renvoyé, sinon utiliser 200 OK.</p></div><div class="description detailed hidden"><p>Code HTTP 204 indique que l'accès à un service web est un succès et qu'iln'y a pas de contenu à renvoyer. L'utiliser lors d'une requète de type DELETE(supprimer) pour indiquer le succès de l'opération si aucun contenu (status)ne doit être renvoyé, sinon utiliser 200 OK.</p></div></div></td></tr><tr data-order="HTTP_CODE_MAUVAISE_REQUETE" id="HTTP_CODE_MAUVAISE_REQUETE"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#70-73" title="Go to source code"><b>HTTP_CODE_MAUVAISE_REQUETE</b></a></code></td><td class="value"><code><span class="php-quote">'400'</span></code></td><td class="description"><div><a href="#HTTP_CODE_MAUVAISE_REQUETE" class="anchor">#</a><div class="description short"><p>Code HTTP 400 indique que les paramètres envoyés au service contiennent deserreurs. L'utiliser pour indiquer l'échec de l'accès au service. La réponsepourra contenir un message expliquant la source de l'erreur.</p></div><div class="description detailed hidden"><p>Code HTTP 400 indique que les paramètres envoyés au service contiennent deserreurs. L'utiliser pour indiquer l'échec de l'accès au service. La réponsepourra contenir un message expliquant la source de l'erreur.</p></div></div></td></tr><tr data-order="HTTP_CODE_ACCES_NON_AUTORISE" id="HTTP_CODE_ACCES_NON_AUTORISE"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#75-77" title="Go to source code"><b>HTTP_CODE_ACCES_NON_AUTORISE</b></a></code></td><td class="value"><code><span class="php-quote">'401'</span></code></td><td class="description"><div><a href="#HTTP_CODE_ACCES_NON_AUTORISE" class="anchor">#</a><div class="description short"><p>Code HTTP 401 indiquant que l'accès à un service web est refusé carl'authentification (obligatoire) a échoué pour accéder à la ressource.</p></div><div class="description detailed hidden"><p>Code HTTP 401 indiquant que l'accès à un service web est refusé carl'authentification (obligatoire) a échoué pour accéder à la ressource.</p></div></div></td></tr><tr data-order="HTTP_CODE_RESSOURCE_INTROUVABLE" id="HTTP_CODE_RESSOURCE_INTROUVABLE"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#79-80" title="Go to source code"><b>HTTP_CODE_RESSOURCE_INTROUVABLE</b></a></code></td><td class="value"><code><span class="php-quote">'404'</span></code></td><td class="description"><div><a href="#HTTP_CODE_RESSOURCE_INTROUVABLE" class="anchor">#</a><div class="description short"><p>Code HTTP 404 indiquant que la ressource indiquée par l'url estintrouvable.</p></div><div class="description detailed hidden"><p>Code HTTP 404 indiquant que la ressource indiquée par l'url estintrouvable.</p></div></div></td></tr><tr data-order="HTTP_CODE_METHODE_NON_AUTORISE" id="HTTP_CODE_METHODE_NON_AUTORISE"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#82-85" title="Go to source code"><b>HTTP_CODE_METHODE_NON_AUTORISE</b></a></code></td><td class="value"><code><span class="php-quote">'405'</span></code></td><td class="description"><div><a href="#HTTP_CODE_METHODE_NON_AUTORISE" class="anchor">#</a><div class="description short"><p>Code HTTP 405 indiquant soit :<br />- que le service web ne possède pas d'accès la ressource correspondant à laméthode HTTP employée.<br />- que la méthode HTTP enployée n'est pas en accord avec la ressource indiquéepar l'url.</p></div><div class="description detailed hidden"><p>Code HTTP 405 indiquant soit : - que le service web ne possède pas d'accèsla ressource correspondant à la méthode HTTP employée. - que la méthode HTTPenployée n'est pas en accord avec la ressource indiquée par l'url.</p></div></div></td></tr><tr data-order="HTTP_CODE_CONFLIT" id="HTTP_CODE_CONFLIT"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#87-90" title="Go to source code"><b>HTTP_CODE_CONFLIT</b></a></code></td><td class="value"><code><span class="php-quote">'409'</span></code></td><td class="description"><div><a href="#HTTP_CODE_CONFLIT" class="anchor">#</a><div class="description short"><p>Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de laressource. Par exemple, essayer de créer deux fois la même ressource ou biententer de modifier une ressource qui a été modifiée par ailleurs.</p></div><div class="description detailed hidden"><p>Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de laressource. Par exemple, essayer de créer deux fois la même ressource ou biententer de modifier une ressource qui a été modifiée par ailleurs.</p></div></div></td></tr><tr data-order="HTTP_CODE_CONTENU_REQUIS" id="HTTP_CODE_CONTENU_REQUIS"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#92-93" title="Go to source code"><b>HTTP_CODE_CONTENU_REQUIS</b></a></code></td><td class="value"><code><span class="php-quote">'411'</span></code></td><td class="description"><div><a href="#HTTP_CODE_CONTENU_REQUIS" class="anchor">#</a><div class="description short"><p>Code HTTP 411 indiquant que des paramètres passés dans le contenu de larequête sont nécessaires au service.</p></div><div class="description detailed hidden"><p>Code HTTP 411 indiquant que des paramètres passés dans le contenu de larequête sont nécessaires au service.</p></div></div></td></tr><tr data-order="HTTP_CODE_ERREUR" id="HTTP_CODE_ERREUR"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#95-97" title="Go to source code"><b>HTTP_CODE_ERREUR</b></a></code></td><td class="value"><code><span class="php-quote">'500'</span></code></td><td class="description"><div><a href="#HTTP_CODE_ERREUR" class="anchor">#</a><div class="description short"><p>Code d'erreur HTTP 500 Internal Server Error. L'utiliser quand le serveur ouun service soulève une erreur ou une exception.</p></div><div class="description detailed hidden"><p>Code d'erreur HTTP 500 Internal Server Error. L'utiliser quand le serveur ouun service soulève une erreur ou une exception.</p></div></div></td></tr><tr data-order="MOTIF_API_VERSION" id="MOTIF_API_VERSION"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#99-100" title="Go to source code"><b>MOTIF_API_VERSION</b></a></code></td><td class="value"><code><span class="php-quote">'/^[0-9]+(?:[.][0-9]+)*$/'</span></code></td><td class="description"><div><a href="#MOTIF_API_VERSION" class="anchor">#</a><div class="description short"><p>Motif de l'epression régulière vérfiant la version de l'API.</p></div><div class="description detailed hidden"><p>Motif de l'epression régulière vérfiant la version de l'API.</p></div></div></td></tr><tr data-order="MOTIF_SERVICE_NOM" id="MOTIF_SERVICE_NOM"><td class="attributes"><code>string</code></td><td class="name"><code><a href="source-class-RestServeur.html#102-103" title="Go to source code"><b>MOTIF_SERVICE_NOM</b></a></code></td><td class="value"><code><span class="php-quote">'/^[a-z0-9]+(?:[-][a-z0-9]+)*$/'</span></code></td><td class="description"><div><a href="#MOTIF_SERVICE_NOM" class="anchor">#</a><div class="description short"><p>Motif de l'epression régulière vérfiant le nom du service.</p></div><div class="description detailed hidden"><p>Motif de l'epression régulière vérfiant le nom du service.</p></div></div></td></tr></table></div><div id="footer">API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a></div></div></div></body></html>