Zend_Http_Client-Adapters.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20779 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.http.client.adapters">
  5. <title>Zend_Http_Client - Verbindungsadapter</title>
  6. <sect2 id="zend.http.client.adapters.overview">
  7. <title>Verbindungsadapter</title>
  8. <para>
  9. <classname>Zend_Http_Client</classname> basiert auf einem Design mit
  10. Verbindungsadaptern. Der Verbindungsadapter ist das Objekt, welches für die Ausführung
  11. der aktuellen Verbindung zum Server sowie für das Schreiben der Anfragen und Lesen von
  12. Antworten verantwortlich ist. Dieser Verbindungsadapter kann ersetzt werden und man kann
  13. den Standard Verbindungsadapter durch seinen eigenen Adapter erweitern, um ihn mit dem
  14. selben Interface auf seine eigenen Bedürfnisse anzupassen, ohne dass man die gesamte
  15. <acronym>HTTP</acronym> Client Klasse erweitern oder ersetzen muss.
  16. </para>
  17. <para>
  18. Derzeit stellt die <classname>Zend_Http_Client</classname> Klasse vier eingebaute
  19. Verbindungsadapter bereit:
  20. <itemizedlist>
  21. <listitem>
  22. <para>
  23. <classname>Zend_Http_Client_Adapter_Socket</classname> (Standard)
  24. </para>
  25. </listitem>
  26. <listitem>
  27. <para><classname>Zend_Http_Client_Adapter_Proxy</classname></para>
  28. </listitem>
  29. <listitem>
  30. <para><classname>Zend_Http_Client_Adapter_Curl</classname></para>
  31. </listitem>
  32. <listitem>
  33. <para><classname>Zend_Http_Client_Adapter_Test</classname></para>
  34. </listitem>
  35. </itemizedlist>
  36. </para>
  37. <para>
  38. Der Verbindungsadapter für das <classname>Zend_Http_Client</classname> Objekt wird durch
  39. Verwendung der 'adapter' Konfigurationsoption gesetzt. Beim Instanzieren des Client
  40. Objektes kann man die 'adapter' Konfigurationsoption setzen mit einem String, der den
  41. Adapternamen (z.B. 'Zend_Http_Client_Adapter_Socket') enthält, oder mit eine Variable,
  42. die ein Adapterobjekt (z.B. <code>new Zend_Http_Client_Adapter_Test</code>) enthält. Man
  43. kann den Adapter auch danach setzen, indem man die
  44. <classname>Zend_Http_Client->setConfig()</classname> Methode verwendet.
  45. </para>
  46. </sect2>
  47. <sect2 id="zend.http.client.adapters.socket">
  48. <title>Der Socket Adapter</title>
  49. <para>
  50. Der Standard-Adapter ist <classname>Zend_Http_Client_Adapter_Socket</classname>.
  51. Dieser wird benutzt, wenn kein anderer angegeben wird. Der Socket Adapter benutzt die
  52. native <acronym>PHP</acronym> Funktion fsockopen(), um die Verbindung aufzubauen, dafür
  53. werden keine besonderen Extensions oder Einstellungen benötigt.
  54. </para>
  55. <para>
  56. Der Socket Adapter erlaubt verschiedene zusätzliche Konfigurations Optionen die gesetzt
  57. werden können durch Verwendung von <classname>Zend_Http_Client->setConfig()</classname>
  58. oder deren Übergabe an den Konstruktor des Clients.
  59. <table id="zend.http.client.adapter.socket.configuration.table">
  60. <title>Zend_Http_Client_Adapter_Socket Konfigurations Parameter</title>
  61. <tgroup cols="4">
  62. <thead>
  63. <row>
  64. <entry>Parameter</entry>
  65. <entry>Beschreibung</entry>
  66. <entry>Erwarteter Typ</entry>
  67. <entry>Standardwert</entry>
  68. </row>
  69. </thead>
  70. <tbody>
  71. <row>
  72. <entry>persistent</entry>
  73. <entry>
  74. Ob eine persistente <acronym>TCP</acronym> Verbindung verwendet
  75. werden soll oder nicht
  76. </entry>
  77. <entry>boolean</entry>
  78. <entry><constant>FALSE</constant></entry>
  79. </row>
  80. <row>
  81. <entry>ssltransport</entry>
  82. <entry>Der Transport Layer für SSL (z.B. 'sslv2', 'tls')</entry>
  83. <entry>string</entry>
  84. <entry>ssl</entry>
  85. </row>
  86. <row>
  87. <entry>sslcert</entry>
  88. <entry>
  89. Pfad zu einem <acronym>PEM</acronym> verschlüsselten
  90. <acronym>SSL</acronym> Zertifikat
  91. </entry>
  92. <entry>string</entry>
  93. <entry><constant>NULL</constant></entry>
  94. </row>
  95. <row>
  96. <entry>sslpassphrase</entry>
  97. <entry>
  98. Die PassPhrase für die <acronym>SSL</acronym> zertifizierte Datei
  99. </entry>
  100. <entry>string</entry>
  101. <entry><constant>NULL</constant></entry>
  102. </row>
  103. </tbody>
  104. </tgroup>
  105. </table>
  106. <note>
  107. <title>Persistente TCP Verbindungen</title>
  108. <para>
  109. Die Verwendung persistenter <acronym>TCP</acronym> Verbindungen kann
  110. <acronym>HTTP</acronym> Anfragen potentiell schneller machen - aber in den
  111. meisten Fällen, wird es nur einen kleinen positiven Effekt haben und könnte den
  112. <acronym>HTTP</acronym> Server überladen zu dem man sich verbindet.
  113. </para>
  114. <para>
  115. Es wird empfohlen persistente <acronym>TCP</acronym> Verbindungen nur dann zu
  116. verwenden wenn man sich zu dem gleichen Server sehr oft verbindet, und man
  117. sicher ist das der Server eine große Anzahl an gleichzeitigen Verbindungen
  118. behandeln kann. In jedem Fall wird empfohlen das der Effekt von persistenten
  119. Verbindungen auf beiden, der Geschwindigkeit des Clients und dem Serverload
  120. gemessen wird bevor diese Option verwendet wird.
  121. </para>
  122. <para>
  123. Zusätzlich, wenn persistente Verbindungen verwendet werden, sollte man
  124. Keep-Alive <acronym>HTTP</acronym> Anfragen aktivieren wie in <xref
  125. linkend="zend.http.client.configuration" /> beschrieben - andernfalls werden
  126. persistente Verbindungen nur wenig oder gar keinen Effekt haben.
  127. </para>
  128. </note>
  129. <note>
  130. <title>HTTPS SSL Stream Parameter</title>
  131. <para>
  132. <code>ssltransport, sslcert</code> und <code>sslpassphrase</code> sind nur
  133. relevant wenn <acronym>HTTPS</acronym> für die Verbindung verwendet wird.
  134. </para>
  135. <para>
  136. Wärend die Standard <acronym>SSL</acronym> Einstellungen für die meisten
  137. Anwendungen funktionieren, kann es notwendig sein diese zu Ändern wenn der
  138. Server zu dem man sich verbindet ein spezielles Client Setup benötigt. Wenn dem
  139. so ist, sollte man das Kapitel über <acronym>SSL</acronym> Transport Layer und
  140. Optionen lesen das <ulink
  141. url="http://www.php.net/manual/en/transports.php#transports.inet">hier</ulink>
  142. zu finden ist.
  143. </para>
  144. </note>
  145. </para>
  146. <example id="zend.http.client.adapters.socket.example-1">
  147. <title>Den Stream-Typen für eine HTTPS Verbindung einstellen</title>
  148. <programlisting language="php"><![CDATA[
  149. // Konfigurationsparameter setzen
  150. $config = array(
  151. 'adapter' => 'Zend_Http_Client_Adapter_Socket',
  152. 'ssltransport' => 'tls'
  153. );
  154. // Client-Instanz erzeugen
  155. $client = new Zend_Http_Client('https://www.example.com', $config);
  156. // Jetzt wird der Request über eine verschlüsselte Verbindung verschickt
  157. $response = $client->request();
  158. ]]></programlisting>
  159. </example>
  160. <para>
  161. Ein ähnliches Ergebnis erzielt man mit folgendem Code:
  162. </para>
  163. <para>
  164. <methodname>fsockopen('tls://www.example.com', 443)</methodname>
  165. </para>
  166. <sect3 id="zend.http.client.adapters.socket.streamcontext">
  167. <title>Anpassen und Zugreifen auf den Socket Adapter Stream Kontext</title>
  168. <para>
  169. Beginnend mit Zend Framework 1.9 bietet
  170. <classname>Zend_Http_Client_Adapter_Socket</classname> direkten Zugriff auf den
  171. darunterliegenden <ulink
  172. url="http://php.net/manual/de/stream.contexts.php">Stream Kontext</ulink> der
  173. für die Verbindung zum entfernten Server verwendet wird. Das erlaubt es
  174. Benutzern spezielle Optionen und Parameter an den <acronym>TCP</acronym> Stream zu
  175. übergeben und an den <acronym>SSL</acronym> Wrapper im Falle einer
  176. <acronym>HTTPS</acronym> Verbindung.
  177. </para>
  178. <para>
  179. Man kann auf den Stream Kontext zugreifen indem die folgenden Methoden von
  180. <classname>Zend_Http_Client_Adapter_Socket</classname> verwendet werden:
  181. <itemizedlist>
  182. <listitem>
  183. <para>
  184. <firstterm><methodname>setStreamContext($context)</methodname></firstterm>
  185. Setzt den Stream Kontext der vom Adapter verwendet werden soll.
  186. Akzeptiert entweder eine Stream Kontext Ressource von durch die
  187. Verwendung der <acronym>PHP</acronym> Funktion <ulink
  188. url="http://php.net/manual/de/function.stream-context-create.php"><methodname>stream_context_create()</methodname></ulink>
  189. erstellt wurde, oder ein Array von Stream Kontext Optionen im
  190. gleichen Format wie es an diese Funktion übergeben wird. Wenn ein
  191. Array übergeben wird, dann wird ein neuer Stream Kontext mit Hilfe
  192. dieser Optionen erstellt, und gesetzt.
  193. </para>
  194. </listitem>
  195. <listitem>
  196. <para>
  197. <firstterm><methodname>getStreamContext()</methodname></firstterm>
  198. Empfängt den Stream Kontext des Adapters. Wenn kein Stream Kontext
  199. gesetzt ist, wird ein standardmäßiger Stream Kontext erstellt und
  200. zurückgegeben. Man kann anschließend den Wert verschiedener Kontext
  201. Optionen setzen oder empfangen indem die regulären
  202. <acronym>PHP</acronym> Stream Kontext Funktionen verwendet werden.
  203. </para>
  204. </listitem>
  205. </itemizedlist>
  206. </para>
  207. <example id="zend.http.client.adapters.socket.streamcontext.example-1">
  208. <title>Setzen von Stream Kontext Optionen für den Socket Adapter</title>
  209. <programlisting language="php"><![CDATA[
  210. // Array von Optionen
  211. $options = array(
  212. 'socket' => array(
  213. // Bindet die lokale Socket Seite an ein spezifisches Interface
  214. 'bindto' => '10.1.2.3:50505'
  215. ),
  216. 'ssl' => array(
  217. // Prüft das Server Side Zertifikat, akzeptiert keine
  218. // ungültigen oder selbst-signierten SSL Zertifikate
  219. 'verify_peer' => true,
  220. 'allow_self_signed' => false,
  221. // Holt das Peer Zertifikat
  222. 'capture_peer_cert' => true
  223. )
  224. );
  225. // Erstellt ein Adapter Objekt und hängt es an den HTTP Client
  226. $adapter = new Zend_Http_Client_Adapter_Socket();
  227. $client = new Zend_Http_Client();
  228. $client->setAdapter($adapter);
  229. // Methode 1: Ein Options Array an setStreamContext() übergeben
  230. $adapter->setStreamContext($options);
  231. // Methode 2: Einen Stream Kontext erstellen und an setStreamContext() übergeben
  232. $context = stream_context_create($options);
  233. $adapter->setStreamContext($context);
  234. // Methode 3: Den Standardmäßigen Stream Kontext holen und Optionen auf Ihm setzen
  235. $context = $adapter->getStreamContext();
  236. stream_context_set_option($context, $options);
  237. // Jetzt die Anfrage durchführen
  238. $response = $client->request();
  239. // Wenn alles gut ging, kann auf den Kontext jetzt zugegriffen werden
  240. $opts = stream_context_get_options($adapter->getStreamContext());
  241. echo $opts['ssl']['peer_certificate'];
  242. ]]></programlisting>
  243. </example>
  244. <note>
  245. <para>
  246. Es ist zu beachten das alle Stream Kontext Optionen gesetzt sein müssen bevor
  247. der Adapter Anfragen durchführt. Wenn kein Kontext gesetzt ist bevor
  248. <acronym>HTTP</acronym> Anfragen mit dem Socket Adapter durchgeführt werden,
  249. wird ein standardmäßiger Stream Kontext erstellt. Auf diese Kontext Ressource
  250. kann zugegriffen werden nachdem Anfragen durchgeführt werden indem die
  251. <methodname>getStreamContext()</methodname> Methode verwendet wird.
  252. </para>
  253. </note>
  254. </sect3>
  255. </sect2>
  256. <sect2 id="zend.http.client.adapters.proxy">
  257. <title>Der Proxy Adapter</title>
  258. <para>
  259. Der Proxy Adapter <classname>Zend_Http_Client_Adapter_Proxy</classname> verhält sich wie
  260. der standard <classname>Zend_Http_Client_Adapter_Socket</classname>, mit dem
  261. Unterschied, dass die Verbindung über einen <acronym>HTTP</acronym> Proxy-Server
  262. aufgebaut wird statt den Server direkt zu kontaktieren. Das erlaubt die Verwendung von
  263. <classname>Zend_Http_Client</classname> hinter Proxy Servern - was manchmal wegen der
  264. Sicherheit und Geschwindigkeit notwendig ist.
  265. </para>
  266. <para>
  267. Der Proxy Adapter benötigt zusätzliche Konfigurationsvariablen, die
  268. nachfolgend gelistet sind.
  269. <table id="zend.http.client.adapters.proxy.table">
  270. <title>Zend_Http_Client Konfigurationsparameter</title>
  271. <tgroup cols="4">
  272. <thead>
  273. <row>
  274. <entry>Parameter</entry>
  275. <entry>Beschreibung</entry>
  276. <entry>Datentyp</entry>
  277. <entry>Beispielwert</entry>
  278. </row>
  279. </thead>
  280. <tbody>
  281. <row>
  282. <entry>proxy_host</entry>
  283. <entry>Proxy Server Adresse</entry>
  284. <entry>string</entry>
  285. <entry>zum Beispiel 'proxy.myhost.com' oder '10.1.2.3'</entry>
  286. </row>
  287. <row>
  288. <entry>proxy_port</entry>
  289. <entry><acronym>TCP</acronym> Port des Proxy-Servers</entry>
  290. <entry>integer</entry>
  291. <entry>8080 (Standardwert) oder 81</entry>
  292. </row>
  293. <row>
  294. <entry>proxy_user</entry>
  295. <entry>Benutzername für die Proxynutzung, falls nötig</entry>
  296. <entry>string</entry>
  297. <entry>'wulli' oder '' für keinen Namen (Standardwert)</entry>
  298. </row>
  299. <row>
  300. <entry>proxy_pass</entry>
  301. <entry>Passwort für die Proxynutzung, falls nötig</entry>
  302. <entry>string</entry>
  303. <entry>'geheim' oder '' für kein Passwort (Standardwert)</entry>
  304. </row>
  305. <row>
  306. <entry>proxy_auth</entry>
  307. <entry>Proxy <acronym>HTTP</acronym> Authentifizierungs-Typ</entry>
  308. <entry>string</entry>
  309. <entry>Zend_Http_Client::AUTH_BASIC (Standardwert)</entry>
  310. </row>
  311. </tbody>
  312. </tgroup>
  313. </table>
  314. </para>
  315. <para>
  316. proxy_host muss immer gesetzt werden, ansonsten wird der Proxy-Adapter auf
  317. <classname>Zend_Http_Client_Adapter_Socket</classname> zurückgreifen und keinen Proxy
  318. Server benutzen. Wird kein Prot mit übergeben, so versucht der Proxy-Adapter sich auf
  319. den Standardport '8080' zu verbinden.
  320. </para>
  321. <para>
  322. proxy_user und proxy_pass werden nur dann benötigt, wenn der Proxy-Server
  323. tatsächlich eine Authentifizierung erwartet. Werden diese Parameter mit
  324. übergeben, setzt der Proxy-Adapter zusätzlich den 'Proxy-Authentication'
  325. Header bei Anfragen. Wird keine Authentifizierung benötigt, sollten die
  326. beiden Parameter weggelassen werden.
  327. </para>
  328. <para>
  329. proxy_auth setzt den Authentifizierungs-Typ. Dies ist nur nötig, wenn der
  330. Proxy-Server eine Authentifizierung erwartet.
  331. Mögliche Werte entsprechen denen der Zend_Http_Client::setAuth() Methode.
  332. Zur Zeit wird nur die BASIC-Authentifizierung
  333. (Zend_Http_Client::AUTH_BASIC) unterstützt.
  334. </para>
  335. <example id="zend.http.client.adapters.proxy.example-1">
  336. <title>Zend_Http_Client hinter einem Proxy-Server nutzen</title>
  337. <programlisting language="php"><![CDATA[
  338. // Konfigurationsparameter setzen
  339. $config = array(
  340. 'adapter' => 'Zend_Http_Client_Adapter_Proxy',
  341. 'proxy_host' => 'proxy.int.zend.com',
  342. 'proxy_port' => 8000,
  343. 'proxy_user' => 'shahar.e',
  344. 'proxy_pass' => 'bananashaped'
  345. );
  346. // Client-Objekt instanziieren
  347. $client = new Zend_Http_Client('http://www.example.com', $config);
  348. // $client kann jetzt wie gewohnt benutzt werden
  349. ]]></programlisting>
  350. </example>
  351. <para>
  352. Wie vorher erwähnt, nutzt der Proxy-Adapter eine einfache Socket-Verbindung,
  353. wenn proxy_host nicht gesetzt oder leer gelassen wurde. Dies ermöglicht
  354. die optionale Nutzung eines Proxy-Servers, abhängig von dem proxy_host Parameter.
  355. </para>
  356. <note>
  357. <para>
  358. Da der Proxy Adapter von <classname>Zend_Http_Client_Adapter_Socket</classname>
  359. abgeleitet ist, kann die Stream Kontext Zugriffsmethode verwendet werden
  360. (siehe <xref linkend="zend.http.client.adapters.socket.streamcontext" />) um
  361. Stream Kontext Optionen auf Proxy Verbindungen zu setzen wie es oben demonstriert
  362. wurde.
  363. </para>
  364. </note>
  365. </sect2>
  366. <sect2 id="zend.http.client.adapters.curl">
  367. <title>Der cURL Adapter</title>
  368. <para>
  369. cURL ist eine Standard <acronym>HTTP</acronym> Client Bibliothek die mit vielen
  370. Betriebssystemen ausgeliefert wird, und kann in <acronym>PHP</acronym> über die cURL
  371. Erweiterung verwendet werden. Sie bietet Funktionalitäten für viele spezielle Fälle die
  372. für einen <acronym>HTTP</acronym> Client auftreten können und machen sie zu einer
  373. perfekten Wahl für einen <acronym>HTTP</acronym> Adapter. Sie unterstützt sichere
  374. Verbindungen, Proxies, alle Arten von Authentifizierungsmechanismen und glänzt in
  375. Anwendungen die große Dateien zwischen Servern bewegen müssen.
  376. </para>
  377. <example id="zend.http.client.adapters.curl.example-1">
  378. <title>Setzen von cURL Optionen</title>
  379. <programlisting language="php"><![CDATA[
  380. $config = array(
  381. 'adapter' => 'Zend_Http_Client_Adapter_Curl',
  382. 'curloptions' => array(CURLOPT_FOLLOWLOCATION => true),
  383. );
  384. $client = new Zend_Http_Client($uri, $config);
  385. ]]></programlisting>
  386. </example>
  387. <para>
  388. Standardmäßig ist der cURL Adapter so konfiguriert das er sich genauso wie der
  389. Socket Adapter verhält und er akzeptiert auch die gleichen Konfigurationsparameter wie
  390. die Socket und Proxy Adapter. Man kann die cURL Optionen entweder durch den
  391. 'curloptions' Schlüssel im Konstruktor des Adapters, oder durch den Aufruf von
  392. <methodname>setCurlOption($name, $value)</methodname>, verändern. Der
  393. <varname>$name</varname> Schlüssel entspricht den CURL_* Konstanten der cURL
  394. Erweiterung. Man kann auf den CURL Handler durch den Aufruf von
  395. <code>$adapter->getHandle();</code> Zugriff erhalten.
  396. </para>
  397. <example id="zend.http.client.adapters.curl.example-2">
  398. <title>Dateien von Hand übertragen</title>
  399. <para>
  400. Man kan cURL verwenden um große Dateien über <acronym>HTTP</acronym> durch einen
  401. Dateihandle zu übertragen.
  402. </para>
  403. <programlisting language="php"><![CDATA[
  404. $putFileSize = filesize("filepath");
  405. $putFileHandle = fopen("filepath", "r");
  406. $adapter = new Zend_Http_Client_Adapter_Curl();
  407. $client = new Zend_Http_Client();
  408. $client->setAdapter($adapter);
  409. $adapter->setConfig(array(
  410. 'curloptions' => array(
  411. CURLOPT_INFILE => $putFileHandle,
  412. CURLOPT_INFILESIZE => $putFileSize
  413. )
  414. ));
  415. $client->request("PUT");
  416. ]]></programlisting>
  417. </example>
  418. </sect2>
  419. <sect2 id="zend.http.client.adapters.test">
  420. <title>Der Test Adapter</title>
  421. <para>
  422. Manchmal ist es sehr schwer Code zu testen, der von <acronym>HTTP</acronym> Verbindungen
  423. abhängig ist. Zum Beispiel verlangt das Testen einer Applikation, die einen
  424. <acronym>RSS</acronym> Feed von einem fremden Server anfordert, eine Netzwerkverbindung,
  425. die nicht immer verfügbar ist.
  426. </para>
  427. <para>
  428. Aus diesem Grund wird der <classname>Zend_Http_Client_Adapter_Test</classname> Adapter
  429. bereit gestellt. Man kann seine eigenen Applikationen schreiben, um
  430. <classname>Zend_Http_Client</classname> zu verwenden, und nur zu Testzwecken, z.B. in
  431. der Unit Test Suite, den Standardadapter durch den Testadapter (ein Mock Objekt)
  432. austauschen, um Tests ohne direkte Serverbindungen auszuführen.
  433. </para>
  434. <para>
  435. Der <classname>Zend_Http_Client_Adapter_Test</classname> Adapter stellt die zusätzliche
  436. Methode setResponse() bereit. Diese Methode nimmt einen Parameter entgegen, der eine
  437. <acronym>HTTP</acronym> Antwort entweder als Text oder als
  438. <classname>Zend_Http_Response</classname> Objekt repräsentiert. Einmal eingerichtet,
  439. wird der Testadapter immer diese Antwort zurückgeben, ohne tatsächlich eine
  440. <acronym>HTTP</acronym> Anfrage auszuführen.
  441. </para>
  442. <example id="zend.http.client.adapters.test.example-1">
  443. <title>Testen gegen einen einfachen HTTP Response Stumpf</title>
  444. <programlisting language="php"><![CDATA[
  445. // Instanziere einen neuen Adapter und Client
  446. $adapter = new Zend_Http_Client_Adapter_Test();
  447. $client = new Zend_Http_Client('http://www.example.com', array(
  448. 'adapter' => $adapter
  449. ));
  450. // Setze die erwartete Antwort
  451. $adapter->setResponse(
  452. "HTTP/1.1 200 OK" . "\r\n" .
  453. "Content-type: text/xml" . "\r\n" .
  454. "\r\n" .
  455. '<?xml version="1.0" encoding="UTF-8"?>' .
  456. '<rss version="2.0" ' .
  457. ' xmlns:content="http://purl.org/rss/1.0/modules/content/"' .
  458. ' xmlns:wfw="http://wellformedweb.org/CommentAPI/"' .
  459. ' xmlns:dc="http://purl.org/dc/elements/1.1/">' .
  460. ' <channel>' .
  461. ' <title>Premature Optimization</title>' .
  462. // und so weiter...
  463. '</rss>');
  464. $response = $client->request('GET');
  465. // .. setze die Verarbeitung von $response fort...
  466. ]]></programlisting>
  467. </example>
  468. <para>
  469. Das obige Beispiel zeigt, wie man einen <acronym>HTTP</acronym> Client voreinstellen
  470. kann, damit er die benötigte Antwort zurückgibt. Danach kann man mit den Testen des
  471. eigenen Codes weiter machen, ohne von einer Netzwerkverbindung, der Serverantwort, etc.
  472. abhängig zu sein. In diesem Fall würde der Test mit der Prüfung fortfahren, wie die
  473. Applikation das <acronym>XML</acronym> aus der Antwort verarbeitet..
  474. </para>
  475. <para>
  476. Manchmal erfordert ein einziger Methoden-Aufruf mehrere <acronym>HTTP</acronym>
  477. Übertragungen. In diesem Fall ist es nicht möglich setResponse() alleine zu verwenden
  478. weil es keine Möglichkeit gibt die nächste Antwort zu setzen die das Programm benötigt
  479. bevor es zum Aufrufer zurückkommt.
  480. </para>
  481. <example id="zend.http.client.adapters.test.example-2">
  482. <title>Test mit mehreren HTTP-Antworten</title>
  483. <programlisting language="php"><![CDATA[
  484. // Instanzen vom Adapter und Client erzeugen
  485. $adapter = new Zend_Http_Client_Adapter_Test();
  486. $client = new Zend_Http_Client('http://www.example.com', array(
  487. 'adapter' => $adapter
  488. ));
  489. // mit setResponse() die erste Antwort setzen
  490. $adapter->setResponse(
  491. "HTTP/1.1 302 Found" . "\r\n" .
  492. "Location: /" . "\r\n" .
  493. "Content-Type: text/html" . "\r\n" .
  494. "\r\n" .
  495. '<html>' .
  496. ' <head><title>Moved</title></head>' .
  497. ' <body><p>This page has moved.</p></body>' .
  498. '</html>');
  499. // mit addResponse() nachfolgende Antworten setzen
  500. $adapter->addResponse(
  501. "HTTP/1.1 200 OK" . "\r\n" .
  502. "Content-Type: text/html" . "\r\n" .
  503. "\r\n" .
  504. '<html>' .
  505. ' <head><title>Meine Haustierseite</title></head>' .
  506. ' <body><p>...</p></body>' .
  507. '</html>');
  508. // Das $client Objekt kann jetzt zu testzwecken herangezogen werden,
  509. // indem es wie ein normales Client-Objekt benutzt wird.
  510. ]]></programlisting>
  511. </example>
  512. <para>
  513. Die setResponse() Methode löscht alle Antworten im Buffer von
  514. <classname>Zend_Http_Client_Adapter_Test</classname> und setzt die erste Antwort
  515. die zurückgegeben wird. Die addResponse() Methode fügt dann weitere Antworten
  516. sukzessiv hinzu.
  517. </para>
  518. <para>
  519. Die HTTP-Antworten werden in der Reihenfolge zurückgegeben,
  520. in der sie angelegt worden sind. Gibt es mehr Anfragen als
  521. Antworten, so wird wieder bei der ersten Antwort angefangen.
  522. </para>
  523. <para>
  524. Das oben angeführte Beispiel kann dazu benutzt werden, um die Reaktion
  525. der eigenen Anwendung auf einen 302 Redirect (Weiterleitung) zu testen.
  526. Abhängig von Ihrer Anwendung, kann es gewollt oder nicht gewollt sein,
  527. dass dem Redirect gefolgt wird. In unserem Beispiel erwarten wir das der
  528. Umleitung gefolgt wird und wir konfigurieren den Test Adapter um uns zu helfen das
  529. zu Testen. Die ursprüngliche 302 Antwort wird mit der setResponse() Methode gesetzt
  530. und die 200 Antwort welche als nächstes zurückzugeben ist wird mit der
  531. addResponse() Methode hinzugefügt. Nachdem der Test Adapter konfiguriert ist, wird
  532. der <acronym>HTTP</acronym> Client der den Adapter enthält unter test in das eigene
  533. Objekt injiziert und sein Verhalten getestet.
  534. </para>
  535. <para>
  536. Wenn man will das der Adapter auf Wunsch fehlschlägt kann man
  537. <methodname>setNextRequestWillFail($flag)</methodname> verwenden. Diese Methode lässt
  538. den Nächsten Aufruf von <methodname>connect()</methodname> eine
  539. <classname>Zend_Http_Client_Adapter_Exception</classname> Exception geworfen. Das kann
  540. dann nützlich sein wenn die eigene Anwendung Inhalte von einer externen Seite cacht
  541. (im Falle das die Seite ausfällt) und man dieses Feature testen will.
  542. </para>
  543. <example id="zend.http.client.adapters.test.example-3">
  544. <title>Erzwingen das der Adapter fehlschlägt</title>
  545. <programlisting language="php"><![CDATA[
  546. // Einen neuen Adapter und Client instanziieren
  547. $adapter = new Zend_Http_Client_Adapter_Test();
  548. $client = new Zend_Http_Client('http://www.example.com', array(
  549. 'adapter' => $adapter
  550. ));
  551. // Erzwingen das die nächste Anfrage mit einer Exception fehlschlägt
  552. $adapter->nextRequestWillFail(true);
  553. try {
  554. // Dieser Aufruf führt zu einer Zend_Http_Client_Adapter_Exception
  555. $client->request();
  556. } catch (Zend_Http_Client_Adapter_Exception $e) {
  557. // ...
  558. }
  559. // Weitere Aufrufe arbeiten wie erwartet bis man setNextRequestWillFail(true)
  560. // erneut aufruft
  561. ]]></programlisting>
  562. </example>
  563. </sect2>
  564. <sect2 id="zend.http.client.adapters.extending">
  565. <title>Einen eigenen Adapter erstellen</title>
  566. <para>
  567. Es ist möglich eigene Verbindungs-Adapter zu schreiben, die spezielle
  568. Bedürfnisse, wie persistente Sockets oder gecachte Verbindungen, abdecken.
  569. Diese können dann, wie gewohnt in der eigenen Anwendung benutzt werden können.
  570. </para>
  571. <para>
  572. Um einen neuen Adapter zu erstellen, muss eine neue Klasse angelegt werden,
  573. die das <classname>Zend_Http_Client_Adapter_Interface</classname> implementiert.
  574. Nachfolgend finden Sie ein Gerüst für einen neuen Adapter. Die public-Methoden müssen
  575. unbedingt implementiert werden.
  576. </para>
  577. <example id="zend.http.client.adapters.extending.example-1">
  578. <title>Gerüst für einen eigenen Verbindungs-Adapter</title>
  579. <programlisting language="php"><![CDATA[
  580. class MyApp_Http_Client_Adapter_BananaProtocol
  581. implements Zend_Http_Client_Adapter_Interface
  582. {
  583. /**
  584. * Konfigurationsarray für den Adapter
  585. *
  586. * @param array $config
  587. */
  588. public function setConfig($config = array())
  589. {
  590. // in den meisten Fällen kann die Implementierung von
  591. // Zend_Http_Client_Adapter_Socket eins zu eins übernommen werden
  592. }
  593. /**
  594. * Zum Server verbinden
  595. *
  596. * @param string $host
  597. * @param int $port
  598. * @param boolean $secure
  599. */
  600. public function connect($host, $port = 80, $secure = false)
  601. {
  602. // Verbindung zum Server herstellen
  603. }
  604. /**
  605. * Anfrage / Request an den Server stellen
  606. *
  607. * @param string $method
  608. * @param Zend_Uri_Http $url
  609. * @param string $http_ver
  610. * @param array $headers
  611. * @param string $body
  612. * @return string Request as text
  613. */
  614. public function write($method,
  615. $url,
  616. $http_ver = '1.1',
  617. $headers = array(),
  618. $body = '')
  619. {
  620. // Anfrage stellen
  621. // Diese Methode muss die komplette Antwort zurückliefern,
  622. // inklusive aller Header
  623. }
  624. /**
  625. * Antwort des Servers auslesen
  626. *
  627. * @return string
  628. */
  629. public function read()
  630. {
  631. // Antwort des Servers lesen und als String zurückgeben
  632. }
  633. /**
  634. * Verbindung zum Server beenden
  635. *
  636. */
  637. public function close()
  638. {
  639. // Verbindung beenden - wird zum Schluss aufgerufen
  640. }
  641. }
  642. // Jetzt kann der Adapter benutzt werden:
  643. $client = new Zend_Http_Client(array(
  644. 'adapter' => 'MyApp_Http_Client_Adapter_BananaProtocol'
  645. ));
  646. ]]></programlisting>
  647. </example>
  648. </sect2>
  649. </sect1>