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
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.http.response">
<title>Zend_Http_Response</title>
<sect2 id="zend.http.response.introduction">
<title>Introduction</title>
<para>
<classname>Zend_Http_Response</classname> fournit un accès simplifié aux réponses
<acronym>HTTP</acronym> d'un message, ainsi qu'un ensemble de méthodes statiques pour analyser ces réponses
<acronym>HTTP</acronym>. Habituellement <classname>Zend_Http_Response</classname> est utilisé en tant
qu'objet retourné par une requête <classname>Zend_Http_Client</classname>.
</para>
<para>
Dans la plupart des cas, un objet <classname>Zend_Http_Response</classname> sera
instancié en utilisant la méthode <methodname>fromString()</methodname>, qui lit une chaîne contenant
une réponse HTTP, et retourne un nouvel objet <classname>Zend_Http_Response</classname>
: <example id="zend.http.response.introduction.example-1">
<title>Instancier un objet Zend_Http_Response en utilisant la méthode
factory</title>
<programlisting language="php"><![CDATA[
$str = '';
$sock = fsockopen('www.exemple.com', 80);
$req = "GET / HTTP/1.1\r\n" .
"Host: www.exemple.com\r\n" .
"Connection: close\r\n" .
"\r\n";
fwrite($sock, $req);
while ($buff = fread($sock, 1024))
$str .= $sock;
$response = Zend_Http_Response::fromString($str);
]]></programlisting>
</example>
</para>
<para>
Vous pouvez aussi utiliser le constructeur pour créer un nouvel objet de réponse
<acronym>HTTP</acronym>, en spécifiant tous les paramètres de la réponse :
</para>
<para>
<code> public function __construct($code, $headers, $body = null, $version =
'1.1', $message = null) </code>
</para>
<itemizedlist>
<listitem>
<para>
<varname>$code</varname> : le code de la réponse <acronym>HTTP</acronym> (par ex. 200, 404,
etc.)
</para>
</listitem>
<listitem>
<para>
<varname>$headers</varname> : un tableau associatif d'en-têtes de réponse <acronym>HTTP</acronym>
(par ex. "Host" => "exemple.com")
</para>
</listitem>
<listitem>
<para>
<varname>$body</varname> : le corps de la réponse sous la forme d'une
chaîne
</para>
</listitem>
<listitem>
<para>
<varname>$version</varname> : la version de la réponse <acronym>HTTP</acronym> (habituellement 1.0
ou 1.1)
</para>
</listitem>
<listitem>
<para>
<varname>$message</varname> : le message de la réponse <acronym>HTTP</acronym> (par ex. "OK",
"Internal Server Error"). Si non spécifié, le message sera paramétré suivant le
code de la réponse.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.http.response.testers">
<title>Méthodes de tests booléennes</title>
<para>
Une fois qu'un objet <classname>Zend_Http_Response</classname> est instancié, il
fournit plusieurs méthodes qui peuvent être utilisées pour tester le type de la réponse.
Elles retournent toutes un booléen <constant>TRUE</constant> ou <constant>FALSE</constant> :
<itemizedlist>
<listitem>
<para>
<methodname>isSuccessful()</methodname> : la requête est réussie ou non. Retourne
<code>true </code> pour les codes de réponses <acronym>HTTP</acronym> 1xx et 2xx.
</para>
</listitem>
<listitem>
<para>
<methodname>isError()</methodname> : la requête implique une erreur ou non.
Retourne <code>true </code> pour les codes de réponses <acronym>HTTP</acronym> 4xx (erreurs du
client) et 5xx (erreurs du serveur).
</para>
</listitem>
<listitem>
<para>
<methodname>isRedirect()</methodname> : la requête est une redirection ou non.
Retourne <code>true </code> pour les codes de réponses <acronym>HTTP</acronym> 3xx.
</para>
</listitem>
</itemizedlist> <example id="zend.http.response.testers.example-1">
<title>Utiliser la méthode isError() pour valider une réponse</title>
<programlisting language="php"><![CDATA[
if ($response->isError()) {
echo "Erreur de transmission des données.\n"
echo "Les infos Serveur sont : "
. $response->getStatus()
. " " . $response->getMessage()
. "\n";
}
// ... traiter la réponse ici ...
]]></programlisting>
</example>
</para>
</sect2>
<sect2 id="zend.http.response.acessors">
<title>Méthodes accesseurs</title>
<para>
Le but principal de l'objet réponse est de fournir un accès facile à divers
paramètres de la réponse. <itemizedlist>
<listitem>
<para>
<code>int getStatus()</code> : récupère le code de la réponse <acronym>HTTP</acronym>
(par ex. 200, 504, etc.)
</para>
</listitem>
<listitem>
<para>
<code>string getMessage()</code> : récupère le message de la réponse
<acronym>HTTP</acronym> (par ex. "Not Found", "Authorization Required")
</para>
</listitem>
<listitem>
<para>
<code>string getBody()</code> : récupère le corps complet décodé de la
réponse <acronym>HTTP</acronym>
</para>
</listitem>
<listitem>
<para>
<code>string getRawBody()</code> : récupère le corps brut,
possiblement encodé, de la réponse <acronym>HTTP</acronym>. Si le corps est encodé en utilisant
l'encodage GZIP par exemple, il ne sera pas décodé.
</para>
</listitem>
<listitem>
<para>
<code>array getHeaders()</code> : récupère les en-têtes de la réponse
<acronym>HTTP</acronym> sous la forme d'un tableau associatif (par ex. 'Content-type' =>
'text/html')
</para>
</listitem>
<listitem>
<para>
<code>string|array getHeader($header)</code> : récupère un en-tête
spécifique de la réponse <acronym>HTTP</acronym>, spécifié par <varname>$header</varname>
</para>
</listitem>
<listitem>
<para>
<code>string getHeadersAsString($status_line = true, $br =
"\n")</code> : récupère l'ensemble des en-têtes sous la forme d'une chaîne.
Si <varname>$status_line</varname> est à <constant>TRUE</constant> (défaut), la première
ligne de statut (par ex. "HTTP/1.1 200 OK") sera aussi retournée. Les lignes
sont coupées avec le paramètre <varname>$br</varname> (par ex. "<br
/>")
</para>
</listitem>
<listitem>
<para>
<code>string asString($br = "\n")</code> : récupère la réponse
complète sous la forme d'une chaîne. Les lignes sont coupées avec le
paramètre <varname>$br</varname> (par ex. "<br />"). Vous pouvez aussi
utiliser la méthode magique <methodname>__toString()</methodname> lors du
cast de l'objet en chaîne de caractère. Ce sera alors proxié vers
<methodname>asString()</methodname>.
</para>
</listitem>
</itemizedlist> <example id="zend.http.response.acessors.example-1">
<title>Utiliser les méthodes accesseurs de Zend_Http_Response</title>
<programlisting language="php"><![CDATA[
if ($response->getStatus() == 200) {
echo "La requête retourne les informations suivantes :<br />";
echo $response->getBody();
} else {
echo "Une erreur est apparue lors de la recherche des données :<br />";
echo $response->getStatus() . ": " . $response->getMessage();
}
]]></programlisting>
</example> <note>
<title>Vérifier toujours la valeur retournée</title>
<para>
Puisqu'une réponse peut contenir plusieurs exemplaires du même en-tête, la
méthode <methodname>getHeader()</methodname> et la méthode <methodname>getHeaders()</methodname> peuvent
renvoyer l'un comme l'autre soit une chaîne seule, soit un tableau de chaînes
pour chaque en-tête. Vous devez donc toujours vérifier si la valeur retournée
est une chaîne ou un tableau.
</para>
</note> <example id="zend.http.response.acessors.example-2">
<title>Accéder aux en-têtes de réponse</title>
<programlisting language="php"><![CDATA[
$ctype = $response->getHeader('Content-type');
if (is_array($ctype)) $ctype = $ctype[0];
$body = $response->getBody();
if ($ctype == 'text/html' || $ctype == 'text/xml') {
$body = htmlentities($body);
}
echo $body;
]]></programlisting>
</example>
</para>
</sect2>
<sect2 id="zend.http.response.static_parsers">
<title>Analyseurs statiques de réponse HTTP</title>
<para>
La classe <classname>Zend_Http_Response</classname> inclut également plusieurs
méthodes utilisées en interne pour traiter et analyser des messages de réponse <acronym>HTTP</acronym>. Ces
méthodes sont toutes exposées en tant que méthodes statiques, ce qui permet de les
utiliser extérieurement, ainsi il n'est pas nécessaire d'instancier un objet réponse si
vous souhaitez extraire une partie spécifique de la réponse. <itemizedlist>
<listitem>
<para>
<code>int Zend_Http_Response::extractCode($response_str)</code> :
extrait et retourne le code de la réponse <acronym>HTTP</acronym> (par ex. 200 ou 404) issu
de<varname>$response_str</varname>
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::extractMessage($response_str)</code>
: extrait et retourne le message de la réponse <acronym>HTTP</acronym> (par ex. "OK" ou "File
Not Found") issu de <varname>$response_str</varname>
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::extractVersion($response_str)</code>
: extrait et retourne la version <acronym>HTTP</acronym> (par ex. 1.1 or 1.0) issue de
<varname>$response_str</varname>
</para>
</listitem>
<listitem>
<para>
<code>array Zend_Http_Response::extractHeaders($response_str)</code> :
extrait et retourne les en-têtes de la réponse <acronym>HTTP</acronym> issus de
<varname>$response_str</varname> sous la forme d'un tableau
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::extractBody($response_str)</code> :
extrait et retourne le corps de la réponse <acronym>HTTP</acronym> issu de
<varname>$response_str</varname>
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::responseCodeAsText($code = null,
$http11 = true)</code> : récupère le message standard de la réponse <acronym>HTTP</acronym>
pour le code <varname>$code</varname>. Par exemple, la méthode retournera
"Internal Server Error" si <varname>$code</varname> vaut 500. Si
<varname>$http11</varname> vaut <constant>TRUE</constant> (valeur par défaut), la méthode
retournera les messages standards <acronym>HTTP</acronym>/1.1 - sinon les messages <acronym>HTTP</acronym>/1.0
seront retournés. Si <varname>$code</varname> n'est pas spécifié, cette méthode
retournera tous les codes de réponse <acronym>HTTP</acronym> connus sous la forme d'un tableau
associatif (code => message).
</para>
</listitem>
</itemizedlist>
</para>
<para>
Indépendamment des méthodes d'analyse, la classe inclut également un ensemble de
décodeurs pour les encodages de transfert de réponse <acronym>HTTP</acronym> communs : <itemizedlist>
<listitem>
<para>
<code>string Zend_Http_Response::decodeChunkedBody($body)</code>:
décode un corps complet de type "Content-Transfer-Encoding: Chunked"
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::decodeGzip($body)</code> : décode un
corps de type "Content-Encoding: gzip"
</para>
</listitem>
<listitem>
<para>
<code>string Zend_Http_Response::decodeDeflate($body)</code> : décode
un corps de type "Content-Encoding: deflate"
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
</sect1>
|
