Zend_Http_Client.xml 13 KB

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