| 297 |
jpm |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
3 |
<head>
|
|
|
4 |
<!-- template designed by Marco Von Ballmoos -->
|
|
|
5 |
<title>File Source for RestService.php</title>
|
|
|
6 |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
|
|
|
7 |
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
|
8 |
</head>
|
|
|
9 |
<body>
|
|
|
10 |
<h1>Source for file RestService.php</h1>
|
|
|
11 |
<p>Documentation is available at <a href="../Framework/_RestService.php.html">RestService.php</a></p>
|
|
|
12 |
<div class="src-code">
|
|
|
13 |
<div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
|
|
|
14 |
<li><div class="src-line"><a name="a2"></a><span class="src-doc">/**</span></div></li>
|
|
|
15 |
<li><div class="src-line"><a name="a3"></a><span class="src-doc"> * Classe principale gérant les services.</span></div></li>
|
|
|
16 |
<li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Paramètres liés dans config.ini :</span></div></li>
|
|
|
17 |
<li><div class="src-line"><a name="a5"></a><span class="src-doc"> * - serveur.baseURL</span></div></li>
|
|
|
18 |
<li><div class="src-line"><a name="a6"></a><span class="src-doc"> * </span></div></li>
|
|
|
19 |
<li><div class="src-line"><a name="a7"></a><span class="src-doc"> * Encodage en entrée : utf8</span></div></li>
|
|
|
20 |
<li><div class="src-line"><a name="a8"></a><span class="src-doc"> * Encodage en sortie : utf8</span></div></li>
|
|
|
21 |
<li><div class="src-line"><a name="a9"></a><span class="src-doc"> * </span></div></li>
|
|
|
22 |
<li><div class="src-line"><a name="a10"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Php 5.2</span></div></li>
|
|
|
23 |
<li><div class="src-line"><a name="a11"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Framework</span></div></li>
|
|
|
24 |
<li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Jean-Pascal MILCENT <jpm@tela-botanica.org></span></div></li>
|
|
|
25 |
<li><div class="src-line"><a name="a13"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</span></div></li>
|
|
|
26 |
<li><div class="src-line"><a name="a14"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> GPL v3 <http://www.gnu.org/licenses/gpl.txt></span></div></li>
|
|
|
27 |
<li><div class="src-line"><a name="a15"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt></span></div></li>
|
|
|
28 |
<li><div class="src-line"><a name="a16"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@since</span><span class="src-doc"> 0.3</span></div></li>
|
| 300 |
jpm |
29 |
<li><div class="src-line"><a name="a17"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Id: RestService.php 299 2011-01-18 14:03:46Z jpm $</span></div></li>
|
| 297 |
jpm |
30 |
<li><div class="src-line"><a name="a18"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@link</span><span class="src-doc"> /doc/framework/</span></div></li>
|
|
|
31 |
<li><div class="src-line"><a name="a19"></a><span class="src-doc"> */</span></div></li>
|
|
|
32 |
<li><div class="src-line"><a name="a20"></a><span class="src-key">abstract </span><span class="src-key">class </span><a href="../Framework/RestService.html">RestService</a> <span class="src-sym">{</span></div></li>
|
|
|
33 |
<li><div class="src-line"><a name="a21"></a> </div></li>
|
|
|
34 |
<li><div class="src-line"><a name="a22"></a> <span class="src-doc">/** Objet de connection à la base de données. */</span></div></li>
|
|
|
35 |
<li><div class="src-line"><a name="a23"></a> <span class="src-key">protected </span><a href="../Framework/RestService.html#var$bdd">$bdd</a><span class="src-sym">;</span></div></li>
|
|
|
36 |
<li><div class="src-line"><a name="a24"></a> </div></li>
|
|
|
37 |
<li><div class="src-line"><a name="a25"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/RestService.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-var">$config</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
|
|
|
38 |
<li><div class="src-line"><a name="a26"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">config </span>= <span class="src-var">$config</span><span class="src-sym">;</span></div></li>
|
|
|
39 |
<li><div class="src-line"><a name="a27"></a> </div></li>
|
|
|
40 |
<li><div class="src-line"><a name="a28"></a> <span class="src-comm">// Connection à la base de données</span></div></li>
|
|
|
41 |
<li><div class="src-line"><a name="a29"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../Framework/RestService.html#var$bdd">bdd</a> = <span class="src-key">new </span><span class="src-id"><a href="../Framework/Bdd.html">Bdd</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
|
42 |
<li><div class="src-line"><a name="a30"></a> <span class="src-sym">}</span></div></li>
|
|
|
43 |
<li><div class="src-line"><a name="a31"></a> </div></li>
|
|
|
44 |
<li><div class="src-line"><a name="a32"></a> <span class="src-doc">/**</span></div></li>
|
|
|
45 |
<li><div class="src-line"><a name="a33"></a><span class="src-doc"> * Méthode appelée lors d'une requête HTTP de type GET.</span></div></li>
|
|
|
46 |
<li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span></div></li>
|
|
|
47 |
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * Si la consultation est un succès, le code statut HTTP retourné devrait être 200.</span></div></li>
|
|
|
48 |
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> * </span></div></li>
|
|
|
49 |
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</span></div></li>
|
|
|
50 |
<li><div class="src-line"><a name="a38"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">Partie de l'url situé après le '?' servant à paramétrer le service demandé.</span></div></li>
|
|
|
51 |
<li><div class="src-line"><a name="a39"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">une chaine indiquant le succès de l'opération et les données demandées.</span></div></li>
|
|
|
52 |
<li><div class="src-line"><a name="a40"></a><span class="src-doc"> */</span></div></li>
|
|
|
53 |
<li><div class="src-line"><a name="a41"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/RestService.html#methodconsulter">consulter</a><span class="src-sym">(</span><span class="src-var">$ressources</span><span class="src-sym">, </span><span class="src-var">$parametres</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
|
|
|
54 |
<li><div class="src-line"><a name="a42"></a> <span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><a href="../Framework/RestServeur.html#methodenvoyerEnteteStatutHttp">envoyerEnteteStatutHttp</a><span class="src-sym">(</span><span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><span class="src-id">HTTP_CODE_METHODE_NON_AUTORISE</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
|
55 |
<li><div class="src-line"><a name="a43"></a> echo <span class="src-str">"Le service '"</span>.<a href="http://www.php.net/get_class">get_class</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">)</span>.<span class="src-str">"' n'autorise pas la consultation."</span><span class="src-sym">;</span></div></li>
|
|
|
56 |
<li><div class="src-line"><a name="a44"></a> <span class="src-sym">}</span></div></li>
|
|
|
57 |
<li><div class="src-line"><a name="a45"></a> </div></li>
|
|
|
58 |
<li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
|
|
|
59 |
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> * Méthode appelée lors d'une requête HTTP de type POST.</span></div></li>
|
|
|
60 |
<li><div class="src-line"><a name="a48"></a><span class="src-doc"> * </span></div></li>
|
|
|
61 |
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps</span></div></li>
|
|
|
62 |
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> * de la requête.</span></div></li>
|
|
|
63 |
<li><div class="src-line"><a name="a51"></a><span class="src-doc"> * Si la modification est un succès, le code statut HTTP retourné devrait être 201.</span></div></li>
|
|
|
64 |
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> * </span></div></li>
|
|
|
65 |
<li><div class="src-line"><a name="a53"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</span></div></li>
|
|
|
66 |
<li><div class="src-line"><a name="a54"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">les données transférées dans le corps de la requête devant servir à la modification.</span></div></li>
|
|
|
67 |
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">une chaine indiquant le succès de l'opération ou rien.</span></div></li>
|
|
|
68 |
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> */</span></div></li>
|
|
|
69 |
<li><div class="src-line"><a name="a57"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/RestService.html#methodmodifier">modifier</a><span class="src-sym">(</span><span class="src-var">$ressources</span><span class="src-sym">, </span><span class="src-var">$requeteDonnees</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
|
|
|
70 |
<li><div class="src-line"><a name="a58"></a> <span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><a href="../Framework/RestServeur.html#methodenvoyerEnteteStatutHttp">envoyerEnteteStatutHttp</a><span class="src-sym">(</span><span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><span class="src-id">HTTP_CODE_METHODE_NON_AUTORISE</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
|
71 |
<li><div class="src-line"><a name="a59"></a> echo <span class="src-str">"Le service '"</span>.<a href="http://www.php.net/get_class">get_class</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">)</span>.<span class="src-str">"' n'autorise pas la modification."</span><span class="src-sym">;</span></div></li>
|
|
|
72 |
<li><div class="src-line"><a name="a60"></a> <span class="src-sym">}</span></div></li>
|
|
|
73 |
<li><div class="src-line"><a name="a61"></a> </div></li>
|
|
|
74 |
<li><div class="src-line"><a name="a62"></a> <span class="src-doc">/**</span></div></li>
|
|
|
75 |
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> * Méthode appelée lors d'une requête HTTP de type PUT.</span></div></li>
|
|
|
76 |
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> *</span></div></li>
|
|
|
77 |
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> * L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par</span></div></li>
|
|
|
78 |
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> * le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse.</span></div></li>
|
|
|
79 |
<li><div class="src-line"><a name="a67"></a><span class="src-doc"> * Si l'ajout est un succès, le code statut HTTP retourné devrait être 201.</span></div></li>
|
|
|
80 |
<li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span></div></li>
|
|
|
81 |
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</span></div></li>
|
|
|
82 |
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">les données transférées dans le corps de la requête devant servir à l'ajout.</span></div></li>
|
|
|
83 |
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">l'identifiant créé.</span></div></li>
|
|
|
84 |
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> */</span></div></li>
|
|
|
85 |
<li><div class="src-line"><a name="a73"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/RestService.html#methodajouter">ajouter</a><span class="src-sym">(</span><span class="src-var">$ressources</span><span class="src-sym">, </span><span class="src-var">$requeteDonnees</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
|
|
|
86 |
<li><div class="src-line"><a name="a74"></a> <span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><a href="../Framework/RestServeur.html#methodenvoyerEnteteStatutHttp">envoyerEnteteStatutHttp</a><span class="src-sym">(</span><span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><span class="src-id">HTTP_CODE_METHODE_NON_AUTORISE</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
|
87 |
<li><div class="src-line"><a name="a75"></a> echo <span class="src-str">"Le service '"</span>.<a href="http://www.php.net/get_class">get_class</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">)</span>.<span class="src-str">"' n'autorise pas la création."</span><span class="src-sym">;</span></div></li>
|
|
|
88 |
<li><div class="src-line"><a name="a76"></a> <span class="src-sym">}</span></div></li>
|
|
|
89 |
<li><div class="src-line"><a name="a77"></a> </div></li>
|
|
|
90 |
<li><div class="src-line"><a name="a78"></a> <span class="src-doc">/**</span></div></li>
|
|
|
91 |
<li><div class="src-line"><a name="a79"></a><span class="src-doc"> * Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).</span></div></li>
|
|
|
92 |
<li><div class="src-line"><a name="a80"></a><span class="src-doc"> * </span></div></li>
|
|
|
93 |
<li><div class="src-line"><a name="a81"></a><span class="src-doc"> * Si la suppression est un succès, le code statut HTTP retourné devrait être 204.</span></div></li>
|
|
|
94 |
<li><div class="src-line"><a name="a82"></a><span class="src-doc"> * </span></div></li>
|
|
|
95 |
<li><div class="src-line"><a name="a83"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc">Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</span></div></li>
|
|
|
96 |
<li><div class="src-line"><a name="a84"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">une chaine indiquant le succès de l'opération ou rien.</span></div></li>
|
|
|
97 |
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> */</span></div></li>
|
|
|
98 |
<li><div class="src-line"><a name="a86"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/RestService.html#methodsupprimer">supprimer</a><span class="src-sym">(</span><span class="src-var">$ressources</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
|
|
|
99 |
<li><div class="src-line"><a name="a87"></a> <span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><a href="../Framework/RestServeur.html#methodenvoyerEnteteStatutHttp">envoyerEnteteStatutHttp</a><span class="src-sym">(</span><span class="src-id"><a href="../Framework/RestServeur.html">RestServeur</a></span><span class="src-sym">::</span><span class="src-id">HTTP_CODE_METHODE_NON_AUTORISE</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
|
100 |
<li><div class="src-line"><a name="a88"></a> echo <span class="src-str">"Le service '"</span>.<a href="http://www.php.net/get_class">get_class</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">)</span>.<span class="src-str">"' n'autorise pas la suppression."</span><span class="src-sym">;</span></div></li>
|
|
|
101 |
<li><div class="src-line"><a name="a89"></a> <span class="src-sym">}</span></div></li>
|
|
|
102 |
<li><div class="src-line"><a name="a90"></a><span class="src-sym">}</span></div></li>
|
|
|
103 |
<li><div class="src-line"><a name="a91"></a><span class="src-php">?></span></div></li>
|
|
|
104 |
</ol></div>
|
|
|
105 |
</div>
|
|
|
106 |
<p class="notes" id="credit">
|
| 302 |
jpm |
107 |
Documentation generated on Tue, 18 Jan 2011 15:30:58 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
| 297 |
jpm |
108 |
</p>
|
|
|
109 |
</body>
|
|
|
110 |
</html>
|