Zend_Http_Client.xml 13 KB

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