Zend_Http_Client-Adapters.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 21815 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.http.client.adapters">
  5. <title>Zend_Http_Client - Adaptateurs de connexion</title>
  6. <sect2 id="zend.http.client.adapters.overview">
  7. <title>Présentation globale</title>
  8. <para>
  9. <classname>Zend_Http_Client</classname> accepte des objets adaptateurs. Ces objets
  10. ont la responsabilité de soutenir la connexion vers un serveur, à savoir écrire des
  11. requêtes et lire des réponses L'adaptateur peut donc être changé, et même écrit ou
  12. réécrit pour correspondre à vos besoins, sans avoir l'obligation de toucher à toute la
  13. classe dite "client". Vous vous connectez et manipulez votre connexion toujours de la
  14. même manière quelque soit l'adaptateur situé dessous.
  15. </para>
  16. <para>
  17. Actuellement, la classe cliente <classname>Zend_Http_Client</classname> est
  18. fournie avec quatre adaptateurs : <itemizedlist>
  19. <listitem>
  20. <para><classname>Zend_Http_Client_Adapter_Socket</classname> (défaut)</para>
  21. </listitem>
  22. <listitem>
  23. <para><classname>Zend_Http_Client_Adapter_Proxy</classname></para>
  24. </listitem>
  25. <listitem>
  26. <para><classname>Zend_Http_Client_Adapter_Curl</classname></para>
  27. </listitem>
  28. <listitem>
  29. <para><classname>Zend_Http_Client_Adapter_Test</classname></para>
  30. </listitem>
  31. </itemizedlist>
  32. </para>
  33. <para>
  34. L'objet Zend_Http_Client se voit spécifié un adaptateur via son constructeur avec
  35. le tableau d'options, à l'index 'adapter'. Fournissez alors une chaîne représentant la
  36. classe d'adaptateur à utiliser (par exemple 'Zend_Http_Client_Adapter_Socket'), ou un
  37. objet directement (par exemple <code> new Zend_Http_Client_Adapter_Test</code>). Vous
  38. pouvez de même passer un adaptateur plus tard, avec la méthode
  39. <classname>Zend_Http_Client-&gt;setConfig()</classname>.
  40. </para>
  41. </sect2>
  42. <sect2 id="zend.http.client.adapters.socket">
  43. <title>Adaptateur Socket</title>
  44. <para>
  45. L'adaptateur par défaut est Zend_Http_Client_Adapter_Socket. Il est basé sur les
  46. fonctions <acronym>PHP</acronym> <methodname>fsockopen()</methodname> et soeurs. Il ne nécessite donc aucune extension
  47. particulière ni option de compilation de <acronym>PHP</acronym>.
  48. </para>
  49. <para>
  50. L'adaptateur Socket peut être configuré avec des options, passées par
  51. <classname>Zend_Http_Client-&gt;setConfig()</classname> ou au constructeur du client.
  52. <table id="zend.http.client.adapter.socket.configuration.table">
  53. <title>Zend_Http_Client_Adapter_Socket configuration</title>
  54. <tgroup cols="4">
  55. <thead>
  56. <row>
  57. <entry>Paramètre</entry>
  58. <entry>Description</entry>
  59. <entry>Types attendus</entry>
  60. <entry>Valeur par défaut</entry>
  61. </row>
  62. </thead>
  63. <tbody>
  64. <row>
  65. <entry>persistent</entry>
  66. <entry>Utilise ou non les connexions <acronym>TCP</acronym> persistantes</entry>
  67. <entry>booléen</entry>
  68. <entry>false</entry>
  69. </row>
  70. <row>
  71. <entry>ssltransport</entry>
  72. <entry>Couche de transport <acronym>SSL</acronym> ('sslv2', 'tls')</entry>
  73. <entry>chaîne</entry>
  74. <entry>ssl</entry>
  75. </row>
  76. <row>
  77. <entry>sslcert</entry>
  78. <entry>Chemin vers le certificat <acronym>SSL</acronym> encodé <acronym>PEM</acronym></entry>
  79. <entry>chaîne</entry>
  80. <entry>null</entry>
  81. </row>
  82. <row>
  83. <entry>sslpassphrase</entry>
  84. <entry>Phrase de passe pour le fichier de certificat <acronym>SSL</acronym></entry>
  85. <entry>chaîne</entry>
  86. <entry>null</entry>
  87. </row>
  88. <row>
  89. <entry>sslusecontext</entry>
  90. <entry>
  91. Active l'utilisation de SSL aux niveaux des connexions proxiées
  92. même si la connexion proxiée elle-même ne le fait pas.
  93. </entry>
  94. <entry>boolean</entry>
  95. <entry><constant>FALSE</constant></entry>
  96. </row>
  97. </tbody>
  98. </tgroup>
  99. </table> <note>
  100. <title>Connexions <acronym>TCP</acronym> persistantes</title>
  101. <para>
  102. L'utilisation de connexions <acronym>TCP</acronym> persistantes peut potentiellement
  103. accélérer vos requêtes <acronym>HTTP</acronym> mais n'a, dans la plupart des cas, qu'un petit effet
  104. positif et peut surcharger le serveur <acronym>HTTP</acronym> auquel vous êtes connecté.
  105. </para>
  106. <para>
  107. Il est recommandé d'utiliser les connexions <acronym>TCP</acronym> persistantes seulement si
  108. vous vous connectez au même serveur très fréquemment, et que vous êtes sûr que
  109. le serveur est capable de gérer un nombre élevé de connections concurrentes.
  110. Dans tous les cas vous êtes encouragés à tester l'effet des connections
  111. persistantes à la fois sur l'accélération du client et sur la charge du serveur
  112. avant d'activer cette option.
  113. </para>
  114. <para>
  115. De plus, quand vous utilisez des connexions persistantes, il est
  116. recommandé d'activer l'option "Keep-Alive" décrite dans <xref
  117. linkend="zend.http.client.configuration" />, sinon les connexions persistantes
  118. n'auront que peu ou pas d'effet.
  119. </para>
  120. </note> <note>
  121. <title>HTTPS SSL Paramètres de flux</title>
  122. <para>
  123. <code>ssltransport, sslcert</code> and <code>sslpassphrase</code> sont
  124. seulement appropriées lors de l'utilisation d'HTTPS.
  125. </para>
  126. <para>
  127. Bien que les réglages par défaut du mode <acronym>SSL</acronym> fonctionneront pour la
  128. plupart des applications, vous pourrez avoir besoin de les changer si le
  129. serveur, auquel vous vous connectez, requière un paramétrage particulier du
  130. client. Dans ce cas, vous devriez lire les sections sur la couche de transport
  131. <acronym>SSL</acronym> et ses options à cette <ulink
  132. url="http://www.php.net/manual/en/transports.php#transports.inet">adresse</ulink>.
  133. </para>
  134. </note>
  135. </para>
  136. <example id="zend.http.client.adapters.socket.example-1">
  137. <title>Changer la couche de transport HTTPS</title>
  138. <programlisting language="php"><![CDATA[
  139. // Définit des paramètres de configuration
  140. $config = array(
  141. 'adapter' => 'Zend_Http_Client_Adapter_Socket',
  142. 'ssltransport' => 'tls'
  143. );
  144. // Instantie un objet client
  145. $client = new Zend_Http_Client('https://www.example.com', $config);
  146. // Cette requête sera envoyée vers une connexion sécurisée TLS
  147. $response = $client->request();
  148. ]]></programlisting>
  149. </example>
  150. <para>
  151. Le résultat ci-dessus sera similaire à l'ouverture d'une connexion <acronym>TCP</acronym> avec la
  152. commande <acronym>PHP</acronym> suivante :
  153. </para>
  154. <para><methodname>fsockopen('tls://www.example.com', 443)</methodname></para>
  155. <sect3 id="zend.http.client.adapters.socket.streamcontext">
  156. <title>Customizing and accessing the Socket adapter stream context</title>
  157. <para>
  158. Starting from Zend Framework 1.9, <classname>Zend_Http_Client_Adapter_Socket</classname>
  159. provides direct access to the underlying <ulink url="http://php.net/manual/en/stream.contexts.php">stream context</ulink>
  160. used to connect to the remote server. This allows the user to pass
  161. specific options and parameters to the <acronym>TCP</acronym> stream, and to the <acronym>SSL</acronym> wrapper in
  162. case of <acronym>HTTPS</acronym> connections.
  163. </para>
  164. <para>
  165. You can access the stream context using the following methods of <classname>Zend_Http_Client_Adapter_Socket</classname>:
  166. <itemizedlist>
  167. <listitem>
  168. <para>
  169. <firstterm><methodname>setStreamContext($context)</methodname></firstterm>
  170. Sets the stream context to be used by the adapter. Can accept either
  171. a stream context resource created using the
  172. <ulink url="http://php.net/manual/en/function.stream-context-create.php"><methodname>stream_context_create()</methodname></ulink>
  173. <acronym>PHP</acronym> function, or an array of stream context options, in the same format provided to this function.
  174. Providing an array will create a new stream context using these options, and set it.
  175. </para>
  176. </listitem>
  177. <listitem>
  178. <para>
  179. <firstterm><methodname>getStreamContext()</methodname></firstterm>
  180. Get the stream context of the adapter. If no stream context was set,
  181. will create a default stream context and return it. You can then set
  182. or get the value of different context options using regular <acronym>PHP</acronym> stream
  183. context functions.
  184. </para>
  185. </listitem>
  186. </itemizedlist>
  187. </para>
  188. <example id="zend.http.client.adapters.socket.streamcontext.example-1">
  189. <title>Setting stream context options for the Socket adapter</title>
  190. <programlisting language="php"><![CDATA[
  191. // Array of options
  192. $options = array(
  193. 'socket' => array(
  194. // Bind local socket side to a specific interface
  195. 'bindto' => '10.1.2.3:50505'
  196. ),
  197. 'ssl' => array(
  198. // Verify server side certificate,
  199. // do not accept invalid or self-signed SSL certificates
  200. 'verify_peer' => true,
  201. 'allow_self_signed' => false,
  202. // Capture the peer's certificate
  203. 'capture_peer_cert' => true
  204. )
  205. );
  206. // Create an adapter object and attach it to the HTTP client
  207. $adapter = new Zend_Http_Client_Adapter_Socket();
  208. $client = new Zend_Http_Client();
  209. $client->setAdapter($adapter);
  210. // Method 1: pass the options array to setStreamContext()
  211. $adapter->setStreamContext($options);
  212. // Method 2: create a stream context and pass it to setStreamContext()
  213. $context = stream_context_create($options);
  214. $adapter->setStreamContext($context);
  215. // Method 3: get the default stream context and set the options on it
  216. $context = $adapter->getStreamContext();
  217. stream_context_set_option($context, $options);
  218. // Now, preform the request
  219. $response = $client->request();
  220. // If everything went well, you can now access the context again
  221. $opts = stream_context_get_options($adapter->getStreamContext());
  222. echo $opts['ssl']['peer_certificate'];
  223. ]]></programlisting>
  224. </example>
  225. <note>
  226. <para>
  227. Note that you must set any stream context options before using the adapter
  228. to preform actual requests. If no context is set before preforming <acronym>HTTP</acronym> requests
  229. with the Socket adapter, a default stream context will be created. This context
  230. resource could be accessed after preforming any requests using the
  231. <methodname>getStreamContext()</methodname> method.
  232. </para>
  233. </note>
  234. </sect3>
  235. </sect2>
  236. <sect2 id="zend.http.client.adapters.proxy">
  237. <title>Adaptateur Proxy</title>
  238. <para>
  239. L'adaptateur Zend_Http_Client_Adapter_Proxy est identique à celui par défaut,
  240. Socket, sauf que Proxy se connectera au serveur via un serveur Proxy (mandataire). Cette
  241. utilisation peut être rencontrée pour des raisons de performances ou de sécurité.
  242. </para>
  243. <para>
  244. En utilisant l'adaptateur Proxy, quelques paramètres de configuration seront
  245. nécessaires en plus du paramètre 'adapter' : <table
  246. id="zend.http.client.adapters.proxy.table">
  247. <title>Zend_Http_Client paramètres de configuration</title>
  248. <tgroup cols="4">
  249. <thead>
  250. <row>
  251. <entry>Paramètre</entry>
  252. <entry>Description</entry>
  253. <entry>Valeurs attendues</entry>
  254. <entry>Valeur par défaut</entry>
  255. </row>
  256. </thead>
  257. <tbody>
  258. <row>
  259. <entry>proxy_host</entry>
  260. <entry>Adresse du serveur Proxy</entry>
  261. <entry>chaîne</entry>
  262. <entry>'proxy.myhost.com' ou '10.1.2.3'</entry>
  263. </row>
  264. <row>
  265. <entry>proxy_port</entry>
  266. <entry>Port du serveur Proxy</entry>
  267. <entry>entier</entry>
  268. <entry>8080 (défaut) ou 81</entry>
  269. </row>
  270. <row>
  271. <entry>proxy_user</entry>
  272. <entry>nom d'utilisateur pour le Proxy, si requis</entry>
  273. <entry>chaîne</entry>
  274. <entry>'shahar' ou '' pour aucun (défaut)</entry>
  275. </row>
  276. <row>
  277. <entry>proxy_pass</entry>
  278. <entry>Mot de passe du Proxy, si requis</entry>
  279. <entry>chaîne</entry>
  280. <entry>'secret' ou '' pour aucun (défaut)</entry>
  281. </row>
  282. <row>
  283. <entry>proxy_auth</entry>
  284. <entry>Type d'authentification <acronym>HTTP</acronym> du Proxy</entry>
  285. <entry>chaîne</entry>
  286. <entry>Zend_Http_Client::AUTH_BASIC (défaut)</entry>
  287. </row>
  288. </tbody>
  289. </tgroup>
  290. </table>
  291. </para>
  292. <para>
  293. <code>proxy_host</code> devrait toujours être fourni. Si ça n'est pas le cas,
  294. alors le client retournera sur une connexion Socket par défaut. <code>proxy_port</code>
  295. est par défaut à "8080".
  296. </para>
  297. <para>
  298. <code>proxy_user</code> et <code>proxy_pass</code> ne sont requis que si le
  299. serveur Proxy demande une authentification. Si vous remplissez ces options, alors un
  300. champ d'en-tête <acronym>HTTP</acronym> "Proxy-Authentication" sera ajouté à vos requêtes, via votre
  301. client.
  302. </para>
  303. <para>
  304. <code>proxy_auth</code> définit le type d'authentification à utiliser, si le
  305. serveur Proxy demande une authentification. Actuellement, seule la méthode "basic"
  306. (<classname>Zend_Http_Client::AUTH_BASIC</classname>) est supportée.
  307. </para>
  308. <example id="zend.http.client.adapters.proxy.example-1">
  309. <title>Utiliser Zend_Http_Client derrière un serveur Proxy</title>
  310. <programlisting language="php"><![CDATA[
  311. // Paramètres de configuration
  312. $config = array(
  313. 'adapter' => 'Zend_Http_Client_Adapter_Proxy',
  314. 'proxy_host' => 'proxy.int.zend.com',
  315. 'proxy_port' => 8000,
  316. 'proxy_user' => 'shahar.e',
  317. 'proxy_pass' => 'bananashaped'
  318. );
  319. // Crée l'objet client
  320. $client = new Zend_Http_Client('http://www.example.com', $config);
  321. // utilisez l'objet client ici ...
  322. ]]></programlisting>
  323. </example>
  324. <para>
  325. Comme déjà dit, si proxy_host n'est pas rempli ou défini en tant que chaîne vide,
  326. alors le client utilisera l'adaptateur Socket par défaut. Ceci est utile si le proxy est
  327. utilisé optionnellement, ou par intermittence.
  328. </para>
  329. <note>
  330. <para>
  331. Since the proxy adapter inherits from <classname>Zend_Http_Client_Adapter_Socket</classname>,
  332. you can use the stream context access method (see <xref linkend="zend.http.client.adapters.socket.streamcontext" />)
  333. to set stream context options on Proxy connections as demonstrated above.
  334. </para>
  335. </note>
  336. </sect2>
  337. <sect2 id="zend.http.client.adapters.curl">
  338. <title>The cURL Adapter</title>
  339. <para>
  340. cURL is a standard <acronym>HTTP</acronym> client library that is distributed with many
  341. operating systems and can be used in <acronym>PHP</acronym> via the cURL extension. It
  342. offers functionality for many special cases which can occur for a <acronym>HTTP</acronym>
  343. client and make it a perfect choice for a <acronym>HTTP</acronym> adapter. It supports
  344. secure connections, proxy, all sorts of authentication mechanisms
  345. and shines in applications that move large files around between servers.
  346. </para>
  347. <example id="zend.http.client.adapters.curl.example-1">
  348. <title>Setting cURL options</title>
  349. <programlisting language="php"><![CDATA[
  350. $config = array(
  351. 'adapter' => 'Zend_Http_Client_Adapter_Curl',
  352. 'curloptions' => array(CURLOPT_FOLLOWLOCATION => true),
  353. );
  354. $client = new Zend_Http_Client($uri, $config);
  355. ]]></programlisting>
  356. </example>
  357. <para>
  358. By default the cURL adapter is configured to behave exactly like
  359. the Socket Adapter and it also accepts the same configuration parameters
  360. as the Socket and Proxy adapters. You can also change the cURL options by either specifying
  361. the 'curloptions' key in the constructor of the adapter or by calling
  362. <methodname>setCurlOption($name, $value)</methodname>. The <varname>$name</varname> key
  363. corresponds to the CURL_* constants of the cURL extension. You can
  364. get access to the Curl handle by calling <code>$adapter->getHandle();</code>
  365. </para>
  366. <example id="zend.http.client.adapters.curl.example-2">
  367. <title>Transfering Files by Handle</title>
  368. <para>
  369. You can use cURL to transfer very large files over <acronym>HTTP</acronym> by filehandle.
  370. </para>
  371. <programlisting language="php"><![CDATA[
  372. $putFileSize = filesize("filepath");
  373. $putFileHandle = fopen("filepath", "r");
  374. $adapter = new Zend_Http_Client_Adapter_Curl();
  375. $client = new Zend_Http_Client();
  376. $client->setAdapter($adapter);
  377. $adapter->setConfig(array(
  378. 'curloptions' => array(
  379. CURLOPT_INFILE => $putFileHandle,
  380. CURLOPT_INFILESIZE => $putFileSize
  381. )
  382. ));
  383. $client->request("PUT");
  384. ]]></programlisting>
  385. </example>
  386. </sect2>
  387. <sect2 id="zend.http.client.adapters.test">
  388. <title>Adaptateur Test</title>
  389. <para>
  390. Il est quelque fois difficile de tester une application qui a besoin d'une
  391. connexion <acronym>HTTP</acronym>. Par exemple, une application qui est en charge de lire un flux <acronym>RSS</acronym> aura
  392. besoin d'une connexion, qui n'est pas tout le temps disponible.
  393. </para>
  394. <para>
  395. C'est pour cette raison que l'adaptateur
  396. <classname>Zend_Http_Client_Adapter_Test</classname> est présent. Vous pouvez de cette
  397. manière écrire vos applications, et lors de la phase de tests, passer votre connexion
  398. sur l'adaptateur Test (objet mock).
  399. </para>
  400. <para>
  401. La classe <classname>Zend_Http_Client_Adapter_Test</classname> possède une méthode
  402. supplémentaire, <methodname>setResponse()</methodname>. Elle prend en paramètre un objet
  403. <classname>Zend_Http_Response</classname> ou une chaîne. Une fois cet objet de réponse
  404. déterminé, l'adaptateur de Test retournera toujours cette réponse, sans effectuer de
  405. réelle requête <acronym>HTTP</acronym>.
  406. </para>
  407. <example id="zend.http.client.adapters.test.example-1">
  408. <title>Tester avec un objet de réponse HTTP unique</title>
  409. <programlisting language="php"><![CDATA[
  410. // Création de l'adatateur et de l'objet client :
  411. $adapter = new Zend_Http_Client_Adapter_Test();
  412. $client = new Zend_Http_Client('http://www.example.com', array(
  413. 'adapter' => $adapter
  414. ));
  415. // Passage de l'objet de réponse
  416. $adapter->setResponse(
  417. "HTTP/1.1 200 OK" . "\r\n" .
  418. "Content-type: text/xml" . "\r\n" .
  419. "\r\n" .
  420. '<?xml version="1.0" encoding="UTF-8"?>' .
  421. '<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/"' .
  422. ' xmlns:wfw="http://wellformedweb.org/CommentAPI/"' .
  423. ' xmlns:dc="http://purl.org/dc/elements/1.1/">' .
  424. ' <channel>' .
  425. ' <title>Premature Optimization</title>' .
  426. // etc....
  427. '</rss>');
  428. $response = $client->request('GET');
  429. // ... continuez à parser $response...
  430. ]]></programlisting>
  431. </example>
  432. <para>
  433. L'exemple ci dessus montre comment préconfigurer la réponse qui sera retournée
  434. lors d'une requête de votre objet client. Ainsi lors des tests, votre application
  435. continuera de se comporter normalement, elle aura tout simplement été trompée (mock).
  436. Aucune connexion <acronym>HTTP</acronym> n'est dans ce cas là nécessaire.
  437. </para>
  438. <para>
  439. Quelques fois, plusieurs transactions <acronym>HTTP</acronym> peuvent être nécessaires. Une réponse
  440. peut demander une redirection, vers une autre. Dans ce cas, utiliser
  441. <methodname>setResponse()</methodname> toute seule n'est pas possible car il ne sera pas possible de
  442. spécifier les réponses suivantes, nécessaires alors à l'application.
  443. </para>
  444. <example id="zend.http.client.adapters.test.example-2">
  445. <title>Tester avec plusieurs réponses HTTP</title>
  446. <programlisting language="php"><![CDATA[
  447. // Création des objets adaptateur, et client
  448. $adapter = new Zend_Http_Client_Adapter_Test();
  449. $client = new Zend_Http_Client('http://www.example.com', array(
  450. 'adapter' => $adapter
  451. ));
  452. // Configuration de la première réponse attendue
  453. $adapter->setResponse(
  454. "HTTP/1.1 302 Found" . "\r\n" .
  455. "Location: /" . "\r\n" .
  456. "Content-Type: text/html" . "\r\n" .
  457. "\r\n" .
  458. '<html>' .
  459. ' <head><title>Moved</title></head>' .
  460. ' <body><p>This page has moved.</p></body>' .
  461. '</html>');
  462. // Configuration des réponses successives
  463. $adapter->addResponse(
  464. "HTTP/1.1 200 OK" . "\r\n" .
  465. "Content-Type: text/html" . "\r\n" .
  466. "\r\n" .
  467. '<html>' .
  468. ' <head><title>My Pet Store Home Page</title></head>' .
  469. ' <body><p>...</p></body>' .
  470. '</html>');
  471. // l'objet $client est prêt à être testé
  472. // son comportement est déja configuré
  473. ]]></programlisting>
  474. </example>
  475. <para>
  476. La méthode <methodname>setResponse()</methodname> détruit toutes les réponses dans le buffer
  477. de <classname>Zend_Http_Client_Adapter_Test</classname> et définit la première réponse
  478. qui sera retournée. La méthode <methodname>addResponse()</methodname> définit les réponses
  479. suivantes.
  480. </para>
  481. <para>Les réponses seront rejouées dans leur ordre d'ajout.</para>
  482. <para>
  483. Dans l'exemple ci-dessus, l'adaptateur est configuré pour un scénario de test de
  484. redirections 302. En fonction de votre application, le suivi d'une redirection peut être
  485. ou non désiré. Dans notre exemple, nous nous attendons à ce que la redirection soit
  486. suivie et nous configurons notre adaptateur de tests pour ceci. La réponse de
  487. redirection originelle (302) est définie avec la méthode <methodname>setResponse()</methodname>,
  488. quant à la réponse non redirigeante (200) suivante, elles est définie avec la méthode
  489. <methodname>addResponse()</methodname>. Lorsque votre objet client est configuré, vous pouvez
  490. l'injecter dans votre application à tester, et voir le résultat et les
  491. comportements.
  492. </para>
  493. <para>
  494. If you need the adapter to fail on demand you can use
  495. <methodname>setNextRequestWillFail($flag)</methodname>. The method will cause the next
  496. call to <methodname>connect()</methodname> to throw an
  497. <classname>Zend_Http_Client_Adapter_Exception</classname> exception. This can be useful
  498. when your application caches content from an external site (in case the site goes down)
  499. and you want to test this feature.
  500. </para>
  501. <example id="zend.http.client.adapters.test.example-3">
  502. <title>Forcing the adapter to fail</title>
  503. <programlisting language="php"><![CDATA[
  504. // Instantiate a new adapter and client
  505. $adapter = new Zend_Http_Client_Adapter_Test();
  506. $client = new Zend_Http_Client('http://www.example.com', array(
  507. 'adapter' => $adapter
  508. ));
  509. // Force the next request to fail with an exception
  510. $adapter->setNextRequestWillFail(true);
  511. try {
  512. // This call will result in a Zend_Http_Client_Adapter_Exception
  513. $client->request();
  514. } catch (Zend_Http_Client_Adapter_Exception $e) {
  515. // ...
  516. }
  517. // Further requests will work as expected until
  518. // you call setNextRequestWillFail(true) again
  519. ]]></programlisting>
  520. </example>
  521. </sect2>
  522. <sect2 id="zend.http.client.adapters.extending">
  523. <title>Créer vos propres adaptateurs de connexion</title>
  524. <para>
  525. Vous pouvez créer vos propres adaptateurs, si vous avez un besoin spécial à
  526. utiliser. Par exemple, des possibilités de cache, ou des sockets persistantes.
  527. </para>
  528. <para>
  529. Pour ceci, votre classe d'adaptateur doit implémenter l'interface
  530. <classname>Zend_Http_Client_Adapter_Interface</classname>. L'exemple suivant montre un
  531. squelette de classe. Toutes les méthodes publiques, ici, sont indispensables à la
  532. classe, elles sont issues de l'interface :
  533. </para>
  534. <example id="zend.http.client.adapters.extending.example-1">
  535. <title>Création de votre propre adaptateur de connexion</title>
  536. <programlisting language="php"><![CDATA[
  537. class MyApp_Http_Client_Adapter_BananaProtocol
  538. implements Zend_Http_Client_Adapter_Interface
  539. {
  540. /**
  541. * Définit le tableau de configuration pour cet adaptateur
  542. *
  543. * @param array $config
  544. */
  545. public function setConfig($config = array())
  546. {
  547. // Ceci change rarement, vous devriez copier l'implémentation
  548. // présente dans Zend_Http_Client_Adapter_Socket.
  549. }
  550. /**
  551. * Connecte à une serveur distant
  552. *
  553. * @param string $host
  554. * @param int $port
  555. * @param boolean $secure
  556. */
  557. public function connect($host, $port = 80, $secure = false)
  558. {
  559. // Etablit la connexion au serveur
  560. }
  561. /**
  562. * Envoie une requête au serveur
  563. *
  564. * @param string $method
  565. * @param Zend_Uri_Http $url
  566. * @param string $http_ver
  567. * @param array $headers
  568. * @param string $body
  569. * @return string Request as text
  570. */
  571. public function write($method,
  572. $url,
  573. $http_ver = '1.1',
  574. $headers = array(),
  575. $body = '')
  576. {
  577. // Envoie la requête au serveur distant. Cette fonction devrait
  578. // retourner la requête complète (en-tête et corps) as a string
  579. }
  580. /**
  581. * Lit la réponse du serveur
  582. *
  583. * @return string
  584. */
  585. public function read()
  586. {
  587. // Lit la réponse du serveur distant, et la retourne sous forme
  588. // de chaine de caractères
  589. }
  590. /**
  591. * Ferme la connexion avec le serveur
  592. *
  593. */
  594. public function close()
  595. {
  596. // Ferme la connexion, appelée en dernière.
  597. }
  598. }
  599. // Maintenant, vous pouvez utiliser cet adaptateur :
  600. $client = new Zend_Http_Client(array(
  601. 'adapter' => 'MyApp_Http_Client_Adapter_BananaProtocol'
  602. ));
  603. ]]></programlisting>
  604. </example>
  605. </sect2>
  606. </sect1>