1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.soap.server">
<title>Zend_Soap_Server</title>
<para>
La classe <classname>Zend_Soap_Server</classname> a été créée pour simplifier la
création d'un service Web <acronym>SOAP</acronym> en <acronym>PHP</acronym>.
</para>
<para>
Elle peut être utilisée en mode WSDL ou non-WSDL, et elle utilise des fonctions ou des
classes pour définir le service Web rendu.
</para>
<para>
Lorsque le composant <classname>Zend_Soap_Server</classname> fonctionne en mode WSDL,
il utilise le document WSDL pour décrire le comportement des objets du serveur ainsi que les
options de transport vers les clients.
</para>
<para>
Un document WSDL peut être auto-généré en utilisant <link
linkend="zend.soap.autodiscovery.introduction">le composant Zend_Soap_AutoDiscovery</link>,
ou alors construit manuellement avec <link linkend="zend.soap.wsdl">la classe
<classname>Zend_Soap_Wsdl</classname></link> ou tout autre outil de génération de <acronym>XML</acronym>
</para>
<para>
Si le mode non-WSDL est utilisé, alors toutes les options du protocole doivent être
configurées.
</para>
<sect2 id="zend.soap.server.constructor">
<title>Constructeur de <classname>Zend_Soap_Server</classname></title>
<para>
Le constructeur de <classname>Zend_Soap_Server</classname> s'utilise différemment
selon que l'on fonctionne en mode WSDL ou non.
</para>
<sect3 id="zend.soap.server.constructor.wsdl_mode">
<title>Constructeur de <classname>Zend_Soap_Server</classname> en mode WSDL</title>
<para>
Le constructeur de <classname>Zend_Soap_Server</classname> prend 2 paramètres
optionnel en mode WSDL: <orderedlist>
<listitem>
<para>
<varname>$wsdl</varname>, l'URI permettant l'accès au fichier WSDL
<footnote>
<para>
Peut être spécifié plus tard avec la méthode
<methodname>setWsdl($wsdl)</methodname>
</para>
</footnote>.
</para>
</listitem>
<listitem>
<para>
<varname>$options</varname> - options de création des objets serveurs
<footnote>
<para>
Peut être spécifié plus tard avec la méthode
<methodname>setOptions($options)</methodname>
</para>
</footnote>.
</para>
<para>
Les options suivantes sont reconnues en mode WSDL : <itemizedlist>
<listitem>
<para>
"soap_version" ("soapVersion") : version du protocole <acronym>SOAP</acronym>
à utiliser (SOAP_1_1 ou <acronym>SOAP</acronym>_1_2).
</para>
</listitem>
<listitem>
<para>"actor" : l'URI du serveur <acronym>SOAP</acronym>.</para>
</listitem>
<listitem>
<para>
"classmap" ("classMap") : utilisé pour faire correspondre
des types WSDL à des classes <acronym>PHP</acronym>.
</para>
<para>
L'option doit être un tableau avec pour clés les types
WSDL et pour valeur les classes <acronym>PHP</acronym> correspondantes.
</para>
</listitem>
<listitem>
<para>
"encoding" : encodage interne des caractères (l'encodage
externe est toujours UTF-8).
</para>
</listitem>
<listitem>
<para>
"wsdl" : équivalent à un appel à
<methodname>setWsdl($wsdlValue)</methodname>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</orderedlist>
</para>
</sect3>
<sect3 id="zend.soap.server.wsdl_mode">
<title>Constructeur de <classname>Zend_Soap_Server</classname> en mode
non-WSDL</title>
<para>
Le premier paramètre du constructeur <emphasis>doit</emphasis> être mis à la
valeur <constant>NULL</constant> si vous voulez utiliser
<classname>Zend_Soap_Server</classname> en mode non-WSDL.
</para>
<para>Vous devez aussi spécifier "uri" dans ce cas (voir juste après).</para>
<para>
Le second paramètre de constructeur est un tableau (<varname>$options</varname>)
d'options permettant la création de l'objet serveur <acronym>SOAP</acronym>.<footnote>
<para>
Les options se configurent aussi plus tard, grâce à la méthode
<methodname>setOptions($options)</methodname>
</para>
</footnote>.
</para>
<para>
Les options suivantes sont reconnues en mode non-WSDL : <itemizedlist>
<listitem>
<para>
"soap_version" ("soapVersion") : version <acronym>SOAP</acronym> à utiliser (SOAP_1_1
ou <acronym>SOAP</acronym>_1_2).
</para>
</listitem>
<listitem>
<para>"actor" : l'URI du serveur <acronym>SOAP</acronym>.</para>
</listitem>
<listitem>
<para>
"classmap" ("classMap") : utilisé pour faire correspondre des
types WSDL à des classes <acronym>PHP</acronym>.
</para>
<para>
L'option doit être un tableau avec pour clés les types WSDL et
pour valeur les classes <acronym>PHP</acronym> correspondantes.
</para>
</listitem>
<listitem>
<para>
"encoding" : encodage interne des caractères (l'encodage externe
est toujours UTF-8).
</para>
</listitem>
<listitem>
<para>
"wsdl" : équivalent à un appel à
<code>setWsdl($wsdlValue).</code>
</para>
</listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
<sect2 id="zend.soap.server.api_define_methods">
<title>Méthodes de définitions de l'API du service</title>
<para>Il existe 2 manières de déclarer l'API de votre serveur <acronym>SOAP</acronym>.</para>
<para>
La première consiste à attacher des classes à l'objet
<classname>Zend_Soap_Server</classname>, celles-ci devront alors décrire l'API du
service en totalité : <programlisting language="php"><![CDATA[
...
class MyClass {
/**
* Cette méthode accepte ...
*
* @param integer $inputParam
* @return string
*/
public function method1($inputParam) {
...
}
/**
* Cette méthode accepte ...
*
* @param integer $inputParam1
* @param string $inputParam2
* @return float
*/
public function method2($inputParam1, $inputParam2) {
...
}
...
}
...
$server = new Zend_Soap_Server(null, $options);
// Connecte la classe au serveur Soap
$server->setClass('MyClass');
// Connecte un objet déjà initialisé au serveur Soap
$server->setObject(new MyClass());
...
$server->handle();
]]></programlisting> <note>
<title>Important!</title>
<para>
Vous devriez complètement décrire chaque méthode grâce aux blocs de
commentaires PHPDoc dans le cas où vous souhaitez utiliser l'auto découverte du
service pour préparer le WSDL correspondant.
</para>
</note>
</para>
<para>
La seconde manière de décrire l'API de votre service Web est d'utiliser des
fonctions PHP conjointement avec les méthodes <methodname>addFunction()</methodname> ou
<methodname>loadFunctions()</methodname> :<programlisting language="php"><![CDATA[
...
/**
* Cette fonction ...
*
* @param integer $inputParam
* @return string
*/
function function1($inputParam) {
...
}
/**
* Cette fonction ...
*
* @param integer $inputParam1
* @param string $inputParam2
* @return float
*/
function function2($inputParam1, $inputParam2) {
...
}
...
$server = new Zend_Soap_Server(null, $options);
$server->addFunction('function1');
$server->addFunction('function2');
...
$server->handle();
]]></programlisting></para>
</sect2>
<sect2 id="zend.soap.server.request_response">
<title>Gestion des objets de requête et de réponse</title>
<note>
<title>Avancée</title>
<para>
Cette section décrit la gestion avancée des requêtes et réponses <acronym>SOAP</acronym> et
pourra être évitée.
</para>
</note>
<para>
Le composant Zend_Soap_Server effectue des requêtes et récupère des réponses, ceci
automatiquement. Il est possible d'intercepter la requête/réponse pour ajouter du pré ou
post processus.
</para>
<sect3 id="zend.soap.server.request_response.request">
<title>Requête</title>
<para>
La méthode <methodname>Zend_Soap_Server::handle()</methodname> utilise la
requête depuis le flux d'entrée standard ('php://input'). Le comportement peut être
changé en passant des paramètres à la méthode <methodname>handle()</methodname> ou en spécifiant
sa propre requête grâce à la méthode <methodname>setRequest()</methodname> :<programlisting
role="php"><![CDATA[
...
$server = new Zend_Soap_Server(...);
...
// Affecte une requête personnalisée
$server->handle($request);
...
// Affecte une requête personnalisée
$server->setRequest();
$server->handle();
]]></programlisting></para>
<para>
Un objet de requête peut être représenté de plusieurs manières différentes
:<itemizedlist>
<listitem>
<para>DOMDocument (casté en <acronym>XML</acronym>)</para>
</listitem>
<listitem>
<para>
DOMNode (le DOMDocument attaché est extrait et casté en
<acronym>XML</acronym>)
</para>
</listitem>
<listitem>
<para>SimpleXMLElement (casté en <acronym>XML</acronym>)</para>
</listitem>
<listitem>
<para>
stdClass (__toString() est appelée et son contenu est vérifié
comme <acronym>XML</acronym> valide)
</para>
</listitem>
<listitem>
<para>chaînes de caractères (vérifiée comme <acronym>XML</acronym> valide)</para>
</listitem>
</itemizedlist>
</para>
<para>
La dernière requête utilisée et traitée peut être récupérée en utilisant la
méthode <methodname>getLastRequest()</methodname> :<programlisting language="php"><![CDATA[
...
$server = new Zend_Soap_Server(...);
...
$server->handle();
$request = $server->getLastRequest();
]]></programlisting></para>
</sect3>
<sect3 id="zend.soap.server.request_response.response">
<title>Réponse</title>
<para>
<methodname>Zend_Soap_Server::handle()</methodname> émet automatiquement la
réponse vers le flux standard de sortie. Ce comportement peut être changé en
utilisant <methodname>setReturnResponse()</methodname> avec une valeur <constant>TRUE</constant> ou
<constant>FALSE</constant> en paramètre. <footnote>
<para>
L'état actuel du drapeau de retour de la réponse peut être vérifié via
la méthode <methodname>setReturnResponse()</methodname> sans paramètre.
</para>
</footnote>. La réponse générée par <methodname>handle()</methodname> est alors retournée et
non plus émise. <programlisting language="php"><![CDATA[
...
$server = new Zend_Soap_Server(...);
...
// Récupère la réponse plutôt que de l'émettre
$server->setReturnResponse(true);
...
$response = $server->handle();
...
]]></programlisting></para>
<para>
Autrement, la dernière réponse peut être récupérer avec la méthode
<methodname>getLastResponse()</methodname> :<programlisting language="php"><![CDATA[
...
$server = new Zend_Soap_Server(...);
...
$server->handle();
$response = $server->getLastResponse();
...
]]></programlisting></para>
</sect3>
</sect2>
</sect1>
|
