New file |
0,0 → 1,672 |
<!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 RestService | TBFramework - v0.4</title> |
|
<script type="text/javascript" src="resources/combined.js?4205936287"></script> |
<script type="text/javascript" src="elementlist.js?1964084359"></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-MonService.html">MonService</a></li> |
<li><a href="class-Registre.html">Registre</a></li> |
<li><a href="class-RestClient.html">RestClient</a></li> |
<li><a href="class-RestServeur.html">RestServeur</a></li> |
<li class="active"><a href="class-RestService.html">RestService</a></li> |
<li><a href="class-Script.html">Script</a></li> |
<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li> |
<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li> |
<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</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 RestService</h1> |
|
|
<div class="description"> |
|
<p>Classe principale gérant les services. Paramètres liés dans config.ini : - |
serveur.baseURL</p> |
|
<p>Encodage en entrée : utf8 Encodage en sortie : utf8</p> |
|
</div> |
|
|
|
<div> |
<h4>Direct known subclasses</h4> |
<a href="class-MonService.html">MonService</a>, |
<a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a>, |
<a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a>, |
<a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a> |
</div> |
|
|
|
|
|
|
<div class="info"> |
<b>Abstract</b><br> |
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
Php 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2010, Tela Botanica (<a |
href="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 <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: RestService.php 417 2012-05-15 09:24:12Z jpm $<br> |
<b>Since:</b> |
0.3<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-RestService.html#2-150" title="Go to source code">framework/RestService.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-RestService.html#34-37" title="Go to source code">__construct</a>( <span>mixed <var>$config</var></span> )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="initialiser" id="_initialiser"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_initialiser">#</a> |
<code><a href="source-class-RestService.html#39-41" title="Go to source code">initialiser</a>( )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getBdd" id="_getBdd"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getBdd">#</a> |
<code><a href="source-class-RestService.html#43-52" title="Go to source code">getBdd</a>( )</code> |
|
<div class="description short"> |
|
<p>Méthode de connection à la base de données sur demande. Tous les services |
web n'ont pas besoin de s'y connecter.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode de connection à la base de données sur demande. Tous les services |
web n'ont pas besoin de s'y connecter.</p> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getRestClient" id="_getRestClient"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getRestClient">#</a> |
<code><a href="source-class-RestService.html#54-62" title="Go to source code">getRestClient</a>( )</code> |
|
<div class="description short"> |
|
<p>Méthode permettant de faire appel à un client REST en fonction des besoins |
du service.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode permettant de faire appel à un client REST en fonction des besoins |
du service.</p> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="utiliserParametresBruts" id="_utiliserParametresBruts"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_utiliserParametresBruts">#</a> |
<code><a href="source-class-RestService.html#64-70" title="Go to source code">utiliserParametresBruts</a>( )</code> |
|
<div class="description short"> |
|
<p>Méthode permettant de savoir si le service veut utiliser des paramètres |
bruts (issu de la QueryString) ou pas (issu de $_GET).</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode permettant de savoir si le service veut utiliser des paramètres |
bruts (issu de la QueryString) ou pas (issu de $_GET).</p> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="ajouterMessage" id="_ajouterMessage"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_ajouterMessage">#</a> |
<code><a href="source-class-RestService.html#72-79" 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é au |
client. 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é au |
client. 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> |
<tr data-order="consulter" id="_consulter"> |
|
<td class="attributes"><code> |
public |
string |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_consulter">#</a> |
<code><a href="source-class-RestService.html#81-94" title="Go to source code">consulter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$parametres</var></span> )</code> |
|
<div class="description short"> |
|
<p>Méthode appelée lors d'une requête HTTP de type GET.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode appelée lors d'une requête HTTP de type GET.</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> |
<div class="list"><dl> |
<dt><var>$ressources</var></dt> |
<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service |
demandé.</dd> |
<dt><var>$parametres</var></dt> |
<dd><code>array</code><br>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>string</code><br>une chaine indiquant le succès de l'opération et les données demandées.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="modifier" id="_modifier"> |
|
<td class="attributes"><code> |
public |
mixed |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_modifier">#</a> |
<code><a href="source-class-RestService.html#96-111" title="Go to source code">modifier</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code> |
|
<div class="description short"> |
|
<p>Méthode appelée lors d'une requête HTTP de type POST.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode appelée lors d'une requête HTTP de type POST.</p> |
|
<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, la méthode devra retourner "true" et le code |
statut HTTP retourné sera 201.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$ressources</var></dt> |
<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service |
demandé.</dd> |
<dt><var>$requeteDonnees</var></dt> |
<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à la |
modification.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="ajouter" id="_ajouter"> |
|
<td class="attributes"><code> |
public |
string |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_ajouter">#</a> |
<code><a href="source-class-RestService.html#113-130" title="Go to source code">ajouter</a>( <span>array <var>$ressources</var></span>, <span>array <var>$requeteDonnees</var></span> )</code> |
|
<div class="description short"> |
|
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode appelée lors d'une requête HTTP de type PUT.</p> |
|
<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, 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> |
<div class="list"><dl> |
<dt><var>$ressources</var></dt> |
<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service |
demandé.</dd> |
<dt><var>$requeteDonnees</var></dt> |
<dd><code>array</code><br>les données transférées dans le corps de la requête devant servir à |
l'ajout.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>string</code><br>l'identifiant créé.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="supprimer" id="_supprimer"> |
|
<td class="attributes"><code> |
public |
mixed |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_supprimer">#</a> |
<code><a href="source-class-RestService.html#132-149" title="Go to source code">supprimer</a>( <span>array <var>$ressources</var></span> )</code> |
|
<div class="description short"> |
|
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec |
action=DELETE dans le corps de la requete).</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec |
action=DELETE dans le corps de la requete).</p> |
|
<p>Si la suppression est un succès, la méthode devra retourner "true" et le |
code statut HTTP retourné par RestServeur sera 204. Si la ressource à |
supprimer est introuvable, la méthode devra retourner "false" et le code statut |
HTTP retourné par RestServeur sera 404. Dans les autres cas de figure ou si |
vous souhaitez gérer vos propres codes de retour erreur, retourner la valeur |
null ou rien.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$ressources</var></dt> |
<dd><code>array</code><br>Morceaux de l'url servant à préciser la ressource concerné pour le service |
demandé.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>mixed</code><br>une chaine indiquant le succès de l'opération ou rien.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties"> |
<caption>Properties summary</caption> |
<tr data-order="bdd" id="$bdd"> |
<td class="attributes"><code> |
protected |
mixed |
</code></td> |
|
<td class="name"> |
<a href="source-class-RestService.html#22-26" title="Go to source code"><var>$bdd</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">null</span></code></td> |
<td class="description"><div> |
<a href="#$bdd" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Objet de connection à la base de données.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Objet de connection à la base de données.</p> |
|
|
<h4>Deprecated</h4> |
<div class="list"> |
Utiliser la methode getBdd().<br> |
</div> |
<h4>See</h4> |
<div class="list"> |
<code><code><a href="class-RestService.html#_getBdd">RestService::getBdd()</a></code></code><br> |
</div> |
</div> |
</div></td> |
</tr> |
<tr data-order="utilisationParametresBruts" id="$utilisationParametresBruts"> |
<td class="attributes"><code> |
protected |
boolean |
</code></td> |
|
<td class="name"> |
<a href="source-class-RestService.html#31-32" title="Go to source code"><var>$utilisationParametresBruts</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">false</span></code></td> |
<td class="description"><div> |
<a href="#$utilisationParametresBruts" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres |
brutes.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Indique si oui (true) ou non (false), on veut utiliser les paramètres |
brutes.</p> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
</div> |
|
<div id="footer"> |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
</div> |
</div> |
</div> |
</body> |
</html> |