| 464 |
jpm |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html lang="en">
|
|
|
3 |
<head>
|
|
|
4 |
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
|
5 |
<meta charset="utf-8"/>
|
|
|
6 |
<title>TBFramework - v0.4</title>
|
|
|
7 |
<meta name="author" content=""/>
|
|
|
8 |
<meta name="description" content=""/>
|
|
|
9 |
|
|
|
10 |
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
|
|
11 |
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
|
|
|
12 |
<link href="../css/prism.css" rel="stylesheet" media="all"/>
|
|
|
13 |
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
|
|
14 |
|
|
|
15 |
<!--[if lt IE 9]>
|
|
|
16 |
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
|
17 |
<![endif]-->
|
|
|
18 |
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
|
|
|
19 |
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
|
|
|
20 |
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
|
|
|
21 |
<script src="../js/jquery.smooth-scroll.js"></script>
|
|
|
22 |
<script src="../js/prism.min.js"></script>
|
|
|
23 |
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
|
|
24 |
<script type="text/javascript">
|
|
|
25 |
function loadExternalCodeSnippets() {
|
|
|
26 |
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
|
|
|
27 |
var src = pre.getAttribute('data-src');
|
|
|
28 |
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
|
29 |
var language = 'php';
|
|
|
30 |
|
|
|
31 |
var code = document.createElement('code');
|
|
|
32 |
code.className = 'language-' + language;
|
|
|
33 |
|
|
|
34 |
pre.textContent = '';
|
|
|
35 |
|
|
|
36 |
code.textContent = 'Loading…';
|
|
|
37 |
|
|
|
38 |
pre.appendChild(code);
|
|
|
39 |
|
|
|
40 |
var xhr = new XMLHttpRequest();
|
|
|
41 |
|
|
|
42 |
xhr.open('GET', src, true);
|
|
|
43 |
|
|
|
44 |
xhr.onreadystatechange = function () {
|
|
|
45 |
if (xhr.readyState == 4) {
|
|
|
46 |
|
|
|
47 |
if (xhr.status < 400 && xhr.responseText) {
|
|
|
48 |
code.textContent = xhr.responseText;
|
|
|
49 |
|
|
|
50 |
Prism.highlightElement(code);
|
|
|
51 |
}
|
|
|
52 |
else if (xhr.status >= 400) {
|
|
|
53 |
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
54 |
}
|
|
|
55 |
else {
|
|
|
56 |
code.textContent = '✖ Error: File does not exist or is empty';
|
|
|
57 |
}
|
|
|
58 |
}
|
|
|
59 |
};
|
|
|
60 |
|
|
|
61 |
xhr.send(null);
|
|
|
62 |
});
|
|
|
63 |
}
|
|
|
64 |
|
|
|
65 |
$(document).ready(function(){
|
|
|
66 |
loadExternalCodeSnippets();
|
|
|
67 |
});
|
|
|
68 |
$('#source-view').on('shown', function () {
|
|
|
69 |
loadExternalCodeSnippets();
|
|
|
70 |
})
|
|
|
71 |
</script>
|
|
|
72 |
|
|
|
73 |
<link rel="shortcut icon" href="../images/favicon.ico"/>
|
|
|
74 |
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
|
|
|
75 |
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
|
|
|
76 |
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
|
|
|
77 |
</head>
|
|
|
78 |
<body>
|
|
|
79 |
|
|
|
80 |
<div class="navbar navbar-fixed-top">
|
|
|
81 |
<div class="navbar-inner">
|
|
|
82 |
<div class="container">
|
|
|
83 |
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
|
84 |
<i class="icon-ellipsis-vertical"></i>
|
|
|
85 |
</a>
|
|
|
86 |
<a class="brand" href="../index.html">TBFramework - v0.4</a>
|
|
|
87 |
|
|
|
88 |
<div class="nav-collapse">
|
|
|
89 |
<ul class="nav pull-right">
|
|
|
90 |
<li class="dropdown">
|
|
|
91 |
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
92 |
API Documentation <b class="caret"></b>
|
|
|
93 |
</a>
|
|
|
94 |
<ul class="dropdown-menu">
|
|
|
95 |
</ul>
|
|
|
96 |
</li>
|
|
|
97 |
<li class="dropdown" id="charts-menu">
|
|
|
98 |
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
99 |
Charts <b class="caret"></b>
|
|
|
100 |
</a>
|
|
|
101 |
<ul class="dropdown-menu">
|
|
|
102 |
<li>
|
|
|
103 |
<a href="../graphs/class.html">
|
|
|
104 |
<i class="icon-list-alt"></i> Class hierarchy diagram
|
|
|
105 |
</a>
|
|
|
106 |
</li>
|
|
|
107 |
</ul>
|
|
|
108 |
</li>
|
|
|
109 |
<li class="dropdown" id="reports-menu">
|
|
|
110 |
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
111 |
Reports <b class="caret"></b>
|
|
|
112 |
</a>
|
|
|
113 |
<ul class="dropdown-menu">
|
|
|
114 |
<li>
|
|
|
115 |
<a href="../reports/errors.html">
|
|
|
116 |
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">281</span>
|
|
|
117 |
</a>
|
|
|
118 |
</li>
|
|
|
119 |
<li>
|
|
|
120 |
<a href="../reports/markers.html">
|
|
|
121 |
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">12</span>
|
|
|
122 |
</a>
|
|
|
123 |
</li>
|
|
|
124 |
</ul>
|
|
|
125 |
</li>
|
|
|
126 |
</ul>
|
|
|
127 |
</div>
|
|
|
128 |
</div>
|
|
|
129 |
</div>
|
|
|
130 |
<!--<div class="go_to_top">-->
|
|
|
131 |
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
|
|
|
132 |
<!--</div>-->
|
|
|
133 |
</div>
|
|
|
134 |
|
|
|
135 |
<div id="___" class="container-fluid">
|
|
|
136 |
<section class="row-fluid">
|
|
|
137 |
<div class="span2 sidebar">
|
|
|
138 |
<div class="accordion" style="margin-bottom: 0">
|
|
|
139 |
<div class="accordion-group">
|
|
|
140 |
<div class="accordion-heading">
|
|
|
141 |
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1211737728"></a>
|
|
|
142 |
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
|
|
143 |
</div>
|
|
|
144 |
<div id="namespace-1211737728" class="accordion-body collapse in">
|
|
|
145 |
<div class="accordion-inner">
|
|
|
146 |
|
|
|
147 |
|
|
|
148 |
<ul>
|
|
|
149 |
<li class="class"><a href="../classes/Url.html">Url</a></li>
|
|
|
150 |
<li class="class"><a href="../classes/Debug.html">Debug</a></li>
|
|
|
151 |
<li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li>
|
|
|
152 |
<li class="class"><a href="../classes/RestServeur.html">RestServeur</a></li>
|
|
|
153 |
<li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li>
|
|
|
154 |
<li class="class"><a href="../classes/Controleur.html">Controleur</a></li>
|
|
|
155 |
<li class="class"><a href="../classes/Cache.html">Cache</a></li>
|
|
|
156 |
<li class="class"><a href="../classes/RestClient.html">RestClient</a></li>
|
|
|
157 |
<li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li>
|
|
|
158 |
<li class="class"><a href="../classes/Script.html">Script</a></li>
|
|
|
159 |
<li class="class"><a href="../classes/Registre.html">Registre</a></li>
|
|
|
160 |
<li class="class"><a href="../classes/RestService.html">RestService</a></li>
|
|
|
161 |
<li class="class"><a href="../classes/Cli.html">Cli</a></li>
|
|
|
162 |
<li class="class"><a href="../classes/Encodage.html">Encodage</a></li>
|
|
|
163 |
<li class="class"><a href="../classes/Tableau.html">Tableau</a></li>
|
|
|
164 |
<li class="class"><a href="../classes/Pattern.html">Pattern</a></li>
|
|
|
165 |
<li class="class"><a href="../classes/Chaine.html">Chaine</a></li>
|
|
|
166 |
<li class="class"><a href="../classes/Fichier.html">Fichier</a></li>
|
|
|
167 |
<li class="class"><a href="../classes/I18n.html">I18n</a></li>
|
|
|
168 |
<li class="class"><a href="../classes/Config.html">Config</a></li>
|
|
|
169 |
<li class="class"><a href="../classes/CacheSqlite.html">CacheSqlite</a></li>
|
|
|
170 |
<li class="class"><a href="../classes/Bdd.html">Bdd</a></li>
|
|
|
171 |
<li class="class"><a href="../classes/Log.html">Log</a></li>
|
|
|
172 |
<li class="class"><a href="../classes/CacheFichier.html">CacheFichier</a></li>
|
|
|
173 |
<li class="class"><a href="../classes/Framework.html">Framework</a></li>
|
|
|
174 |
<li class="class"><a href="../classes/CacheSimple.html">CacheSimple</a></li>
|
|
|
175 |
</ul>
|
|
|
176 |
</div>
|
|
|
177 |
</div>
|
|
|
178 |
</div>
|
|
|
179 |
</div>
|
|
|
180 |
|
|
|
181 |
</div>
|
|
|
182 |
</section>
|
|
|
183 |
<section class="row-fluid">
|
|
|
184 |
<div class="span10 offset2">
|
|
|
185 |
<div class="row-fluid">
|
|
|
186 |
<div class="span8 content class">
|
|
|
187 |
<nav>
|
|
|
188 |
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
|
|
|
189 |
</nav>
|
|
|
190 |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
|
|
191 |
|
|
|
192 |
<h1><small>\</small>RestService</h1>
|
|
|
193 |
<p><em>Classe principale gérant les services.</em></p>
|
|
|
194 |
<p>Paramètres liés dans config.ini :</p>
|
|
|
195 |
<ul>
|
|
|
196 |
<li>serveur.baseURL</li>
|
|
|
197 |
</ul>
|
|
|
198 |
<p>Encodage en entrée : utf8
|
|
|
199 |
Encodage en sortie : utf8</p>
|
|
|
200 |
|
|
|
201 |
<section id="summary">
|
|
|
202 |
<h2>Summary</h2>
|
|
|
203 |
<section class="row-fluid heading">
|
|
|
204 |
<section class="span4">
|
|
|
205 |
<a href="#methods">Methods</a>
|
|
|
206 |
</section>
|
|
|
207 |
<section class="span4">
|
|
|
208 |
<a href="#properties">Properties</a>
|
|
|
209 |
</section>
|
|
|
210 |
<section class="span4">
|
|
|
211 |
<a href="#constants">Constants</a>
|
|
|
212 |
</section>
|
|
|
213 |
</section>
|
|
|
214 |
<section class="row-fluid public">
|
|
|
215 |
<section class="span4">
|
|
|
216 |
<a href="../classes/RestService.html#method___construct" class="">__construct()</a><br />
|
|
|
217 |
<a href="../classes/RestService.html#method_initialiser" class="">initialiser()</a><br />
|
|
|
218 |
<a href="../classes/RestService.html#method_utiliserParametresBruts" class="">utiliserParametresBruts()</a><br />
|
|
|
219 |
<a href="../classes/RestService.html#method_consulter" class="">consulter()</a><br />
|
|
|
220 |
<a href="../classes/RestService.html#method_modifier" class="">modifier()</a><br />
|
|
|
221 |
<a href="../classes/RestService.html#method_ajouter" class="">ajouter()</a><br />
|
|
|
222 |
<a href="../classes/RestService.html#method_supprimer" class="">supprimer()</a><br />
|
|
|
223 |
</section>
|
|
|
224 |
<section class="span4">
|
|
|
225 |
<em>No public properties found</em>
|
|
|
226 |
</section>
|
|
|
227 |
<section class="span4">
|
|
|
228 |
<em>No constants found</em>
|
|
|
229 |
</section>
|
|
|
230 |
</section>
|
|
|
231 |
<section class="row-fluid protected">
|
|
|
232 |
<section class="span4">
|
|
|
233 |
<a href="../classes/RestService.html#method_getBdd" class="">getBdd()</a><br />
|
|
|
234 |
<a href="../classes/RestService.html#method_getRestClient" class="">getRestClient()</a><br />
|
|
|
235 |
<a href="../classes/RestService.html#method_ajouterMessage" class="">ajouterMessage()</a><br />
|
|
|
236 |
</section>
|
|
|
237 |
<section class="span4">
|
|
|
238 |
<a href="../classes/RestService.html#property_bdd" class="deprecated">$bdd</a><br />
|
|
|
239 |
<a href="../classes/RestService.html#property_utilisationParametresBruts" class="">$utilisationParametresBruts</a><br />
|
|
|
240 |
</section>
|
|
|
241 |
<section class="span4">
|
|
|
242 |
<em>N/A</em>
|
|
|
243 |
</section>
|
|
|
244 |
</section>
|
|
|
245 |
<section class="row-fluid private">
|
|
|
246 |
<section class="span4">
|
|
|
247 |
<em>No private methods found</em>
|
|
|
248 |
</section>
|
|
|
249 |
<section class="span4">
|
|
|
250 |
<a href="../classes/RestService.html#property_RestClient" class="">$RestClient</a><br />
|
|
|
251 |
</section>
|
|
|
252 |
<section class="span4">
|
|
|
253 |
<em>N/A</em>
|
|
|
254 |
</section>
|
|
|
255 |
</section>
|
|
|
256 |
</section>
|
|
|
257 |
</div>
|
|
|
258 |
<aside class="span4 detailsbar">
|
|
|
259 |
<span class="label label-info">abstract</span>
|
|
|
260 |
|
|
|
261 |
|
|
|
262 |
<dl>
|
|
|
263 |
<dt>File</dt>
|
|
|
264 |
<dd><a href="../files/RestService.php.html"><div class="path-wrapper">RestService.php</div></a></dd>
|
|
|
265 |
<dt>Package</dt>
|
|
|
266 |
<dd><div class="namespace-wrapper">\Framework</div></dd>
|
|
|
267 |
<dt>Class hierarchy</dt>
|
|
|
268 |
<dd class="hierarchy">
|
|
|
269 |
<div class="namespace-wrapper">\RestService</div>
|
|
|
270 |
</dd>
|
|
|
271 |
|
|
|
272 |
|
|
|
273 |
|
|
|
274 |
|
|
|
275 |
<dt>See also</dt>
|
|
|
276 |
<dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd>
|
|
|
277 |
|
|
|
278 |
</dl>
|
|
|
279 |
<h2>Tags</h2>
|
|
|
280 |
<table class="table table-condensed">
|
|
|
281 |
<tr>
|
|
|
282 |
<th>
|
|
|
283 |
category
|
|
|
284 |
</th>
|
|
|
285 |
<td>
|
|
|
286 |
<p>Php 5.2</p>
|
|
|
287 |
</td>
|
|
|
288 |
</tr>
|
|
|
289 |
<tr>
|
|
|
290 |
<th>
|
|
|
291 |
author
|
|
|
292 |
</th>
|
|
|
293 |
<td>
|
|
|
294 |
<p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p>
|
|
|
295 |
</td>
|
|
|
296 |
</tr>
|
|
|
297 |
<tr>
|
|
|
298 |
<th>
|
|
|
299 |
copyright
|
|
|
300 |
</th>
|
|
|
301 |
<td>
|
|
|
302 |
<p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p>
|
|
|
303 |
</td>
|
|
|
304 |
</tr>
|
|
|
305 |
<tr>
|
|
|
306 |
<th>
|
|
|
307 |
license
|
|
|
308 |
</th>
|
|
|
309 |
<td>
|
|
|
310 |
<p>GPL v3 <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></p>
|
|
|
311 |
<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>
|
|
|
312 |
</td>
|
|
|
313 |
</tr>
|
|
|
314 |
<tr>
|
|
|
315 |
<th>
|
|
|
316 |
since
|
|
|
317 |
</th>
|
|
|
318 |
<td>
|
|
|
319 |
|
|
|
320 |
</td>
|
|
|
321 |
</tr>
|
|
|
322 |
<tr>
|
|
|
323 |
<th>
|
|
|
324 |
version
|
|
|
325 |
</th>
|
|
|
326 |
<td>
|
|
|
327 |
<p>$Id: RestService.php 417 2012-05-15 09:24:12Z jpm $</p>
|
|
|
328 |
</td>
|
|
|
329 |
</tr>
|
|
|
330 |
<tr>
|
|
|
331 |
<th>
|
|
|
332 |
todo
|
|
|
333 |
</th>
|
|
|
334 |
<td>
|
|
|
335 |
</td>
|
|
|
336 |
</tr>
|
|
|
337 |
</table>
|
|
|
338 |
</aside>
|
|
|
339 |
</div>
|
|
|
340 |
|
|
|
341 |
|
|
|
342 |
<a id="properties" name="properties"></a>
|
|
|
343 |
<div class="row-fluid">
|
|
|
344 |
<div class="span8 content class">
|
|
|
345 |
<h2>Properties</h2>
|
|
|
346 |
</div>
|
|
|
347 |
<aside class="span4 detailsbar"></aside>
|
|
|
348 |
</div>
|
|
|
349 |
|
|
|
350 |
<div class="row-fluid">
|
|
|
351 |
<div class="span8 content class">
|
|
|
352 |
<a id="property_bdd" name="property_bdd" class="anchor"></a>
|
|
|
353 |
<article class="property">
|
|
|
354 |
<h3 class="protected deprecated">$bdd</h3>
|
|
|
355 |
<pre class="signature">$bdd</pre>
|
|
|
356 |
<p><em>Objet de connection à la base de données.</em></p>
|
|
|
357 |
|
|
|
358 |
|
|
|
359 |
</article>
|
|
|
360 |
</div>
|
|
|
361 |
<aside class="span4 detailsbar">
|
|
|
362 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
363 |
<aside class="alert alert-block alert-error">
|
|
|
364 |
<h4>Deprecated</h4>
|
|
|
365 |
Utiliser la methode getBdd().
|
|
|
366 |
</aside>
|
|
|
367 |
<dl>
|
|
|
368 |
<dt>See also</dt>
|
|
|
369 |
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
|
|
|
370 |
</dl>
|
|
|
371 |
<h2>Tags</h2>
|
|
|
372 |
<table class="table table-condensed">
|
|
|
373 |
<tr>
|
|
|
374 |
<th>
|
|
|
375 |
todo
|
|
|
376 |
</th>
|
|
|
377 |
<td>
|
|
|
378 |
</td>
|
|
|
379 |
</tr>
|
|
|
380 |
</table>
|
|
|
381 |
</aside>
|
|
|
382 |
</div>
|
|
|
383 |
|
|
|
384 |
<div class="row-fluid">
|
|
|
385 |
<div class="span8 content class">
|
|
|
386 |
<a id="property_utilisationParametresBruts" name="property_utilisationParametresBruts" class="anchor"></a>
|
|
|
387 |
<article class="property">
|
|
|
388 |
<h3 class="protected ">$utilisationParametresBruts</h3>
|
|
|
389 |
<pre class="signature">$utilisationParametresBruts</pre>
|
|
|
390 |
<p><em>Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes.</em></p>
|
|
|
391 |
|
|
|
392 |
|
|
|
393 |
</article>
|
|
|
394 |
</div>
|
|
|
395 |
<aside class="span4 detailsbar">
|
|
|
396 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
397 |
<dl>
|
|
|
398 |
</dl>
|
|
|
399 |
<h2>Tags</h2>
|
|
|
400 |
<table class="table table-condensed">
|
|
|
401 |
<tr>
|
|
|
402 |
<th>
|
|
|
403 |
todo
|
|
|
404 |
</th>
|
|
|
405 |
<td>
|
|
|
406 |
</td>
|
|
|
407 |
</tr>
|
|
|
408 |
</table>
|
|
|
409 |
</aside>
|
|
|
410 |
</div>
|
|
|
411 |
|
|
|
412 |
<div class="row-fluid">
|
|
|
413 |
<div class="span8 content class">
|
|
|
414 |
<a id="property_RestClient" name="property_RestClient" class="anchor"></a>
|
|
|
415 |
<article class="property">
|
|
|
416 |
<h3 class="private ">$RestClient</h3>
|
|
|
417 |
<pre class="signature">$RestClient</pre>
|
|
|
418 |
<p><em>Objet Rest Client.</em></p>
|
|
|
419 |
|
|
|
420 |
|
|
|
421 |
</article>
|
|
|
422 |
</div>
|
|
|
423 |
<aside class="span4 detailsbar">
|
|
|
424 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
425 |
<dl>
|
|
|
426 |
</dl>
|
|
|
427 |
<h2>Tags</h2>
|
|
|
428 |
<table class="table table-condensed">
|
|
|
429 |
<tr>
|
|
|
430 |
<th>
|
|
|
431 |
todo
|
|
|
432 |
</th>
|
|
|
433 |
<td>
|
|
|
434 |
</td>
|
|
|
435 |
</tr>
|
|
|
436 |
</table>
|
|
|
437 |
</aside>
|
|
|
438 |
</div>
|
|
|
439 |
|
|
|
440 |
|
|
|
441 |
<a id="methods" name="methods"></a>
|
|
|
442 |
<div class="row-fluid">
|
|
|
443 |
<div class="span8 content class"><h2>Methods</h2></div>
|
|
|
444 |
<aside class="span4 detailsbar"></aside>
|
|
|
445 |
</div>
|
|
|
446 |
|
|
|
447 |
<div class="row-fluid">
|
|
|
448 |
<div class="span8 content class">
|
|
|
449 |
<a id="method___construct" name="method___construct" class="anchor"></a>
|
|
|
450 |
<article class="method">
|
|
|
451 |
<h3 class="public ">__construct()</h3>
|
|
|
452 |
<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>
|
|
|
453 |
<pre class="signature" style="margin-right: 54px;">__construct( <span class="argument">$config</span>)</pre>
|
|
|
454 |
<p><em></em></p>
|
|
|
455 |
|
|
|
456 |
|
|
|
457 |
<h4>Parameters</h4>
|
|
|
458 |
<table class="table table-condensed table-hover">
|
|
|
459 |
<tr>
|
|
|
460 |
<td></td>
|
|
|
461 |
<td>$config</td>
|
|
|
462 |
<td></td>
|
|
|
463 |
</tr>
|
|
|
464 |
</table>
|
|
|
465 |
|
|
|
466 |
|
|
|
467 |
</article>
|
|
|
468 |
</div>
|
|
|
469 |
<aside class="span4 detailsbar">
|
|
|
470 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
471 |
<dl>
|
|
|
472 |
</dl>
|
|
|
473 |
<h2>Tags</h2>
|
|
|
474 |
<table class="table table-condensed">
|
|
|
475 |
<tr>
|
|
|
476 |
<th>
|
|
|
477 |
todo
|
|
|
478 |
</th>
|
|
|
479 |
<td>
|
|
|
480 |
</td>
|
|
|
481 |
</tr>
|
|
|
482 |
</table>
|
|
|
483 |
</aside>
|
|
|
484 |
</div>
|
|
|
485 |
|
|
|
486 |
<div class="row-fluid">
|
|
|
487 |
<div class="span8 content class">
|
|
|
488 |
<a id="method_initialiser" name="method_initialiser" class="anchor"></a>
|
|
|
489 |
<article class="method">
|
|
|
490 |
<h3 class="public ">initialiser()</h3>
|
|
|
491 |
<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>
|
|
|
492 |
<pre class="signature" style="margin-right: 54px;">initialiser()</pre>
|
|
|
493 |
<p><em></em></p>
|
|
|
494 |
|
|
|
495 |
|
|
|
496 |
|
|
|
497 |
|
|
|
498 |
</article>
|
|
|
499 |
</div>
|
|
|
500 |
<aside class="span4 detailsbar">
|
|
|
501 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
502 |
<dl>
|
|
|
503 |
</dl>
|
|
|
504 |
<h2>Tags</h2>
|
|
|
505 |
<table class="table table-condensed">
|
|
|
506 |
<tr>
|
|
|
507 |
<th>
|
|
|
508 |
todo
|
|
|
509 |
</th>
|
|
|
510 |
<td>
|
|
|
511 |
</td>
|
|
|
512 |
</tr>
|
|
|
513 |
</table>
|
|
|
514 |
</aside>
|
|
|
515 |
</div>
|
|
|
516 |
|
|
|
517 |
<div class="row-fluid">
|
|
|
518 |
<div class="span8 content class">
|
|
|
519 |
<a id="method_utiliserParametresBruts" name="method_utiliserParametresBruts" class="anchor"></a>
|
|
|
520 |
<article class="method">
|
|
|
521 |
<h3 class="public ">utiliserParametresBruts()</h3>
|
|
|
522 |
<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>
|
|
|
523 |
<pre class="signature" style="margin-right: 54px;">utiliserParametresBruts()</pre>
|
|
|
524 |
<p><em>Méthode permettant de savoir si le service veut utiliser des paramètres bruts (issu de la QueryString)
|
|
|
525 |
ou pas (issu de $_GET).</em></p>
|
|
|
526 |
|
|
|
527 |
|
|
|
528 |
|
|
|
529 |
|
|
|
530 |
</article>
|
|
|
531 |
</div>
|
|
|
532 |
<aside class="span4 detailsbar">
|
|
|
533 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
534 |
<dl>
|
|
|
535 |
</dl>
|
|
|
536 |
<h2>Tags</h2>
|
|
|
537 |
<table class="table table-condensed">
|
|
|
538 |
<tr>
|
|
|
539 |
<th>
|
|
|
540 |
todo
|
|
|
541 |
</th>
|
|
|
542 |
<td>
|
|
|
543 |
</td>
|
|
|
544 |
</tr>
|
|
|
545 |
</table>
|
|
|
546 |
</aside>
|
|
|
547 |
</div>
|
|
|
548 |
|
|
|
549 |
<div class="row-fluid">
|
|
|
550 |
<div class="span8 content class">
|
|
|
551 |
<a id="method_consulter" name="method_consulter" class="anchor"></a>
|
|
|
552 |
<article class="method">
|
|
|
553 |
<h3 class="public ">consulter()</h3>
|
|
|
554 |
<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>
|
|
|
555 |
<pre class="signature" style="margin-right: 54px;">consulter( <span class="argument">$ressources</span>, <span class="argument">$parametres</span>) : string</pre>
|
|
|
556 |
<p><em>Méthode appelée lors d'une requête HTTP de type GET.</em></p>
|
|
|
557 |
<p>Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas,
|
|
|
558 |
la méthode devra retourner le code statut HTTP adéquate.</p>
|
|
|
559 |
|
|
|
560 |
<h4>Parameters</h4>
|
|
|
561 |
<table class="table table-condensed table-hover">
|
|
|
562 |
<tr>
|
|
|
563 |
<td></td>
|
|
|
564 |
<td>$ressources</td>
|
|
|
565 |
<td></td>
|
|
|
566 |
</tr>
|
|
|
567 |
<tr>
|
|
|
568 |
<td></td>
|
|
|
569 |
<td>$parametres</td>
|
|
|
570 |
<td></td>
|
|
|
571 |
</tr>
|
|
|
572 |
</table>
|
|
|
573 |
|
|
|
574 |
|
|
|
575 |
<h4>Returns</h4>
|
|
|
576 |
string
|
|
|
577 |
— <p>une chaine indiquant le succès de l'opération et les données demandées.</p>
|
|
|
578 |
</article>
|
|
|
579 |
</div>
|
|
|
580 |
<aside class="span4 detailsbar">
|
|
|
581 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
582 |
<dl>
|
|
|
583 |
</dl>
|
|
|
584 |
<h2>Tags</h2>
|
|
|
585 |
<table class="table table-condensed">
|
|
|
586 |
<tr>
|
|
|
587 |
<th>
|
|
|
588 |
todo
|
|
|
589 |
</th>
|
|
|
590 |
<td>
|
|
|
591 |
</td>
|
|
|
592 |
</tr>
|
|
|
593 |
</table>
|
|
|
594 |
</aside>
|
|
|
595 |
</div>
|
|
|
596 |
|
|
|
597 |
<div class="row-fluid">
|
|
|
598 |
<div class="span8 content class">
|
|
|
599 |
<a id="method_modifier" name="method_modifier" class="anchor"></a>
|
|
|
600 |
<article class="method">
|
|
|
601 |
<h3 class="public ">modifier()</h3>
|
|
|
602 |
<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>
|
|
|
603 |
<pre class="signature" style="margin-right: 54px;">modifier( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : mixed</pre>
|
|
|
604 |
<p><em>Méthode appelée lors d'une requête HTTP de type POST.</em></p>
|
|
|
605 |
<p>La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps
|
|
|
606 |
de la requête.
|
|
|
607 |
Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.</p>
|
|
|
608 |
|
|
|
609 |
<h4>Parameters</h4>
|
|
|
610 |
<table class="table table-condensed table-hover">
|
|
|
611 |
<tr>
|
|
|
612 |
<td></td>
|
|
|
613 |
<td>$ressources</td>
|
|
|
614 |
<td></td>
|
|
|
615 |
</tr>
|
|
|
616 |
<tr>
|
|
|
617 |
<td></td>
|
|
|
618 |
<td>$requeteDonnees</td>
|
|
|
619 |
<td></td>
|
|
|
620 |
</tr>
|
|
|
621 |
</table>
|
|
|
622 |
|
|
|
623 |
|
|
|
624 |
<h4>Returns</h4>
|
|
|
625 |
mixed
|
|
|
626 |
— <p>une chaine indiquant le succès de l'opération ou rien.</p>
|
|
|
627 |
</article>
|
|
|
628 |
</div>
|
|
|
629 |
<aside class="span4 detailsbar">
|
|
|
630 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
631 |
<dl>
|
|
|
632 |
</dl>
|
|
|
633 |
<h2>Tags</h2>
|
|
|
634 |
<table class="table table-condensed">
|
|
|
635 |
<tr>
|
|
|
636 |
<th>
|
|
|
637 |
todo
|
|
|
638 |
</th>
|
|
|
639 |
<td>
|
|
|
640 |
</td>
|
|
|
641 |
</tr>
|
|
|
642 |
</table>
|
|
|
643 |
</aside>
|
|
|
644 |
</div>
|
|
|
645 |
|
|
|
646 |
<div class="row-fluid">
|
|
|
647 |
<div class="span8 content class">
|
|
|
648 |
<a id="method_ajouter" name="method_ajouter" class="anchor"></a>
|
|
|
649 |
<article class="method">
|
|
|
650 |
<h3 class="public ">ajouter()</h3>
|
|
|
651 |
<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>
|
|
|
652 |
<pre class="signature" style="margin-right: 54px;">ajouter( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : string</pre>
|
|
|
653 |
<p><em>Méthode appelée lors d'une requête HTTP de type PUT.</em></p>
|
|
|
654 |
<p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par
|
|
|
655 |
le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.
|
|
|
656 |
Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant.
|
|
|
657 |
Le code statut HTTP retourné sera 201 en cas de succès.
|
|
|
658 |
Dans le cas contraire, la méthode devra retourner false.</p>
|
|
|
659 |
|
|
|
660 |
<h4>Parameters</h4>
|
|
|
661 |
<table class="table table-condensed table-hover">
|
|
|
662 |
<tr>
|
|
|
663 |
<td></td>
|
|
|
664 |
<td>$ressources</td>
|
|
|
665 |
<td></td>
|
|
|
666 |
</tr>
|
|
|
667 |
<tr>
|
|
|
668 |
<td></td>
|
|
|
669 |
<td>$requeteDonnees</td>
|
|
|
670 |
<td></td>
|
|
|
671 |
</tr>
|
|
|
672 |
</table>
|
|
|
673 |
|
|
|
674 |
|
|
|
675 |
<h4>Returns</h4>
|
|
|
676 |
string
|
|
|
677 |
— <p>l'identifiant créé.</p>
|
|
|
678 |
</article>
|
|
|
679 |
</div>
|
|
|
680 |
<aside class="span4 detailsbar">
|
|
|
681 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
682 |
<dl>
|
|
|
683 |
</dl>
|
|
|
684 |
<h2>Tags</h2>
|
|
|
685 |
<table class="table table-condensed">
|
|
|
686 |
<tr>
|
|
|
687 |
<th>
|
|
|
688 |
todo
|
|
|
689 |
</th>
|
|
|
690 |
<td>
|
|
|
691 |
</td>
|
|
|
692 |
</tr>
|
|
|
693 |
</table>
|
|
|
694 |
</aside>
|
|
|
695 |
</div>
|
|
|
696 |
|
|
|
697 |
<div class="row-fluid">
|
|
|
698 |
<div class="span8 content class">
|
|
|
699 |
<a id="method_supprimer" name="method_supprimer" class="anchor"></a>
|
|
|
700 |
<article class="method">
|
|
|
701 |
<h3 class="public ">supprimer()</h3>
|
|
|
702 |
<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>
|
|
|
703 |
<pre class="signature" style="margin-right: 54px;">supprimer( <span class="argument">$ressources</span>) : mixed</pre>
|
|
|
704 |
<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>
|
|
|
705 |
<p>Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par
|
|
|
706 |
RestServeur sera 204.
|
|
|
707 |
Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP
|
|
|
708 |
retourné par RestServeur sera 404.
|
|
|
709 |
Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner
|
|
|
710 |
la valeur null ou rien.</p>
|
|
|
711 |
|
|
|
712 |
<h4>Parameters</h4>
|
|
|
713 |
<table class="table table-condensed table-hover">
|
|
|
714 |
<tr>
|
|
|
715 |
<td></td>
|
|
|
716 |
<td>$ressources</td>
|
|
|
717 |
<td></td>
|
|
|
718 |
</tr>
|
|
|
719 |
</table>
|
|
|
720 |
|
|
|
721 |
|
|
|
722 |
<h4>Returns</h4>
|
|
|
723 |
mixed
|
|
|
724 |
— <p>une chaine indiquant le succès de l'opération ou rien.</p>
|
|
|
725 |
</article>
|
|
|
726 |
</div>
|
|
|
727 |
<aside class="span4 detailsbar">
|
|
|
728 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
729 |
<dl>
|
|
|
730 |
</dl>
|
|
|
731 |
<h2>Tags</h2>
|
|
|
732 |
<table class="table table-condensed">
|
|
|
733 |
<tr>
|
|
|
734 |
<th>
|
|
|
735 |
todo
|
|
|
736 |
</th>
|
|
|
737 |
<td>
|
|
|
738 |
</td>
|
|
|
739 |
</tr>
|
|
|
740 |
</table>
|
|
|
741 |
</aside>
|
|
|
742 |
</div>
|
|
|
743 |
|
|
|
744 |
<div class="row-fluid">
|
|
|
745 |
<div class="span8 content class">
|
|
|
746 |
<a id="method_getBdd" name="method_getBdd" class="anchor"></a>
|
|
|
747 |
<article class="method">
|
|
|
748 |
<h3 class="protected ">getBdd()</h3>
|
|
|
749 |
<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>
|
|
|
750 |
<pre class="signature" style="margin-right: 54px;">getBdd()</pre>
|
|
|
751 |
<p><em>Méthode de connection à la base de données sur demande.</em></p>
|
|
|
752 |
<p>Tous les services web n'ont pas besoin de s'y connecter.</p>
|
|
|
753 |
|
|
|
754 |
|
|
|
755 |
|
|
|
756 |
</article>
|
|
|
757 |
</div>
|
|
|
758 |
<aside class="span4 detailsbar">
|
|
|
759 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
760 |
<dl>
|
|
|
761 |
</dl>
|
|
|
762 |
<h2>Tags</h2>
|
|
|
763 |
<table class="table table-condensed">
|
|
|
764 |
<tr>
|
|
|
765 |
<th>
|
|
|
766 |
todo
|
|
|
767 |
</th>
|
|
|
768 |
<td>
|
|
|
769 |
</td>
|
|
|
770 |
</tr>
|
|
|
771 |
</table>
|
|
|
772 |
</aside>
|
|
|
773 |
</div>
|
|
|
774 |
|
|
|
775 |
<div class="row-fluid">
|
|
|
776 |
<div class="span8 content class">
|
|
|
777 |
<a id="method_getRestClient" name="method_getRestClient" class="anchor"></a>
|
|
|
778 |
<article class="method">
|
|
|
779 |
<h3 class="protected ">getRestClient()</h3>
|
|
|
780 |
<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>
|
|
|
781 |
<pre class="signature" style="margin-right: 54px;">getRestClient()</pre>
|
|
|
782 |
<p><em>Méthode permettant de faire appel à un client REST en fonction des besoins du service.</em></p>
|
|
|
783 |
|
|
|
784 |
|
|
|
785 |
|
|
|
786 |
|
|
|
787 |
</article>
|
|
|
788 |
</div>
|
|
|
789 |
<aside class="span4 detailsbar">
|
|
|
790 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
791 |
<dl>
|
|
|
792 |
</dl>
|
|
|
793 |
<h2>Tags</h2>
|
|
|
794 |
<table class="table table-condensed">
|
|
|
795 |
<tr>
|
|
|
796 |
<th>
|
|
|
797 |
todo
|
|
|
798 |
</th>
|
|
|
799 |
<td>
|
|
|
800 |
</td>
|
|
|
801 |
</tr>
|
|
|
802 |
</table>
|
|
|
803 |
</aside>
|
|
|
804 |
</div>
|
|
|
805 |
|
|
|
806 |
<div class="row-fluid">
|
|
|
807 |
<div class="span8 content class">
|
|
|
808 |
<a id="method_ajouterMessage" name="method_ajouterMessage" class="anchor"></a>
|
|
|
809 |
<article class="method">
|
|
|
810 |
<h3 class="protected ">ajouterMessage()</h3>
|
|
|
811 |
<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>
|
|
|
812 |
<pre class="signature" style="margin-right: 54px;">ajouterMessage(string <span class="argument">$message</span>)</pre>
|
|
|
813 |
<p><em>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.</em></p>
|
|
|
814 |
<p>Le message doit être au format texte et en UTF-8.</p>
|
|
|
815 |
|
|
|
816 |
<h4>Parameters</h4>
|
|
|
817 |
<table class="table table-condensed table-hover">
|
|
|
818 |
<tr>
|
|
|
819 |
<td>string</td>
|
|
|
820 |
<td>$message</td>
|
|
|
821 |
<td><p>le message à envoyer.</p></td>
|
|
|
822 |
</tr>
|
|
|
823 |
</table>
|
|
|
824 |
|
|
|
825 |
|
|
|
826 |
</article>
|
|
|
827 |
</div>
|
|
|
828 |
<aside class="span4 detailsbar">
|
|
|
829 |
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
830 |
<dl>
|
|
|
831 |
</dl>
|
|
|
832 |
<h2>Tags</h2>
|
|
|
833 |
<table class="table table-condensed">
|
|
|
834 |
<tr>
|
|
|
835 |
<th>
|
|
|
836 |
todo
|
|
|
837 |
</th>
|
|
|
838 |
<td>
|
|
|
839 |
</td>
|
|
|
840 |
</tr>
|
|
|
841 |
</table>
|
|
|
842 |
</aside>
|
|
|
843 |
</div>
|
|
|
844 |
|
|
|
845 |
</div>
|
|
|
846 |
</section>
|
|
|
847 |
|
|
|
848 |
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
|
|
|
849 |
<div class="modal-header">
|
|
|
850 |
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
|
851 |
<h3 id="source-view-label">RestService.php</h3>
|
|
|
852 |
</div>
|
|
|
853 |
<div class="modal-body">
|
|
|
854 |
<pre data-src="../files/RestService.php.txt" class="language-php line-numbers"></pre>
|
|
|
855 |
</div>
|
|
|
856 |
</div>
|
|
|
857 |
|
|
|
858 |
<footer class="row-fluid">
|
|
|
859 |
<section class="span10 offset2">
|
|
|
860 |
<section class="row-fluid">
|
|
|
861 |
<section class="span10 offset1">
|
|
|
862 |
<section class="row-fluid footer-sections">
|
|
|
863 |
<section class="span4">
|
|
|
864 |
<h1><i class="icon-code"></i></h1>
|
|
|
865 |
<div>
|
|
|
866 |
<ul>
|
|
|
867 |
</ul>
|
|
|
868 |
</div>
|
|
|
869 |
</section>
|
|
|
870 |
<section class="span4">
|
|
|
871 |
<h1><i class="icon-bar-chart"></i></h1>
|
|
|
872 |
<div>
|
|
|
873 |
<ul>
|
|
|
874 |
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
|
|
|
875 |
</ul>
|
|
|
876 |
</div>
|
|
|
877 |
</section>
|
|
|
878 |
<section class="span4">
|
|
|
879 |
<h1><i class="icon-pushpin"></i></h1>
|
|
|
880 |
<div>
|
|
|
881 |
<ul>
|
|
|
882 |
<li><a href="../reports/errors.html">Errors</a></li>
|
|
|
883 |
<li><a href="../reports/markers.html">Markers</a></li>
|
|
|
884 |
</ul>
|
|
|
885 |
</div>
|
|
|
886 |
</section>
|
|
|
887 |
</section>
|
|
|
888 |
</section>
|
|
|
889 |
</section>
|
|
|
890 |
<section class="row-fluid">
|
|
|
891 |
<section class="span10 offset1">
|
|
|
892 |
<hr />
|
|
|
893 |
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
|
|
894 |
on March 12th, 2014 at 15:57.
|
|
|
895 |
</section>
|
|
|
896 |
</section>
|
|
|
897 |
</section>
|
|
|
898 |
</footer>
|
|
|
899 |
</div>
|
|
|
900 |
|
|
|
901 |
</body>
|
|
|
902 |
</html>
|