Zend_Http_Client.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.http.client">
  5. <title>Einführung</title>
  6. <para>
  7. Zend_Http_Client stellt eine einfache Schnittstelle für das Durchführen von Hyper-Text
  8. Transfer Protocol (HTTP) Anfragen. Zend_Http_Client unterstützt die meisten einfachen
  9. Funktionen, die man von einem HTTP Client erwartet, sowie einige komplexere Funktionen,
  10. wie z.B. HTTP Authentifizierung und Dateiuploads. Erfolgreiche Anfragen (und die meisten
  11. nicht erfolgreichen ebenfalls) liefern ein Zend_Http_Response Objekt zurück, welches den
  12. Zugriff auf die Header und den Hauptteil der Antwort ermöglichen (siehe
  13. <xref linkend="zend.http.response" />).
  14. </para>
  15. <sect2 id="zend.http.client.usage">
  16. <title>Zend_Http_Client verwenden</title>
  17. <para>
  18. Der Klassenkonstruktor akzeptiert optional eine URL als seinen ersten Parameter (kann
  19. entweder ein String oder ein Zend_Uri_Http Objekt sein) und ein optionales Array mit
  20. Konfigurationsparametern. Beides kann ausgelassen und später durch Verwendung der
  21. setUri() and setConfig() Methoden gesetzt werden.
  22. <example id="zend.http.client.introduction.example-1">
  23. <title>Ein Zend_Http_Client Objekt instanzieren</title>
  24. <programlisting language="php"><![CDATA[
  25. $client = new Zend_Http_Client('http://example.org', array(
  26. 'maxredirects' => 0,
  27. 'timeout' => 30));
  28. // Dies macht genau das selbe:
  29. $client = new Zend_Http_Client();
  30. $client->setUri('http://example.org');
  31. $client->setConfig(array(
  32. 'maxredirects' => 0,
  33. 'timeout' => 30));
  34. ]]></programlisting>
  35. </example>
  36. <note><para>
  37. Zend_Http_Client verwendet Zend_Uri_Http um URLs zu prüfen. Das bedeutet das einige
  38. spezielle Zeichen wie das Pipe-Symbol ('|') oder das Karet Symbol ('^') in der URL
  39. standardmäßig nicht akzeptiert werden.
  40. Das kann geändert werden indem die 'allow_unwise' Option von Zend_Uri auf 'true'
  41. gesetzt wird. Siehe <xref linkend="zend.uri.validation.allowunwise" /> für mehr
  42. Informationen.
  43. </para></note>
  44. </para>
  45. </sect2>
  46. <sect2 id="zend.http.client.configuration">
  47. <title>Konfigurationsparameter</title>
  48. <para>
  49. Der Konstruktor und die setConfig() Methode akzeptieren ein assoziatives Array mit
  50. Konfigurationsparametern. Das Setzen dieser Parameter ist optional, da alle einen
  51. Standardwert haben.
  52. <table id="zend.http.client.configuration.table">
  53. <title>Zend_Http_Client Konfigurationsparameter</title>
  54. <tgroup cols="4">
  55. <thead>
  56. <row>
  57. <entry>Parameter</entry>
  58. <entry>Beschreibung</entry>
  59. <entry>Erwartete Werte</entry>
  60. <entry>Standardwert</entry>
  61. </row>
  62. </thead>
  63. <tbody>
  64. <row>
  65. <entry>maxredirects</entry>
  66. <entry>Maximale Anzahl von zu folgenden Umleitungen (0 = keine)</entry>
  67. <entry>integer</entry>
  68. <entry>5</entry>
  69. </row>
  70. <row>
  71. <entry>strict</entry>
  72. <entry>Ob Prüfungen an Headernamen durchzuführen sind. Einige
  73. Prüf-Funktionen werden übersprungen wenn auf false gesetzt.
  74. Sollte normalerweise nicht geändert werden</entry>
  75. <entry>boolean</entry>
  76. <entry>true</entry>
  77. </row>
  78. <row>
  79. <entry>strictredirects</entry>
  80. <entry>Ob beim Umleiten genau dem RFC zu folgen ist (siehe
  81. <xref linkend="zend.http.client.redirections" />)</entry>
  82. <entry>boolean</entry>
  83. <entry>false</entry>
  84. </row>
  85. <row>
  86. <entry>useragent</entry>
  87. <entry>String zur Identifizierung des User Agents (gesendet in den
  88. Anfrageheadern)</entry>
  89. <entry>string</entry>
  90. <entry>'Zend_Http_Client'</entry>
  91. </row>
  92. <row>
  93. <entry>timeout</entry>
  94. <entry>Zeitüberschreitung für Verbindungen (Sekunden)</entry>
  95. <entry>integer</entry>
  96. <entry>10</entry>
  97. </row>
  98. <row>
  99. <entry>httpversion</entry>
  100. <entry>
  101. Version des HTTP Protokolls (normalerweise '1.1' oder '1.0')
  102. </entry>
  103. <entry>string</entry>
  104. <entry>'1.1'</entry>
  105. </row>
  106. <row>
  107. <entry>adapter</entry>
  108. <entry>Zu verwendene Adapterklasse für die Verbindung (siehe
  109. <xref linkend="zend.http.client.adapters" />)</entry>
  110. <entry>mixed</entry>
  111. <entry>'Zend_Http_Client_Adapter_Socket'</entry>
  112. </row>
  113. <row>
  114. <entry>keepalive</entry>
  115. <entry>
  116. Ob keep-alive Verbindungen mit dem Server aktiviert werden sollen.
  117. Nützlich und kann die Performance verbessern, wenn mehrere
  118. aufeinanderfolgend Anfragen an den selben Server ausgeführt werden.
  119. </entry>
  120. <entry>boolean</entry>
  121. <entry>false</entry>
  122. </row>
  123. <row>
  124. <entry>storeresponse</entry>
  125. <entry>
  126. Ob die letzte Antwort für einen späteren Aufruf von
  127. getLastResponse() gespeichert werden soll. Wird sie auf false
  128. gesetzt gibt getLastResponse() null zurück.
  129. </entry>
  130. <entry>boolean</entry>
  131. <entry>true</entry>
  132. </row>
  133. </tbody>
  134. </tgroup>
  135. </table>
  136. </para>
  137. </sect2>
  138. <sect2 id="zend.http.client.basic-requests">
  139. <title>Durchführen von einfachen HTTP Anfragen</title>
  140. <para>
  141. Das Durchführen von einfachen HTTP Anfragen kann sehr leicht durch Verwendung der
  142. request() Methode gemacht werden und benötigt selten mehr als drei Codezeilen:
  143. <example id="zend.http.client.basic-requests.example-1">
  144. <title>Durchführen einer einfache GET Anfrage</title>
  145. <programlisting language="php"><![CDATA[
  146. $client = new Zend_Http_Client('http://example.org');
  147. $response = $client->request();
  148. ]]></programlisting>
  149. </example>
  150. Die request() Methode akzeptiert einen optionalen Parameter - die Anfragemethode.
  151. Diese kann GET, POST, PUT, HEAD, DELETE, TRACE, OPTIONS oder CONNECT sein, wie im HTTP
  152. Protokoll definiert.
  153. <footnote>
  154. <para>
  155. Siehe RFC 2616 - <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616.html" />.
  156. </para>
  157. </footnote>.
  158. Zur Erleichterung sind alle als Klassenkonstanten definiert:
  159. Zend_Http_Client::GET, Zend_Http_Client::POST und so weiter.
  160. </para>
  161. <para>
  162. Wenn keine Methode angegeben worden ist, wird die durch den letzten Aufruf von
  163. setMethod() gesetzte Methode verwendet. Wenn setMethod() vorher nicht aufgerufen worden
  164. ist, wird als Standardmethode GET verwendet (siehe obiges Beispiel).
  165. <example id="zend.http.client.basic-requests.example-2">
  166. <title>Andere Anfragemethoden als GET verwenden</title>
  167. <programlisting language="php"><![CDATA[
  168. // Durchführen einer POST Anfrage
  169. $response = $client->request('POST');
  170. // Ein weiterer Weg, eine POST Anfrage durchzuführen
  171. $client->setMethod(Zend_Http_Client::POST);
  172. $response = $client->request();
  173. ]]></programlisting>
  174. </example>
  175. </para>
  176. </sect2>
  177. <sect2 id="zend.http.client.parameters">
  178. <title>Hinzufügen von GET und POST Parametern</title>
  179. <para>
  180. Das Hinzufügen von GET Parametern zu einer HTTP Anfrage ist recht einfach und kann
  181. entweder über die Angabe als Teil der URL oder durch Verwendung der setParameterGet()
  182. Methode erfolgen.
  183. Diese Methode benötigt den Namen des GET Parameter als seinen ersten Parameter und den
  184. Wert des GET Parameter als seinen zweiten Parameter. Zur Erleichterung akzeptiert die
  185. setParameterGet() Methode auch ein einzelnes assoziatives Array mit GET Parameter als
  186. Name => Wert Variablen, was beim setzen von mehreren GET Parametern komfortabler sein
  187. kann.
  188. <example id="zend.http.client.parameters.example-1">
  189. <title>Setzen von GET Parametern</title>
  190. <programlisting language="php"><![CDATA[
  191. // Setzen eines GET Parameter mit der setParameterGet Methode
  192. $client->setParameterGet('knight', 'lancelot');
  193. // Dies ist äquivalent durch Setzen der URL:
  194. $client->setUri('http://example.com/index.php?knight=lancelot');
  195. // Hinzufügen mehrerer Parameter durch einen Aufruf
  196. $client->setParameterGet(array(
  197. 'first_name' => 'Bender',
  198. 'middle_name' => 'Bending'
  199. 'made_in' => 'Mexico',
  200. ));
  201. ]]></programlisting>
  202. </example>
  203. </para>
  204. <para>
  205. Während GET Parameter bei jeder Anfragemethode gesetzt werden können, können POST
  206. Parameter nur im Hauptteil von POST Anfragen versendet werden. Das Hinzufügen von POST
  207. Parameter zu einer Anfrage ist sehr ähnlich wie das Hinzufügen von GET Parametern and
  208. kann mit der setParameterPost() Methode gemacht werden, die vom Aufbau der
  209. setParameterGet() Methode ähnlich ist..
  210. <example id="zend.http.client.parameters.example-2">
  211. <title>Setzen von POST Parametern</title>
  212. <programlisting language="php"><![CDATA[
  213. // Setzen eines POST Parameters
  214. $client->setParameterPost('language', 'fr');
  215. // Hinzufügen von mehreren POST Parametern, eines davon mit mehreren Werten
  216. $client->setParameterPost(array(
  217. 'language' => 'es',
  218. 'country' => 'ar',
  219. 'selection' => array(45, 32, 80)
  220. ));
  221. ]]></programlisting>
  222. </example>
  223. Beim Senden einer POST Anfrage ist zu beachten, dass man sowohl GET als auch POST
  224. Parameter setzen kann. Auf der anderen Seite wird durch das Setzen von POST Parametern
  225. für andere Anfragen als POST kein Fehler ausgeworfen. Solange eine Anfrage keine POST
  226. Anfrage ist, werden POST Parameter einfach ignoriert.
  227. </para>
  228. </sect2>
  229. <sect2 id="zend.http.client.accessing_last">
  230. <title>Zugriff auf die Letzte Anfrage und Antwort</title>
  231. <para>
  232. Zend_Http_Client bietet Methoden um Zugriff auf die letzte gesendete Anfrage und die
  233. letzte empfangene Antwort des Client Objekts zu bekommen.
  234. <classname>Zend_Http_Client->getLastRequest()</classname> hat keine Parameter und gibt
  235. die letzte HTTP Anfrage als String zurück die der Client gesendet hat. Auf die gleiche
  236. Art und Weise gibt <classname>Zend_Http_Client->getLastResponse()</classname> die letzte
  237. HTTP Antwort als <link linkend="zend.http.response">Zend_Http_Response</link> Objekt
  238. zurück die der Client empfangen hat.
  239. </para>
  240. </sect2>
  241. </sect1>