Zend_Http_Client.xml 15 KB

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