Blame | Last modification | View Log | RSS feed
<!DOCTYPE html><html lang="en"><head><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/><meta charset="utf-8"/><title>TBFramework - v0.4</title><meta name="author" content=""/><meta name="description" content=""/><link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet"><link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet"><link href="../css/prism.css" rel="stylesheet" media="all"/><link href="../css/template.css" rel="stylesheet" media="all"/><!--[if lt IE 9]><script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script><![endif]--><script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script><script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script><script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script><script src="../js/jquery.smooth-scroll.js"></script><script src="../js/prism.min.js"></script><!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit--><script type="text/javascript">function loadExternalCodeSnippets() {Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {var src = pre.getAttribute('data-src');var extension = (src.match(/\.(\w+)$/) || [, ''])[1];var language = 'php';var code = document.createElement('code');code.className = 'language-' + language;pre.textContent = '';code.textContent = 'Loading…';pre.appendChild(code);var xhr = new XMLHttpRequest();xhr.open('GET', src, true);xhr.onreadystatechange = function () {if (xhr.readyState == 4) {if (xhr.status < 400 && xhr.responseText) {code.textContent = xhr.responseText;Prism.highlightElement(code);}else if (xhr.status >= 400) {code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;}else {code.textContent = '✖ Error: File does not exist or is empty';}}};xhr.send(null);});}$(document).ready(function(){loadExternalCodeSnippets();});$('#source-view').on('shown', function () {loadExternalCodeSnippets();})</script><link rel="shortcut icon" href="../images/favicon.ico"/><link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/><link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/><link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div class="container"><a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><i class="icon-ellipsis-vertical"></i></a><a class="brand" href="../index.html">TBFramework - v0.4</a><div class="nav-collapse"><ul class="nav pull-right"><li class="dropdown"><a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a><ul class="dropdown-menu"></ul></li><li class="dropdown" id="charts-menu"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graphs/class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul></li><li class="dropdown" id="reports-menu"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Reports <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../reports/errors.html"><i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">281</span></a></li><li><a href="../reports/markers.html"><i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">12</span></a></li></ul></li></ul></div></div></div><!--<div class="go_to_top">--><!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>--><!--</div>--></div><div id="___" class="container-fluid"><section class="row-fluid"><div class="span2 sidebar"><div class="accordion" style="margin-bottom: 0"><div class="accordion-group"><div class="accordion-heading"><a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1211737728"></a><a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a></div><div id="namespace-1211737728" class="accordion-body collapse in"><div class="accordion-inner"><ul><li class="class"><a href="../classes/Url.html">Url</a></li><li class="class"><a href="../classes/Debug.html">Debug</a></li><li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li><li class="class"><a href="../classes/RestServeur.html">RestServeur</a></li><li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li><li class="class"><a href="../classes/Controleur.html">Controleur</a></li><li class="class"><a href="../classes/Cache.html">Cache</a></li><li class="class"><a href="../classes/RestClient.html">RestClient</a></li><li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li><li class="class"><a href="../classes/Script.html">Script</a></li><li class="class"><a href="../classes/Registre.html">Registre</a></li><li class="class"><a href="../classes/RestService.html">RestService</a></li><li class="class"><a href="../classes/Cli.html">Cli</a></li><li class="class"><a href="../classes/Encodage.html">Encodage</a></li><li class="class"><a href="../classes/Tableau.html">Tableau</a></li><li class="class"><a href="../classes/Pattern.html">Pattern</a></li><li class="class"><a href="../classes/Chaine.html">Chaine</a></li><li class="class"><a href="../classes/Fichier.html">Fichier</a></li><li class="class"><a href="../classes/I18n.html">I18n</a></li><li class="class"><a href="../classes/Config.html">Config</a></li><li class="class"><a href="../classes/CacheSqlite.html">CacheSqlite</a></li><li class="class"><a href="../classes/Bdd.html">Bdd</a></li><li class="class"><a href="../classes/Log.html">Log</a></li><li class="class"><a href="../classes/CacheFichier.html">CacheFichier</a></li><li class="class"><a href="../classes/Framework.html">Framework</a></li><li class="class"><a href="../classes/CacheSimple.html">CacheSimple</a></li></ul></div></div></div></div></div></section><section class="row-fluid"><div class="span10 offset2"><div class="row-fluid"><div class="span8 content class"><nav><a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i></nav><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a><h1><small>\</small>RestService</h1><p><em>Classe principale gérant les services.</em></p><p>Paramètres liés dans config.ini :</p><ul><li>serveur.baseURL</li></ul><p>Encodage en entrée : utf8Encodage en sortie : utf8</p><section id="summary"><h2>Summary</h2><section class="row-fluid heading"><section class="span4"><a href="#methods">Methods</a></section><section class="span4"><a href="#properties">Properties</a></section><section class="span4"><a href="#constants">Constants</a></section></section><section class="row-fluid public"><section class="span4"><a href="../classes/RestService.html#method___construct" class="">__construct()</a><br /><a href="../classes/RestService.html#method_initialiser" class="">initialiser()</a><br /><a href="../classes/RestService.html#method_utiliserParametresBruts" class="">utiliserParametresBruts()</a><br /><a href="../classes/RestService.html#method_consulter" class="">consulter()</a><br /><a href="../classes/RestService.html#method_modifier" class="">modifier()</a><br /><a href="../classes/RestService.html#method_ajouter" class="">ajouter()</a><br /><a href="../classes/RestService.html#method_supprimer" class="">supprimer()</a><br /></section><section class="span4"><em>No public properties found</em></section><section class="span4"><em>No constants found</em></section></section><section class="row-fluid protected"><section class="span4"><a href="../classes/RestService.html#method_getBdd" class="">getBdd()</a><br /><a href="../classes/RestService.html#method_getRestClient" class="">getRestClient()</a><br /><a href="../classes/RestService.html#method_ajouterMessage" class="">ajouterMessage()</a><br /></section><section class="span4"><a href="../classes/RestService.html#property_bdd" class="deprecated">$bdd</a><br /><a href="../classes/RestService.html#property_utilisationParametresBruts" class="">$utilisationParametresBruts</a><br /></section><section class="span4"><em>N/A</em></section></section><section class="row-fluid private"><section class="span4"><em>No private methods found</em></section><section class="span4"><a href="../classes/RestService.html#property_RestClient" class="">$RestClient</a><br /></section><section class="span4"><em>N/A</em></section></section></section></div><aside class="span4 detailsbar"><span class="label label-info">abstract</span><dl><dt>File</dt><dd><a href="../files/RestService.php.html"><div class="path-wrapper">RestService.php</div></a></dd><dt>Package</dt><dd><div class="namespace-wrapper">\Framework</div></dd><dt>Class hierarchy</dt><dd class="hierarchy"><div class="namespace-wrapper">\RestService</div></dd><dt>See also</dt><dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>category</th><td><p>Php 5.2</p></td></tr><tr><th>author</th><td><p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p></td></tr><tr><th>copyright</th><td><p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p></td></tr><tr><th>license</th><td><p>GPL v3 <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></p><p>CECILL v2 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt</a></p></td></tr><tr><th>since</th><td></td></tr><tr><th>version</th><td><p>$Id: RestService.php 417 2012-05-15 09:24:12Z jpm $</p></td></tr><tr><th>todo</th><td></td></tr></table></aside></div><a id="properties" name="properties"></a><div class="row-fluid"><div class="span8 content class"><h2>Properties</h2></div><aside class="span4 detailsbar"></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_bdd" name="property_bdd" class="anchor"></a><article class="property"><h3 class="protected deprecated">$bdd</h3><pre class="signature">$bdd</pre><p><em>Objet de connection à la base de données.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><aside class="alert alert-block alert-error"><h4>Deprecated</h4>Utiliser la methode getBdd().</aside><dl><dt>See also</dt><dd><a href=""><span class="namespace-wrapper"></span></a></dd></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_utilisationParametresBruts" name="property_utilisationParametresBruts" class="anchor"></a><article class="property"><h3 class="protected ">$utilisationParametresBruts</h3><pre class="signature">$utilisationParametresBruts</pre><p><em>Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_RestClient" name="property_RestClient" class="anchor"></a><article class="property"><h3 class="private ">$RestClient</h3><pre class="signature">$RestClient</pre><p><em>Objet Rest Client.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><a id="methods" name="methods"></a><div class="row-fluid"><div class="span8 content class"><h2>Methods</h2></div><aside class="span4 detailsbar"></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method___construct" name="method___construct" class="anchor"></a><article class="method"><h3 class="public ">__construct()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">__construct( <span class="argument">$config</span>)</pre><p><em></em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td></td><td>$config</td><td></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_initialiser" name="method_initialiser" class="anchor"></a><article class="method"><h3 class="public ">initialiser()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">initialiser()</pre><p><em></em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_utiliserParametresBruts" name="method_utiliserParametresBruts" class="anchor"></a><article class="method"><h3 class="public ">utiliserParametresBruts()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">utiliserParametresBruts()</pre><p><em>Méthode permettant de savoir si le service veut utiliser des paramètres bruts (issu de la QueryString)ou pas (issu de $_GET).</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_consulter" name="method_consulter" class="anchor"></a><article class="method"><h3 class="public ">consulter()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">consulter( <span class="argument">$ressources</span>, <span class="argument">$parametres</span>) : string</pre><p><em>Méthode appelée lors d'une requête HTTP de type GET.</em></p><p>Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,la méthode devra retourner le code statut HTTP adéquate.</p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td></td><td>$ressources</td><td></td></tr><tr><td></td><td>$parametres</td><td></td></tr></table><h4>Returns</h4>string— <p>une chaine indiquant le succès de l'opération et les données demandées.</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_modifier" name="method_modifier" class="anchor"></a><article class="method"><h3 class="public ">modifier()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">modifier( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : mixed</pre><p><em>Méthode appelée lors d'une requête HTTP de type POST.</em></p><p>La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corpsde la requête.Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.</p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td></td><td>$ressources</td><td></td></tr><tr><td></td><td>$requeteDonnees</td><td></td></tr></table><h4>Returns</h4>mixed— <p>une chaine indiquant le succès de l'opération ou rien.</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_ajouter" name="method_ajouter" class="anchor"></a><article class="method"><h3 class="public ">ajouter()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">ajouter( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : string</pre><p><em>Méthode appelée lors d'une requête HTTP de type PUT.</em></p><p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé parle 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, la méthode devra retourner "true" ou l'identifiant.Le code statut HTTP retourné sera 201 en cas de succès.Dans le cas contraire, la méthode devra retourner false.</p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td></td><td>$ressources</td><td></td></tr><tr><td></td><td>$requeteDonnees</td><td></td></tr></table><h4>Returns</h4>string— <p>l'identifiant créé.</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_supprimer" name="method_supprimer" class="anchor"></a><article class="method"><h3 class="public ">supprimer()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">supprimer( <span class="argument">$ressources</span>) : mixed</pre><p><em>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).</em></p><p>Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné parRestServeur sera 204.Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTPretourné par RestServeur sera 404.Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retournerla valeur null ou rien.</p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td></td><td>$ressources</td><td></td></tr></table><h4>Returns</h4>mixed— <p>une chaine indiquant le succès de l'opération ou rien.</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_getBdd" name="method_getBdd" class="anchor"></a><article class="method"><h3 class="protected ">getBdd()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">getBdd()</pre><p><em>Méthode de connection à la base de données sur demande.</em></p><p>Tous les services web n'ont pas besoin de s'y connecter.</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_getRestClient" name="method_getRestClient" class="anchor"></a><article class="method"><h3 class="protected ">getRestClient()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">getRestClient()</pre><p><em>Méthode permettant de faire appel à un client REST en fonction des besoins du service.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_ajouterMessage" name="method_ajouterMessage" class="anchor"></a><article class="method"><h3 class="protected ">ajouterMessage()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">ajouterMessage(string <span class="argument">$message</span>)</pre><p><em>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.</em></p><p>Le message doit être au format texte et en UTF-8.</p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$message</td><td><p>le message à envoyer.</p></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div></div></section><div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h3 id="source-view-label">RestService.php</h3></div><div class="modal-body"><pre data-src="../files/RestService.php.txt" class="language-php line-numbers"></pre></div></div><footer class="row-fluid"><section class="span10 offset2"><section class="row-fluid"><section class="span10 offset1"><section class="row-fluid footer-sections"><section class="span4"><h1><i class="icon-code"></i></h1><div><ul></ul></div></section><section class="span4"><h1><i class="icon-bar-chart"></i></h1><div><ul><li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li></ul></div></section><section class="span4"><h1><i class="icon-pushpin"></i></h1><div><ul><li><a href="../reports/errors.html">Errors</a></li><li><a href="../reports/markers.html">Markers</a></li></ul></div></section></section></section></section><section class="row-fluid"><section class="span10 offset1"><hr />Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authoredon March 12th, 2014 at 15:57.</section></section></section></footer></div></body></html>