Zend_Soap_Client.xml 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17133 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.soap.client">
  5. <title>Zend_Soap_Client</title>
  6. <para>
  7. Die <classname>Zend_Soap_Client</classname> Klasse vereinfacht die Entwicklung von SOAP
  8. Clients für PHP Programmierern.
  9. </para>
  10. <para>
  11. Sie kann im WSDL oder im nicht-WSDL Modus verwendet werden.
  12. </para>
  13. <para>
  14. Im WSDL Modus verwendet die Zend_Soap_Client Komponente ein bereits vorbereitetes
  15. WSDL Dokument um die Optionen des Transport Layers zu definieren.
  16. </para>
  17. <para>
  18. Die WSDL Beschreibung wird normalerweise vom Web Service bereitgestellt auf das der Client
  19. zugreift. Wenn die WSDL Beschreibung nicht verfügbar gemacht wurde, kann man
  20. Zend_Soap_Client im nicht-WSDL Modus verwenden. In diesem Modus müssel alle SOAP
  21. Protokolloptionen explizit an der Zend_Soap_Client Klasse gesetzt werden.
  22. </para>
  23. <sect2 id="zend.soap.client.constructor">
  24. <title>Der Zend_Soap_Client Konstruktor</title>
  25. <para>
  26. Der <classname>Zend_Soap_Client</classname> Konstruktor nimmt zwei Parameter:
  27. <itemizedlist>
  28. <listitem>
  29. <para>
  30. <code>$wsdl</code> - eine URI einer WSDL Datei.
  31. </para>
  32. </listitem>
  33. <listitem>
  34. <para>
  35. <code>$options</code> - Optionen um ein SOAP Client Objekt zu erstellen.
  36. </para>
  37. </listitem>
  38. </itemizedlist>
  39. Beide Parameter können später gesetzt werden indem die
  40. <methodname>setWsdl($wsdl)</methodname> und
  41. <methodname>setOptions($options)</methodname> Methoden verwendet werden.
  42. </para>
  43. <note>
  44. <title>Wichtig!</title>
  45. <para>
  46. Wenn die Zend_Soap_Client Komponente im nicht-WSDL Modus verwendet wird,
  47. <emphasis>müssen</emphasis> die 'location' und 'uri' Optionen gesetzt werden.
  48. </para>
  49. </note>
  50. <para>
  51. Die folgenden Optionen werden erkannt:
  52. <itemizedlist>
  53. <listitem>
  54. <para>
  55. 'soap_version' ('soapVersion') - Die zu verwendende SOAP Version
  56. (SOAP_1_1 oder SOAP_1_2).
  57. </para>
  58. </listitem>
  59. <listitem>
  60. <para>
  61. 'classmap' ('classMap') welche verwendet werden kann um einige WSDL Typen
  62. auf PHP Klassen zu mappen.
  63. </para>
  64. <para>
  65. Die Option muß ein Array mit WSDL Typen als Schlüssel und Namen von PHP
  66. Klassen als Werte sein.
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. 'encoding' - Interne Zeichen Kodierung (UTF-8 wird immer als externe
  72. Kodierung verwendet).
  73. </para>
  74. </listitem>
  75. <listitem>
  76. <para>
  77. 'wsdl' welcher dem Aufruf von <methodname>setWsdl($wsdlValue)</methodname>
  78. entspricht.
  79. </para>
  80. <para>
  81. Das Ändern dieser Option kann das Zend_Soap_Client Objekt von oder zum WSDL
  82. Modus wechseln.
  83. </para>
  84. </listitem>
  85. <listitem>
  86. <para>
  87. 'uri' - Der Ziel-Namespace für den SOAP Service (benötigt im nicht-WSDL
  88. Modus, funktioniert nicht im WSDL Modus).
  89. </para>
  90. </listitem>
  91. <listitem>
  92. <para>
  93. 'location' - Die URL der Anfrage (benötigt im nicht-WSDL Modus, funktioniert
  94. nicht im WSDL Modus).
  95. </para>
  96. </listitem>
  97. <listitem>
  98. <para>
  99. 'style' - Anfrage Stil (funktioniert nicht im WSDL Modus):
  100. <code>SOAP_RPC</code> oder <code>SOAP_DOCUMENT</code>.
  101. </para>
  102. </listitem>
  103. <listitem>
  104. <para>
  105. 'use' - Methode zum Verschlüsseln von Nachrichten (funktioniert nicht im
  106. WSDL Modus): <code>SOAP_ENCODED</code> oder <code>SOAP_LITERAL</code>.
  107. </para>
  108. </listitem>
  109. <listitem>
  110. <para>
  111. 'login' und 'password' - Login und Passwort für eine HTTP Authentifizierung.
  112. </para>
  113. </listitem>
  114. <listitem>
  115. <para>
  116. 'proxy_host', 'proxy_port', 'proxy_login', und 'proxy_password' - Eine HTTP
  117. Verbindung über einen Proxy Server.
  118. </para>
  119. </listitem>
  120. <listitem>
  121. <para>
  122. 'local_cert' und 'passphrase' - HTTPS Client Authentifizierungs Optionen für
  123. Zertifikate.
  124. </para>
  125. </listitem>
  126. <listitem>
  127. <para>
  128. 'compression' - Komprimierungs Optionen; das ist eine Kombination von
  129. <code>SOAP_COMPRESSION_ACCEPT</code>, <code>SOAP_COMPRESSION_GZIP</code> und
  130. <code>SOAP_COMPRESSION_DEFLATE</code> Optionen welche wie folgt verwendet
  131. werden können:
  132. <programlisting language="php"><![CDATA[
  133. // Komprimierung der Antworten akzeptieren
  134. $client = new Zend_Soap_Client("some.wsdl",
  135. array('compression' => SOAP_COMPRESSION_ACCEPT));
  136. ...
  137. // Anfragen komprimieren durch Verwendung von gzip mit Komprimierungs-Level 5
  138. $client = new Zend_Soap_Client("some.wsdl",
  139. array('compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 5));
  140. ...
  141. // Anfragen komprimieren durch Verwendung der Deflate Komprimierung
  142. $client = new Zend_Soap_Client("some.wsdl",
  143. array('compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_DEFLATE));
  144. ]]></programlisting>
  145. </para>
  146. </listitem>
  147. </itemizedlist>
  148. </para>
  149. </sect2>
  150. <sect2 id="zend.soap.client.calls">
  151. <title>SOAP Anfragen durchführen</title>
  152. <para>
  153. Nachdem ein <classname>Zend_Soap_Client</classname> Objekt erstellt wurde sind wir
  154. bereit um SOAP Anfragen durchzuführen.
  155. </para>
  156. <para>
  157. Jede Methode des Web Services wird auf eine virtuelle
  158. <classname>Zend_Soap_Client</classname> Objekt-Methode gemappt welche Parameter mit
  159. üblichen PHP Typen entgegen nimmt.
  160. </para>
  161. <para>
  162. Es ist wie im folgenden Beispiel zu verwenden:
  163. <programlisting language="php"><![CDATA[
  164. //****************************************************************
  165. // Server Code
  166. //****************************************************************
  167. // class MyClass {
  168. // /**
  169. // * Diese Methode nimmt ...
  170. // *
  171. // * @param integer $inputParam
  172. // * @return string
  173. // */
  174. // public function method1($inputParam) {
  175. // ...
  176. // }
  177. //
  178. // /**
  179. // * Diese Methode nimmt ...
  180. // *
  181. // * @param integer $inputParam1
  182. // * @param string $inputParam2
  183. // * @return float
  184. // */
  185. // public function method2($inputParam1, $inputParam2) {
  186. // ...
  187. // }
  188. //
  189. // ...
  190. // }
  191. // ...
  192. // $server = new Zend_Soap_Server(null, $options);
  193. // $server->setClass('MyClass');
  194. // ...
  195. // $server->handle();
  196. //
  197. //****************************************************************
  198. // Ende des Server Codes
  199. //****************************************************************
  200. $client = new Zend_Soap_Client("MyService.wsdl");
  201. ...
  202. // $result1 ist ein String
  203. $result1 = $client->method1(10);
  204. ...
  205. // $result2 ist ein Float
  206. $result2 = $client->method2(22, 'irgendein String');
  207. ]]></programlisting>
  208. </para>
  209. </sect2>
  210. </sect1>