| 464 |
jpm |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
5 |
<meta name="generator" content="ApiGen 2.8.0">
|
|
|
6 |
<meta name="robots" content="noindex">
|
|
|
7 |
|
|
|
8 |
<title>File framework/RestService.php | TBFramework - v0.4</title>
|
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
|
|
|
11 |
<script type="text/javascript" src="elementlist.js?1964084359"></script>
|
|
|
12 |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
|
|
|
13 |
|
|
|
14 |
</head>
|
|
|
15 |
|
|
|
16 |
<body>
|
|
|
17 |
<div id="left">
|
|
|
18 |
<div id="menu">
|
|
|
19 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
20 |
|
|
|
21 |
|
|
|
22 |
<div id="groups">
|
|
|
23 |
<h3>Packages</h3>
|
|
|
24 |
<ul>
|
|
|
25 |
<li class="active"><a href="package-Framework.html">Framework</a>
|
|
|
26 |
</li>
|
|
|
27 |
<li><a href="package-None.html">None</a>
|
|
|
28 |
</li>
|
|
|
29 |
<li><a href="package-PHP.html">PHP</a>
|
|
|
30 |
</li>
|
|
|
31 |
<li><a href="package-Utilitaire.html">Utilitaire</a>
|
|
|
32 |
</li>
|
|
|
33 |
</ul>
|
|
|
34 |
</div>
|
|
|
35 |
|
|
|
36 |
<hr>
|
|
|
37 |
|
|
|
38 |
|
|
|
39 |
<div id="elements">
|
|
|
40 |
<h3>Classes</h3>
|
|
|
41 |
<ul>
|
|
|
42 |
<li><a href="class-Bdd.html">Bdd</a></li>
|
|
|
43 |
<li><a href="class-Cache.html">Cache</a></li>
|
|
|
44 |
<li><a href="class-CacheSimple.html">CacheSimple</a></li>
|
|
|
45 |
<li><a href="class-Chronometre.html">Chronometre</a></li>
|
|
|
46 |
<li><a href="class-Cli.html">Cli</a></li>
|
|
|
47 |
<li><a href="class-Config.html">Config</a></li>
|
|
|
48 |
<li><a href="class-Controleur.html">Controleur</a></li>
|
|
|
49 |
<li><a href="class-Debug.html">Debug</a></li>
|
|
|
50 |
<li><a href="class-Framework.html">Framework</a></li>
|
|
|
51 |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
|
|
|
52 |
<li><a href="class-I18n.html">I18n</a></li>
|
|
|
53 |
<li><a href="class-Log.html">Log</a></li>
|
|
|
54 |
<li><a href="class-MonService.html">MonService</a></li>
|
|
|
55 |
<li><a href="class-Registre.html">Registre</a></li>
|
|
|
56 |
<li><a href="class-RestClient.html">RestClient</a></li>
|
|
|
57 |
<li><a href="class-RestServeur.html">RestServeur</a></li>
|
|
|
58 |
<li class="active"><a href="class-RestService.html">RestService</a></li>
|
|
|
59 |
<li><a href="class-Script.html">Script</a></li>
|
|
|
60 |
<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
|
|
|
61 |
<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
|
|
|
62 |
<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
|
|
|
63 |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
|
|
|
64 |
<li><a href="class-Url.html">Url</a></li>
|
|
|
65 |
</ul>
|
|
|
66 |
|
|
|
67 |
|
|
|
68 |
|
|
|
69 |
|
|
|
70 |
|
|
|
71 |
</div>
|
|
|
72 |
</div>
|
|
|
73 |
</div>
|
|
|
74 |
|
|
|
75 |
<div id="splitter"></div>
|
|
|
76 |
|
|
|
77 |
<div id="right">
|
|
|
78 |
<div id="rightInner">
|
|
|
79 |
<form id="search">
|
|
|
80 |
<input type="hidden" name="cx" value="">
|
|
|
81 |
<input type="hidden" name="ie" value="UTF-8">
|
|
|
82 |
<input type="text" name="q" class="text">
|
|
|
83 |
<input type="submit" value="Search">
|
|
|
84 |
</form>
|
|
|
85 |
|
|
|
86 |
<div id="navigation">
|
|
|
87 |
<ul>
|
|
|
88 |
<li>
|
|
|
89 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
90 |
</li>
|
|
|
91 |
<li>
|
|
|
92 |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
|
|
|
93 |
</li>
|
|
|
94 |
<li>
|
|
|
95 |
<a href="class-RestService.html" title="Summary of RestService"><span>Class</span></a>
|
|
|
96 |
</li>
|
|
|
97 |
</ul>
|
|
|
98 |
<ul>
|
|
|
99 |
<li>
|
|
|
100 |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
|
|
101 |
</li>
|
|
|
102 |
<li>
|
|
|
103 |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
|
|
|
104 |
</li>
|
|
|
105 |
<li>
|
|
|
106 |
<a href="todo.html" title="Todo list"><span>Todo</span></a>
|
|
|
107 |
</li>
|
|
|
108 |
</ul>
|
|
|
109 |
<ul>
|
|
|
110 |
</ul>
|
|
|
111 |
</div>
|
|
|
112 |
|
|
|
113 |
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
|
|
|
114 |
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
|
|
|
115 |
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Classe principale gérant les services.
|
|
|
116 |
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Paramètres liés dans config.ini :
|
|
|
117 |
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * - serveur.baseURL
|
|
|
118 |
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> *
|
|
|
119 |
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * Encodage en entrée : utf8
|
|
|
120 |
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * Encodage en sortie : utf8
|
|
|
121 |
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
|
|
|
122 |
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @category Php 5.2
|
|
|
123 |
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @package Framework
|
|
|
124 |
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
|
|
|
125 |
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @copyright Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
|
|
|
126 |
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
|
|
|
127 |
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
|
|
|
128 |
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @since 0.3
|
|
|
129 |
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * @version $Id: RestService.php 417 2012-05-15 09:24:12Z jpm $
|
|
|
130 |
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @link /doc/framework/
|
|
|
131 |
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> */</span>
|
|
|
132 |
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="RestService" href="#RestService">RestService</a> {
|
|
|
133 |
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a>
|
|
|
134 |
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a> <span class="php-comment">/** Objet de connection à la base de données.
|
|
|
135 |
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * @deprecated Utiliser la methode getBdd().
|
|
|
136 |
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * @see getBdd()
|
|
|
137 |
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> */</span>
|
|
|
138 |
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$bdd" href="#$bdd">$bdd</a></span> = <span class="php-keyword1">null</span>;
|
|
|
139 |
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>
|
|
|
140 |
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-comment">/** Objet Rest Client. */</span>
|
|
|
141 |
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$RestClient" href="#$RestClient">$RestClient</a></span> = <span class="php-keyword1">null</span>;
|
|
|
142 |
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
|
|
|
143 |
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> <span class="php-comment">/** Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes. */</span>
|
|
|
144 |
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$utilisationParametresBruts" href="#$utilisationParametresBruts">$utilisationParametresBruts</a></span> = <span class="php-keyword1">false</span>;
|
|
|
145 |
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a>
|
|
|
146 |
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$config</span>) {
|
|
|
147 |
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-var">$this</span>->config = <span class="php-var">$config</span>;
|
|
|
148 |
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-var">$this</span>->bdd = <span class="php-keyword1">new</span> Bdd();
|
|
|
149 |
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> }
|
|
|
150 |
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a>
|
|
|
151 |
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_initialiser" href="#_initialiser">initialiser</a>() {
|
|
|
152 |
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
|
|
|
153 |
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> }
|
|
|
154 |
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a>
|
|
|
155 |
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-comment">/**
|
|
|
156 |
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * Méthode de connection à la base de données sur demande.
|
|
|
157 |
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * Tous les services web n'ont pas besoin de s'y connecter.
|
|
|
158 |
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
|
|
|
159 |
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getBdd" href="#_getBdd">getBdd</a>() {
|
|
|
160 |
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-keyword1">if</span> (! <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->bdd)) {
|
|
|
161 |
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-var">$this</span>->bdd = <span class="php-keyword1">new</span> Bdd();
|
|
|
162 |
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> }
|
|
|
163 |
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->bdd;
|
|
|
164 |
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> }
|
|
|
165 |
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a>
|
|
|
166 |
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-comment">/**
|
|
|
167 |
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * Méthode permettant de faire appel à un client REST en fonction des besoins du service.
|
|
|
168 |
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> */</span>
|
|
|
169 |
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getRestClient" href="#_getRestClient">getRestClient</a>() {
|
|
|
170 |
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-keyword1">if</span> (! <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->RestClient)) {
|
|
|
171 |
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-var">$this</span>->RestClient = <span class="php-keyword1">new</span> RestClient();
|
|
|
172 |
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> }
|
|
|
173 |
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->RestClient;
|
|
|
174 |
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> }
|
|
|
175 |
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a>
|
|
|
176 |
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-comment">/**
|
|
|
177 |
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * Méthode permettant de savoir si le service veut utiliser des paramètres bruts (issu de la QueryString)
|
|
|
178 |
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * ou pas (issu de $_GET).
|
|
|
179 |
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> */</span>
|
|
|
180 |
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_utiliserParametresBruts" href="#_utiliserParametresBruts">utiliserParametresBruts</a>() {
|
|
|
181 |
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->utilisationParametresBruts;
|
|
|
182 |
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> }
|
|
|
183 |
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a>
|
|
|
184 |
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-comment">/**
|
|
|
185 |
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
|
|
|
186 |
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * Le message doit être au format texte et en UTF-8.
|
|
|
187 |
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @param string $message le message à envoyer.
|
|
|
188 |
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> */</span>
|
|
|
189 |
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_ajouterMessage" href="#_ajouterMessage">ajouterMessage</a>(<span class="php-var">$message</span>) {
|
|
|
190 |
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> RestServeur::ajouterMessage(<span class="php-var">$message</span>);
|
|
|
191 |
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> }
|
|
|
192 |
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
|
|
|
193 |
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-comment">/**
|
|
|
194 |
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * Méthode appelée lors d'une requête HTTP de type GET.
|
|
|
195 |
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> *
|
|
|
196 |
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,
|
|
|
197 |
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * la méthode devra retourner le code statut HTTP adéquate.
|
|
|
198 |
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> *
|
|
|
199 |
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
|
|
|
200 |
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * @param array Partie de l'url situé après le '?' servant à paramétrer le service demandé.
|
|
|
201 |
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * @return string une chaine indiquant le succès de l'opération et les données demandées.
|
|
|
202 |
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> */</span>
|
|
|
203 |
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_consulter" href="#_consulter">consulter</a>(<span class="php-var">$ressources</span>, <span class="php-var">$parametres</span>) {
|
|
|
204 |
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
|
|
|
205 |
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> RestServeur::ajouterMessage(<span class="php-quote">"Le service '"</span>.<span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>).<span class="php-quote">"' n'autorise pas la consultation."</span>);
|
|
|
206 |
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> }
|
|
|
207 |
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
|
|
|
208 |
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-comment">/**
|
|
|
209 |
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * Méthode appelée lors d'une requête HTTP de type POST.
|
|
|
210 |
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> *
|
|
|
211 |
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps
|
|
|
212 |
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * de la requête.
|
|
|
213 |
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.
|
|
|
214 |
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> *
|
|
|
215 |
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
|
|
|
216 |
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @param array les données transférées dans le corps de la requête devant servir à la modification.
|
|
|
217 |
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * @return mixed une chaine indiquant le succès de l'opération ou rien.
|
|
|
218 |
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> */</span>
|
|
|
219 |
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_modifier" href="#_modifier">modifier</a>(<span class="php-var">$ressources</span>, <span class="php-var">$requeteDonnees</span>) {
|
|
|
220 |
</span><span id="108" class="l"><a class="l" href="#108">108: </a> RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
|
|
|
221 |
</span><span id="109" class="l"><a class="l" href="#109">109: </a> RestServeur::ajouterMessage(<span class="php-quote">"Le service '"</span>.<span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>).<span class="php-quote">"' n'autorise pas la modification."</span>);
|
|
|
222 |
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">false</span>;
|
|
|
223 |
</span><span id="111" class="l"><a class="l" href="#111">111: </a> }
|
|
|
224 |
</span><span id="112" class="l"><a class="l" href="#112">112: </a>
|
|
|
225 |
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-comment">/**
|
|
|
226 |
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * Méthode appelée lors d'une requête HTTP de type PUT.
|
|
|
227 |
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> *
|
|
|
228 |
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par
|
|
|
229 |
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
|
|
|
230 |
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
|
|
|
231 |
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * Le code statut HTTP retourné sera 201 en cas de succès.
|
|
|
232 |
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * Dans le cas contraire, la méthode devra retourner false.
|
|
|
233 |
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> *
|
|
|
234 |
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
|
|
|
235 |
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * @param array les données transférées dans le corps de la requête devant servir à l'ajout.
|
|
|
236 |
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * @return string l'identifiant créé.
|
|
|
237 |
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> */</span>
|
|
|
238 |
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_ajouter" href="#_ajouter">ajouter</a>(<span class="php-var">$ressources</span>, <span class="php-var">$requeteDonnees</span>) {
|
|
|
239 |
</span><span id="127" class="l"><a class="l" href="#127">127: </a> RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
|
|
|
240 |
</span><span id="128" class="l"><a class="l" href="#128">128: </a> RestServeur::ajouterMessage(<span class="php-quote">"Le service '"</span>.<span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>).<span class="php-quote">"' n'autorise pas la création."</span>);
|
|
|
241 |
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">false</span>;
|
|
|
242 |
</span><span id="130" class="l"><a class="l" href="#130">130: </a> }
|
|
|
243 |
</span><span id="131" class="l"><a class="l" href="#131">131: </a>
|
|
|
244 |
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-comment">/**
|
|
|
245 |
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).
|
|
|
246 |
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> *
|
|
|
247 |
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par
|
|
|
248 |
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * RestServeur sera 204.
|
|
|
249 |
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP
|
|
|
250 |
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * retourné par RestServeur sera 404.
|
|
|
251 |
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner
|
|
|
252 |
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * la valeur null ou rien.
|
|
|
253 |
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> *
|
|
|
254 |
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * @param array Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
|
|
|
255 |
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * @return mixed une chaine indiquant le succès de l'opération ou rien.
|
|
|
256 |
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> */</span>
|
|
|
257 |
</span><span id="145" class="l"><a class="l" href="#145">145: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_supprimer" href="#_supprimer">supprimer</a>(<span class="php-var">$ressources</span>) {
|
|
|
258 |
</span><span id="146" class="l"><a class="l" href="#146">146: </a> RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_METHODE_NON_AUTORISE);
|
|
|
259 |
</span><span id="147" class="l"><a class="l" href="#147">147: </a> RestServeur::ajouterMessage(<span class="php-quote">"Le service '"</span>.<span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>).<span class="php-quote">"' n'autorise pas la suppression."</span>);
|
|
|
260 |
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
|
|
|
261 |
</span><span id="149" class="l"><a class="l" href="#149">149: </a> }
|
|
|
262 |
</span><span id="150" class="l"><a class="l" href="#150">150: </a>}
|
|
|
263 |
</span><span id="151" class="l"><a class="l" href="#151">151: </a></span><span class="xlang">?></span></code></pre>
|
|
|
264 |
|
|
|
265 |
<div id="footer">
|
|
|
266 |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
|
267 |
</div>
|
|
|
268 |
</div>
|
|
|
269 |
</div>
|
|
|
270 |
</body>
|
|
|
271 |
</html>
|