Zend_Json-Server.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.json.server">
  5. <title>Zend_Json_Server - JSON-RPC server</title>
  6. <para>
  7. <classname>Zend_Json_Server</classname> ist eine
  8. <ulink url="http://groups.google.com/group/json-rpc/">JSON-RPC</ulink> Server Implementierung. Sie
  9. unterstützt sowohl <ulink url="http://json-rpc.org/wiki/specification">dieSpezifikation von JSON-RPC Version 1</ulink>
  10. als auch die <ulink url="http://groups.google.com/group/json-rpc/web/json-rpc-1-2-proposal">Spezifikation der Version 2</ulink>;
  11. zusätzlich bietet Sie eine PHP Implementierung der
  12. <ulink url="http://groups.google.com/group/json-schema/web/service-mapping-description-proposal">Spezifikation für Service Mapping Description (SMD)</ulink>
  13. Um Kunden von Services deren Metadaten anzubieten.
  14. </para>
  15. <para>
  16. JSON-RPC ist ein leichgewichtiges Remoce Procedure Call Protokoll das JSON für seine Nachrichten
  17. verwendet. Diese JSON-RPC Implementierung folgt PHP's
  18. <ulink url="http://us.php.net/manual/en/function.soap-soapserver-construct.php">SoapServer</ulink> API.
  19. Das bedeutet das in einer typischen Situation einfach folgendes getan wird:
  20. </para>
  21. <itemizedlist>
  22. <listitem><para>Instanzieren des Server Objekts</para></listitem>
  23. <listitem><para>Eine oder mehrere Funktionen und/oder Klassen/Objekte dem Server Objekt hinzufügen</para></listitem>
  24. <listitem><para>Die Anfrage mit handle() ausführen</para></listitem>
  25. </itemizedlist>
  26. <para>
  27. <classname>Zend_Json_Server</classname> verwendet <xref linkend="zend.server.reflection" /> um Reflektion
  28. durchzuführen um den SMD zu erstellen und die Signaturen der Methodenaufrufe zu erzwingen. Als solche,
  29. ist es zwingend notwendig das alle hinzugefügten Funktionen und/oder Klassenmethoden komplette PHP
  30. Docblocks dokumentiert haben mindestens aber:
  31. </para>
  32. <itemizedlist>
  33. <listitem><para>Alle Parameter und deren erwarteter Variablentypen</para></listitem>
  34. <listitem><para>Den Variablentyp des Rückgabewertes</para></listitem>
  35. </itemizedlist>
  36. <para>
  37. <classname>Zend_Json_Server</classname> hört aktuell nur auf POST Anfragen; glücklicherweise bieten die meisten
  38. JSON-RPC Client Implementierungen die zur aktuell vorhanden sind nur POST Anfragen. Das macht es einfach
  39. den gleichen Endpunkt des Servers so zu verwenden das er beide Anfragen behandelt sowie die Service SMD
  40. liefert, wie im nächsten Beispiel gezeigt.
  41. </para>
  42. <example id="zend.json.server.usage">
  43. <title>Zend_Json_Server Verwendung</title>
  44. <para>
  45. Zuerst müssen wir eine Klasse definieren die wir über den JSON-RPC Server ausliefern wollen.
  46. Wir nennen die Klasse 'Calculator', und definieren die Methoden 'add', 'substract', 'multiple',
  47. und 'divide':
  48. </para>
  49. <programlisting role="php"><![CDATA[
  50. /**
  51. * Calculator - Einfache Klasse zur Auslieferung über JSON-RPC
  52. */
  53. class Calculator
  54. {
  55. /**
  56. * Summe von zwei Variablen zurückgeben
  57. *
  58. * @param int $x
  59. * @param int $y
  60. * @return int
  61. */
  62. public function add($x, $y)
  63. {
  64. return $x + $y;
  65. }
  66. /**
  67. * Differenz von zwei Variablen zurückgeben
  68. *
  69. * @param int $x
  70. * @param int $y
  71. * @return int
  72. */
  73. public function subtract($x, $y)
  74. {
  75. return $x - $y;
  76. }
  77. /**
  78. * Produkt von zwei Variablen zurückgeben
  79. *
  80. * @param int $x
  81. * @param int $y
  82. * @return int
  83. */
  84. public function multiply($x, $y)
  85. {
  86. return $x * $y;
  87. }
  88. /**
  89. * Division von zwei Variablen zurückgeben
  90. *
  91. * @param int $x
  92. * @param int $y
  93. * @return float
  94. */
  95. public function divide($x, $y)
  96. {
  97. return $x / $y;
  98. }
  99. }
  100. ]]></programlisting>
  101. <para>
  102. Es ist zu beachten das jede Methode einen Docblock mit Einträgen besitzt die jeden Parameter und
  103. seinen Typ beschreiben, sowie einen Eintrag für den Rückgabewert. Das ist
  104. <emphasis>absolut kritisch</emphasis> wenn <classname>Zend_Json_Server</classname> verwendet wird -- oder auch
  105. jede andere Server Komponente für diesen Zweck im Zend Framework.
  106. </para>
  107. <para>
  108. Erstellen wir also ein Skript um die Anfrage zu behandeln:
  109. </para>
  110. <programlisting role="php"><![CDATA[
  111. $server = new Zend_Json_Server();
  112. // Zeigt welche Funktionalität vorhanden ist:
  113. $server->setClass('Calculator');
  114. // Behandelt die Anfrage:
  115. $server->handle();
  116. ]]></programlisting>
  117. <para>
  118. Trotzdem behandelt das noch immer nicht das Problem der Rückgabe eines SMD damit der JSON-RPC
  119. Client die Methoden selbstständig erkennen kann. Das kann getan werden indem die HTTP Anfragemethode
  120. erkannt wird, und anschließend einige Metadaten des Servers spezifiziert werden:
  121. </para>
  122. <programlisting role="php"><![CDATA[
  123. $server = new Zend_Json_Server();
  124. $server->setClass('Calculator');
  125. if ('GET' == $_SERVER['REQUEST_METHOD']) {
  126. // Zeigt den Endpunkt der URL, und die verwendete JSON-RPC Version:
  127. $server->setTarget('/json-rpc.php')
  128. ->setEnvelope(Zend_Json_Server_Smd::ENV_JSONRPC_2);
  129. // Den SMD holen
  130. $smd = $server->getServiceMap();
  131. // Den SMD an den Client zurückgeben
  132. header('Content-Type: application/json');
  133. echo $smd;
  134. return;
  135. }
  136. $server->handle();
  137. ]]></programlisting>
  138. <para>
  139. Wenn der JSON-RPC Server mit dem Dojo Toolkit verwendet wird muß auch ein spezielles
  140. Kompatibilitätsflag gesetzt werden um sicherzustellen das die zwei korrekt miteinander arbeiten:
  141. </para>
  142. <programlisting role="php"><![CDATA[
  143. $server = new Zend_Json_Server();
  144. $server->setClass('Calculator');
  145. if ('GET' == $_SERVER['REQUEST_METHOD']) {
  146. $server->setTarget('/json-rpc.php')
  147. ->setEnvelope(Zend_Json_Server_Smd::ENV_JSONRPC_2);
  148. $smd = $server->getServiceMap();
  149. // Die Kompatibilität zu Dojo setzen:
  150. $smd->setDojoCompatible(true);
  151. header('Content-Type: application/json');
  152. echo $smd;
  153. return;
  154. }
  155. $server->handle();
  156. ]]></programlisting>
  157. </example>
  158. <sect2 id="zend.json.server.details">
  159. <title>Fortgescrittene Details</title>
  160. <para>
  161. Obwohl das meiste an Funktionalität für <classname>Zend_Json_Server</classname> in
  162. <xref linkend="zend.json.server.usage" /> beschrieben wurde, ist noch weitere fortgeschrittenere
  163. Funktionalität vorhanden.
  164. </para>
  165. <sect3 id="zend.json.server.details.zendjsonserver">
  166. <title>Zend_Json_Server</title>
  167. <para>
  168. <classname>Zend_Json_Server</classname> ist die Kernklasse von JSON-RPC; die bearbeitet alle Anfragen und
  169. gibt den Antwort Payload zurück. Sie hat die folgenden Methoden:
  170. </para>
  171. <itemizedlist>
  172. <listitem><para><code>addFunction($function)</code>: Spezifiziert eine benutzerdefinierte
  173. Funktion die dem Server hinzugefügt werden soll.</para></listitem>
  174. <listitem><para><code>setClass($class)</code>: Spezifiziert eine Klasse oder ein Objekt das dem
  175. Server hinzugefügt werden soll; alle öffentlichen Methoden dieses Elemente werden als
  176. JSON-RPC Methoden bekanntgegeben.</para></listitem>
  177. <listitem><para><code>fault($fault = null, $code = 404, $data =
  178. null)</code>: Erstellt und retourniert ein
  179. <classname>Zend_Json_Server_Error</classname> Objekt.</para></listitem>
  180. <listitem><para><code>handle($request = false)</code>: Behandelt eine JSON-RPC Anfrage; optional
  181. kann ein <classname>Zend_Json_Server_Request</classname> Objekt für die Anpassung übergeben werden
  182. (standardmäßig wird eines erstellt).</para></listitem>
  183. <listitem><para><code>getFunctions()</code>: Gibt eine Liste aller hinzugefügten Methoden
  184. zurück.</para></listitem>
  185. <listitem><para><code>setRequest(Zend_Json_Server_Request
  186. $request)</code>: Spezifiziert ein Anfrageobjekt um es für den Server zu verwenden.</para></listitem>
  187. <listitem><para><code>getRequest()</code>: Empfängt das Anfrageobjekt das vom Server verwendet
  188. wird.</para></listitem>
  189. <listitem><para><code>setResponse(Zend_Json_Server_Response
  190. $response)</code>: Setzt das Antwort Objekt das der Server verwendet.</para></listitem>
  191. <listitem><para><code>getResponse()</code>: Empfängt das Anfrageobjekt das vom Server
  192. verwendet wird.</para></listitem>
  193. <listitem><para><code>setAutoEmitResponse($flag)</code>:
  194. Zeigt ob der Server die Antworten und alle Header automatisch ausgeben sollte;
  195. standardmäßig ist das aktiviert.</para></listitem>
  196. <listitem><para><code>autoEmitResponse()</code>: Stellt fest ob das automatische senden der
  197. Antwort eingeschaltet ist.</para></listitem>
  198. <listitem><para><code>getServiceMap()</code>: Empfängt die Service Map Description in der Form
  199. eines <classname>Zend_Json_Server_Smd</classname> Objekts</para></listitem>
  200. </itemizedlist>
  201. </sect3>
  202. <sect3 id="zend.json.server.details.zendjsonserverrequest">
  203. <title>Zend_Json_Server_Request</title>
  204. <para>
  205. Die JSON-RPC Anfrageumgebung ist in ein <classname>Zend_Json_Server_Request</classname> Objekt
  206. eingekapselt. Diese Objekt erlaubt es die notwendigen Teile der JSON-RPC Anfrage zu setzen,
  207. inklusive der Anfrage ID, Parametern, und der JSON-RPC spezifischen Version. Es hat die
  208. Möglichkeit sich selbst über JSON zu laden oder ein Set von Optionen, und kann sich selbst
  209. über die <code>toJson()</code> Methode als JSON darstellen.
  210. </para>
  211. <para>
  212. Das Anfrage Objekt enthält die folgenden Methoden:
  213. </para>
  214. <itemizedlist>
  215. <listitem><para><code>setOptions(array $options)</code>: Spezifiziert die Konfiguration des
  216. Objektes. <code>$options</code> kann Schlüssel enthalten die jeglicher 'set' Methode
  217. entsprechen: <code>setParams()</code>, <code>setMethod()</code>, <code>setId()</code>
  218. und <code>setVersion()</code>.</para></listitem>
  219. <listitem><para><code>addParam($value, $key = null)</code>: Fügt einen Parameter hinzu der
  220. mit einem Methodenaufruf verwendet wird. Parameter können nur Werte sein, oder optional
  221. auch den Parameternamen enthalten.</para></listitem>
  222. <listitem><para><code>addParams(array $params)</code>: Mehrere Parameter auf einmal hinzufügen;
  223. Ruft <code>addParam()</code> auf</para></listitem>
  224. <listitem><para><code>setParams(array $params)</code>: Setzt alle Parameter auf einmal;
  225. überschreibt jeden existierenden Parameter.</para></listitem>
  226. <listitem><para><code>getParam($index)</code>: Empfängt einen Parameter durch seine Position
  227. oder seinen Namen.</para></listitem>
  228. <listitem><para><code>getParams()</code>: Empfängt alle Parameter auf einmal.</para></listitem>
  229. <listitem><para><code>setMethod($name)</code>: Setzt die Methode die aufgerufen wird.</para></listitem>
  230. <listitem><para><code>getMethod()</code>: Empfängt die Methode die aufgerufen wird.</para></listitem>
  231. <listitem><para><code>isMethodError()</code>: Erkennt ob eine Anfrage fehlerhaft ist und einen
  232. Fehler produzieren würde, oder nicht.</para></listitem>
  233. <listitem><para><code>setId($name)</code>: Setzt den Identifikator der Anfrage (durch den
  234. Client verwendet um Anfragen auf Antworten abzubilden).</para></listitem>
  235. <listitem><para><code>getId()</code>: Empfängt den Anfrage Identifikator.</para></listitem>
  236. <listitem><para><code>setVersion($version)</code>: Setzt die Version der JSON-RPC Spezifikation
  237. der die Anfrage entspricht. Kann entweder '1.0' oder '2.0' sein.</para></listitem>
  238. <listitem><para><code>getVersion()</code>: Empfängt die Version der JSON-RPC Spezifikation die
  239. von der Anfrage verwendet wird.</para></listitem>
  240. <listitem><para><code>loadJson($json)</code>: Läde das Anfrageobjekt von einem JSON String.</para></listitem>
  241. <listitem><para><code>toJson()</code>: Stellt den JSON String als Anfrage dar.</para></listitem>
  242. </itemizedlist>
  243. <para>
  244. Eine HTTP spezifische Version ist über <classname>Zend_Json_Server_Request_Http</classname> vorhanden.
  245. Diese Klasse empfängt eine Anfrage über <code>php://input</code> und erlaubt den Zugriff
  246. auf die rohen JSON Daten über die <code>getRawJson()</code> Methode.
  247. </para>
  248. </sect3>
  249. <sect3 id="zend.json.server.details.zendjsonserverresponse">
  250. <title>Zend_Json_Server_Response</title>
  251. <para>
  252. Der JSON-RPC Antwort Payload ist in ein <classname>Zend_Json_Server_Response</classname> Objekt
  253. gekapselt. Diese Objekt erlaubt es den Rückgabewert der Anfrage zu setzen, ob die Antwort
  254. ein Fehler ist oder nicht, den Anfrageindentifikator, die Version der JSON-RPC Spezifikation
  255. der die Antwort entspricht, und optional die Servicemap.
  256. </para>
  257. <para>
  258. Das Antwortobjekt bietet die folgenden Methoden:
  259. </para>
  260. <itemizedlist>
  261. <listitem><para><code>setResult($value)</code>: Setzt das Ergebnis der Antwort.</para></listitem>
  262. <listitem><para><code>getResult()</code>: Empfängt das Antwortergebnis.</para></listitem>
  263. <listitem><para><code>setError(Zend_Json_Server_Error $error)</code>: Setzt ein Fehlerobjekt.
  264. Wenn es gesetzt wird, wird es als Antwort verwendet wenn JSON serialisiert wird.</para></listitem>
  265. <listitem><para><code>getError()</code>: Empfängt das Fehlerobjekt, wenn vorhanden.</para></listitem>
  266. <listitem><para><code>isError()</code>: Ob die Antwort eine Fehlerantwort ist oder nicht.</para></listitem>
  267. <listitem><para><code>setId($name)</code>: Setzt den Antwortindentifikator (damit der Client
  268. die Antwort mit der Originalanfrage in Verbindung bringt).</para></listitem>
  269. <listitem><para><code>getId()</code>: Empfängt den Antwortidentifikator.</para></listitem>
  270. <listitem><para><code>setVersion($version)</code>: Setzt die JSON-RPC Version der die
  271. Antwort entspricht.</para></listitem>
  272. <listitem><para><code>getVersion()</code>: Empfängt die JSON-RPC Version der die Antwort
  273. entspricht.</para></listitem>
  274. <listitem><para><code>toJson()</code>: Serialisiert die Antwort auf JSON. Wenn die Antwort
  275. eine Fehlerantwort ist, wird das Fehlerobjekt serialisiert.</para></listitem>
  276. <listitem><para><code>setServiceMap($serviceMap)</code>: Setzt das Servicemap Objekt für
  277. die Antwort.</para></listitem>
  278. <listitem><para><code>getServiceMap()</code>: Empfängt das Servicemap Objekt, wenn es
  279. vorhanden ist.</para></listitem>
  280. </itemizedlist>
  281. <para>
  282. Eine HTTP spezifische Version ist über <classname>Zend_Json_Server_Response_Http</classname> vorhanden.
  283. Diese Klasse wird entsprechende HTTP Header senden als auch die Antwort auf JSON zu
  284. serialisieren.
  285. </para>
  286. </sect3>
  287. <sect3 id="zend.json.server.details.zendjsonservererror">
  288. <title>Zend_Json_Server_Error</title>
  289. <para>
  290. JSON-RPC hat ein spezielles Format für das melden von Fehlerzuständen. Alle Fehler müssen
  291. mindestens, eine Fehlermeldung und einen Fehlercode anbieten; optional können Sie zusätzliche
  292. Daten, wie ein Backtrace, anbieten.
  293. </para>
  294. <para>
  295. Fehlercodes sind von jenen abgeleitet die vom
  296. <ulink url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">vom XML-RPC EPI Projekt</ulink>
  297. empfohlen werden. <classname>Zend_Json_Server</classname> fügt den richtigen Code basierend auf der
  298. Fehlerkondition zu. Für Anwendungsausnahmen wird der Code '-32000' verwendet.
  299. </para>
  300. <para>
  301. <classname>Zend_Json_Server_Error</classname> bietet die folgenden Methoden:
  302. </para>
  303. <itemizedlist>
  304. <listitem><para><code>setCode($code)</code>: Setzt den Fehlercode: Wenn der Code nicht im
  305. akzeptierten Bereich der XML-RPC Fehlercodes ist, wird -32000 hinzugefügt.</para></listitem>
  306. <listitem><para><code>getCode()</code>: Empfängt den aktuellen Fehlercode.</para></listitem>
  307. <listitem><para><code>setMessage($message)</code>: Setzt die Fehlernachricht.</para></listitem>
  308. <listitem><para><code>getMessage()</code>: Empfängt die aktuelle Fehlernachricht.</para></listitem>
  309. <listitem><para><code>setData($data)</code>: Setzt zusätzliche Daten die den Fehler
  310. genauer qualifizieren, wie ein Backtrace.</para></listitem>
  311. <listitem><para><code>getData()</code>: Empfängt alle aktuellen zusätzlichen Fehlerdaten.</para></listitem>
  312. <listitem><para><code>toArray()</code>: Weist den Fehler einem Array zu. Das Array enthält
  313. die Schlüssel 'code', 'message' und 'data'.</para></listitem>
  314. <listitem><para><code>toJson()</code>: Weist den Fehler einer JSON-RPC Fehlerrepräsentation
  315. zu.</para></listitem>
  316. </itemizedlist>
  317. </sect3>
  318. <sect3 id="zend.json.server.details.zendjsonserversmd">
  319. <title>Zend_Json_Server_Smd</title>
  320. <para>
  321. SMD steht für Service Mapping Description, ein JSON Schema das definiert wie ein Client mit
  322. einem speziellen Web Service interagieren kann. Zu der Zeit wie das geschrieben wurde, wurde
  323. die <ulink url="http://groups.google.com/group/json-schema/web/service-mapping-description-proposal">Spezifikation</ulink>
  324. noch nicht formell ratifiziert, aber Sie ist bereits im Dojo Toolkit in Verwendung sowie in
  325. anderen JSON-RPC Kundenclients.
  326. </para>
  327. <para>
  328. Grundsätzlich bezeichnet eine Service Mapping Description die Methode des Transports (POST,
  329. GET, TCP/IP, usw.), den Envelopetyp der Anfrage (normalerweise basierend auf dem Protokoll
  330. des Servers), die ZielURL des Service Providers, und eine Mappe der vorhandenen Services.
  331. Im FAll von JSON-RPC ist die Service Mappe eine Liste von vorhandenen Methoden wobei jede
  332. Methode die vorhandenen Parameter und deren Typen beschreibt, sowie den erwarteten Typ des
  333. Rückgabewerts.
  334. </para>
  335. <para>
  336. <classname>Zend_Json_Server_Smd</classname> bietet einen Objektorientierten Weg um Service Mappen zu
  337. erstellen. Grundsätzlich werden Ihm Metadaten übergeben die den Service beschreiben indem
  338. Mutatoren verwendet und Services (Methoden und Funktionen) spezifiziert werden.
  339. </para>
  340. <para>
  341. Die Servicebeschreibungen selbst sind typischerweise Instanzen von
  342. <classname>Zend_Json_Server_Smd_Service</classname>; man kann genauso alle Informationen als Array an die
  343. verschiedenen Servicemutatoren in <classname>Zend_Json_Server_Smd</classname> übergeben, und es wird für
  344. einen ein Serviceobjekt instanziieren. Die Serviceobjekte enthalten Informationen wie den
  345. Namen des Services (typischerweise die Funktion oder den Methodennamen), die Parameter
  346. (Namen, Typen und Position), und den Typ des Rückgabewerts. Optionen kann jedes Service sein
  347. eigenes Ziel und Envelope haben, obwohl diese Funktionalität selten verwendet wird.
  348. </para>
  349. <para>
  350. <classname>Zend_Json_Server</classname> führt all das im Hintergrund durch, indem Reflektion auf den
  351. hinzugefügten Klassen und Funktionen verwendet wird; man sollte seine eigenen Service Maps
  352. erstellen wenn man eigene Funktionalitäten anbieten will die die Introspektion von Klassen und
  353. Funktionen nicht bieten kann.
  354. </para>
  355. <para>
  356. Die vorhandenen Methoden in <classname>Zend_Json_Server_Smd</classname> enthalten:
  357. </para>
  358. <itemizedlist>
  359. <listitem><para><code>setOptions(array $options)</code>: Erstelle ein SMD Objekt von einem
  360. Array an Optionen. Alle Mutatoren (Methoden die mit 'set' beginnen) können als
  361. Schlüssel verwendet werden.</para></listitem>
  362. <listitem><para><code>setTransport($transport)</code>: Setzt den Transport der für den
  363. Zugriff auf das Service verwendet werden soll; aktuell wird nur POST unterstützt.</para></listitem>
  364. <listitem><para><code>getTransport()</code>: Empfängt den aktuellen Transport des Services.</para></listitem>
  365. <listitem><para><code>setEnvelope($envelopeType)</code>: Setzt den aktuelle Anfrageenvelope
  366. der verwendet werden sollte um auf den Service zuzugreifen. Aktuell werden die
  367. Konstanten <classname>Zend_Json_Server_Smd::ENV_JSONRPC_1</classname> und
  368. <classname>Zend_Json_Server_Smd::ENV_JSONRPC_1</classname> verwendet.</para></listitem>
  369. <listitem><para><code>getEnvelope()</code>: Empfängt den aktuellen Anfrageenvelope.</para></listitem>
  370. <listitem><para><code>setContentType($type)</code>: Setzt den Contenttype den Anfragen
  371. verwenden sollten (standardmäßig ist das 'application/json').</para></listitem>
  372. <listitem><para><code>getContentType()</code>: Empfängt den aktuellen Contenttype für
  373. Anfragen an den Service.</para></listitem>
  374. <listitem><para><code>setTarget($target)</code>: Setzt den aktuellen URL Endpunkt für den
  375. Service.</para></listitem>
  376. <listitem><para><code>getTarget()</code>: Empfängt den URL Endpunkt für den Service.</para></listitem>
  377. <listitem><para><code>setId($id)</code>: Tpischerweise ist das der URL Endpunkt des
  378. Services (der selbe wie das Ziel).</para></listitem>
  379. <listitem><para><code>getId()</code>: Empfängt die ServiceID (typischerweise der URL Endpunkt
  380. des Services).</para></listitem>
  381. <listitem><para><code>setDescription($description)</code>: Setzt eine Servicebeschreibung
  382. (typischerweise nähere Informationen die den Zweck des Services beschreiben).</para></listitem>
  383. <listitem><para><code>getDescription()</code>: Empfängt die Servicebeschreibung.</para></listitem>
  384. <listitem><para><code>setDojoCompatible($flag)</code>: Setzt ein Flag das indiziert ob das SMD
  385. mit dem Dojo Toolkit kompatibel ist oder nicht. Wenn es true ist, dann ist das
  386. erzeugte JSON SMD so formatiert das es dem Format entspricht das Dojo's JSON-RPC
  387. Client erwartet.</para></listitem>
  388. <listitem><para><code>isDojoCompatible()</code>: Gibt den Wert des Dojokompatibilitätsflags
  389. zurück (Standardmäßig false).</para></listitem>
  390. <listitem><para><code>addService($service)</code>: Fügt ein Service der Mappe hinzu. Kann ein
  391. Array von Informationen sein die an den Konstruktor von
  392. <classname>Zend_Json_Server_Smd_Service</classname> übergeben werden, oder eine Instanz dieser
  393. Klasse.</para></listitem>
  394. <listitem><para><code>addServices(array $services)</code>: Fügt mehrere Services auf einmal
  395. hinzu.</para></listitem>
  396. <listitem><para><code>setServices(array $services)</code>: Fügt mehrere Serices auf einmal
  397. hinzu, und überschreibt alle vorher gesetzten Services.</para></listitem>
  398. <listitem><para><code>getService($name)</code>: Gibt ein Service durch seinen Namen zurück.</para></listitem>
  399. <listitem><para><code>getServices()</code>: Gibt alle hinzugefügten Services zurück.</para></listitem>
  400. <listitem><para><code>removeService($name)</code>: Entfernt ein Service von der Mappe.</para></listitem>
  401. <listitem><para><code>toArray()</code>: Weißt die Service Mappe einem Array zu.</para></listitem>
  402. <listitem><para><code>toDojoArray()</code>: Weißt die Service Mappe einem Array zu das
  403. mit dem Dojo Toolkit kompatibel ist.</para></listitem>
  404. <listitem><para><code>toJson()</code>: Weißt die Service Mappe einer JSON
  405. Repräsentation zu.</para></listitem>
  406. </itemizedlist>
  407. <para>
  408. <classname>Zend_Json_Server_Smd_Service</classname> hat die folgenden Methoden:
  409. </para>
  410. <itemizedlist>
  411. <listitem><para><code>setOptions(array $options)</code>: Setzt den Objektstatus durch ein
  412. Array. Jeder Mutator (Methoden die mit 'set' beginnen, kann als Schlüssel verwendet
  413. und über diese Methode gesetzt werden.</para></listitem>
  414. <listitem><para><code>setName($name)</code>: Setzt den Namen des Services (typischerweise
  415. die Funktion oder den Methodennamen).</para></listitem>
  416. <listitem><para><code>getName()</code>: Empfängt den Servicenamen.</para></listitem>
  417. <listitem><para><code>setTransport($transport)</code>: Setzt den Transport des Services
  418. (aktuell werden nur Transporte unterstützt die in
  419. <classname>Zend_Json_Server_Smd</classname> erlaubt sind).</para></listitem>
  420. <listitem><para><code>getTransport()</code>: Empfängt den aktuellen Transport.</para></listitem>
  421. <listitem><para><code>setTarget($target)</code>: Setzt den URL-Endpunkt des Services
  422. (typischerweise ist das der selbe wir im gesamten SMD welchem der Service hinzugefügt
  423. wird).</para></listitem>
  424. <listitem><para><code>getTarget()</code>: Gibt den URL Endpunkt des Services zurück.</para></listitem>
  425. <listitem><para><code>setEnvelope($envelopeType)</code>: Setzt den Serviceenvelope
  426. (aktuell werden nur Envelopes unterstützt die in
  427. <classname>Zend_Json_Server_Smd</classname> erlaubt sind).</para></listitem>
  428. <listitem><para><code>getEnvelope()</code>: Empfängt den Typ des Serviceenvelopes.</para></listitem>
  429. <listitem><para><code>addParam($type, array $options = array(), $order = null)</code>:
  430. Fügt dem Service einen Parameter hinzu. Standardmäßig ist nur der Parametertyp
  431. notwendig. Trotzdem kann die Reihenfolge spezifiziert werden sowie auch Optionen wie:</para>
  432. <itemizedlist>
  433. <listitem><para><emphasis>name</emphasis>: Der Name des Parameters</para></listitem>
  434. <listitem><para><emphasis>optional</emphasis>: Ob der Parameter optional ist oder nicht</para></listitem>
  435. <listitem><para><emphasis>default</emphasis>: Ein Standardwert für diesen Parameter</para></listitem>
  436. <listitem><para><emphasis>description</emphasis>: Ein Text der den Parameter beschreibt</para></listitem>
  437. </itemizedlist>
  438. </listitem>
  439. <listitem><para><code>addParams(array $params)</code>: Fügt verschiedene Parameter auf einmal
  440. hinzu; jeder Parameter sollte ein Assoziatives Array sein das mindestens den Schlüssel
  441. 'type' enthält welches den Typ des Parameters beschreibt, und optinal den Schlüssel 'order';
  442. jeden andere Schlüssel wird als <code>$options</code> an <code>addOption()</code> übergeben.</para></listitem>
  443. <listitem><para><code>setParams(array $params)</code>: Setzt viele Parameter aus einmal,
  444. überschreibt alle aktuellen Parameter auf einmal.</para></listitem>
  445. <listitem><para><code>getParams()</code>: Empfängt alle aktuell gesetzten Parameter.</para></listitem>
  446. <listitem><para><code>setReturn($type)</code>: Setzt den Type des Rückgabewertes des Services.</para></listitem>
  447. <listitem><para><code>getReturn()</code>: Empfängt den Typ des Rückgabewertes des Services.</para></listitem>
  448. <listitem><para><code>toArray()</code>: Weist das Service an ein Array zu.</para></listitem>
  449. <listitem><para><code>toJson()</code>: Weist das Service einer JSON Repräsentation zu.</para></listitem>
  450. </itemizedlist>
  451. </sect3>
  452. </sect2>
  453. </sect1>
  454. <!--
  455. vim:se ts=4 sw=4 et:
  456. -->