Zend_XmlRpc_Server.xml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.xmlrpc.server">
  5. <title>Zend_XmlRpc_Server</title>
  6. <sect2 id="zend.xmlrpc.server.introduction">
  7. <title>Introduction</title>
  8. <para>
  9. <classname>Zend_XmlRpc_Server</classname> fournit un serveur XML-RPC qui suit les
  10. spécifications <ulink url="http://www.xmlrpc.com/spec">dictées par
  11. www.xmlrpc.com</ulink>. Il fournit aussi la méthode <code>system.multicall()</code>,
  12. permettant le traitement de requêtes multiples.
  13. </para>
  14. </sect2>
  15. <sect2 id="zend.xmlrpc.server.usage">
  16. <title>Usage de base</title>
  17. <para>Voici un exemple d'utilisation basique :</para>
  18. <programlisting language="php"><![CDATA[
  19. $server = new Zend_XmlRpc_Server();
  20. $server->setClass('My_Service_Class');
  21. echo $server->handle();
  22. ]]></programlisting>
  23. </sect2>
  24. <sect2 id="zend.xmlrpc.server.structure">
  25. <title>Structures du serveur</title>
  26. <para>
  27. <classname>Zend_XmlRpc_Server</classname> se décompose en un objet serveur
  28. (lui-même), un objet requête, réponse, et des objets d'erreurs.
  29. </para>
  30. <para>
  31. Pour démarrer un serveur <classname>Zend_XmlRpc_Server</classname>, vous devez
  32. attacher une ou plusieurs classes ou fonctions au serveur, grâce à
  33. <methodname>setClass()</methodname> et <methodname>addFunction()</methodname>.
  34. </para>
  35. <para>
  36. Lorsque c'est fait, vous pouvez passer un objet
  37. <classname>Zend_XmlRpc_Request</classname> à
  38. <methodname>Zend_XmlRpc_Server::handle()</methodname>, sinon par défaut il utilisera un
  39. objet <classname>Zend_XmlRpc_Request_Http</classname> qui récupérera la requête depuis
  40. <code>php://input</code>.
  41. </para>
  42. <para>
  43. <methodname>Zend_XmlRpc_Server::handle()</methodname> va alors essayer de traiter la
  44. requête. Cette méthode retournera un objet <classname>Zend_XmlRpc_Response</classname>
  45. ou <classname>Zend_XmlRpc_Server_Fault</classname>. Tous deux possèdent une méthode
  46. <methodname>__toString()</methodname> qui crée une réponse <acronym>XML</acronym> valide XML-RPC.
  47. </para>
  48. </sect2>
  49. <sect2 id="zend.xmlrpc.server.anatomy">
  50. <title>Anatomy of a webservice</title>
  51. <sect3 id="zend.xmlrpc.server.anatomy.general">
  52. <title>General considerations</title>
  53. <para>
  54. For maximum performance it is recommended to use a simple
  55. bootstrap file for the server component. Using
  56. <classname>Zend_XmlRpc_Server</classname> inside a
  57. <link linkend="zend.controller"><classname>Zend_Controller</classname></link>
  58. is strongly discouraged to avoid the overhead.
  59. </para>
  60. <para>
  61. Services change over time and while webservices are generally
  62. less change intense as code-native <acronym>APIs</acronym>, it
  63. is recommended to version your service. Do so to lay grounds to
  64. provide compatibility for clients using older versions of your
  65. service and manage your service lifecycle including deprecation
  66. timeframes.To do so just include a version number into your
  67. <acronym>URI</acronym>. It is also recommended to include the
  68. remote protocol name in the <acronym>URI</acronym> to allow easy
  69. integration of upcoming remoting technologies.
  70. http://myservice.ws/<emphasis>1.0/XMLRPC/</emphasis>.
  71. </para>
  72. </sect3>
  73. <sect3 id="zend.xmlrpc.server.anatomy.expose">
  74. <title>What to expose?</title>
  75. <para>
  76. Most of the time it is not sensible to expose business objects
  77. directly. Business objects are usually small and under heavy
  78. change, because change is cheap in this layer of your
  79. application. Once deployed and adopted, web services are hard to
  80. change. Another concern is <acronym>I/O</acronym> and latency:
  81. the best webservice calls are those not happening. Therefore
  82. service calls need to be more coarse-grained than usual business
  83. logic is. Often an additional layer in front of your business
  84. objects makes sense. This layer is sometimes referred to as
  85. <ulink url="http://martinfowler.com/eaaCatalog/remoteFacade.html">Remote Facade.</ulink>.
  86. Such a service layer adds a coarse grained interface on top of
  87. your business logic and groups verbose operations into smaller
  88. ones.
  89. </para>
  90. </sect3>
  91. </sect2>
  92. <sect2 id="zend.xmlrpc.server.conventions">
  93. <title>Conventions</title>
  94. <para>
  95. <classname>Zend_XmlRpc_Server</classname> permet d'attacher des classes et/ou des
  96. fonctions au serveur XML-RPC. Grâce à <classname>Zend_Server_Reflection</classname>,
  97. l'introspection va utiliser les blocs de commentaires pour déterminer les types
  98. d'arguments et de réponse de la fonction/classe.
  99. </para>
  100. <para>
  101. Les types XML-RPC n'ont pas forcément de correspondance native vers un type <acronym>PHP</acronym>.
  102. Le code fera de son mieux pour deviner le type de données approprié, en se basant sur
  103. les valeurs listées dans les balises @param et @return. Certains types XML-RPC n'ont par
  104. contre pas d'équivalent <acronym>PHP</acronym> direct, ils devront alors être spécifiés manuellement sous
  105. forme de balises phpdoc :
  106. </para>
  107. <itemizedlist>
  108. <listitem>
  109. <para>dateTime.iso8601, une chaîne formatée comme YYYYMMDDTHH:mm:ss</para>
  110. </listitem>
  111. <listitem>
  112. <para>base64, données encodées en base64</para>
  113. </listitem>
  114. <listitem>
  115. <para>struct, tableau associatif</para>
  116. </listitem>
  117. </itemizedlist>
  118. <para>Voici un exemple d'utilisation de type particulier:</para>
  119. <programlisting language="php"><![CDATA[
  120. /**
  121. * This is a sample function
  122. *
  123. * @param base64 $val1 Base64-encoded data
  124. * @param dateTime.iso8601 $val2 An ISO date
  125. * @param struct $val3 An associative array
  126. * @return struct
  127. */
  128. function myFunc($val1, $val2, $val3)
  129. {}
  130. ]]></programlisting>
  131. <para>
  132. PhpDocumentor ne vérifie (valide) pas les types des paramètres, mais les types
  133. sont obligatoires pour que le serveur puisse lui, valider les paramètres passés aux
  134. appels des méthodes.
  135. </para>
  136. <para>
  137. Il est parfaitement valide de spécifier plusieurs types pour les paramètres et les
  138. retours de méthodes. La spécification XML-RPC suggère que system.methodSignature
  139. retourne un tableau des possibilités au regard des paramètres d'entrée de la méthode, et
  140. de son type de sortie. Ceci ce fait grâce au caractère '|' de PhpDocumentor
  141. </para>
  142. <programlisting language="php"><![CDATA[
  143. /**
  144. * This is a sample function
  145. *
  146. * @param string|base64 $val1 String or base64-encoded data
  147. * @param string|dateTime.iso8601 $val2 String or an ISO date
  148. * @param array|struct $val3 Normal indexed array or an associative array
  149. * @return boolean|struct
  150. */
  151. function myFunc($val1, $val2, $val3)
  152. {}
  153. ]]></programlisting>
  154. <note>
  155. <para>
  156. Attention toutefois, une signature multiple peut prêter à confusion au regard des
  157. personnes utilisant votre service. En général une fonction ne devrait posséder qu'une
  158. seule signature.
  159. </para>
  160. </note>
  161. </sect2>
  162. <sect2 id="zend.xmlrpc.server.namespaces">
  163. <title>Utiliser des espaces de noms (Namespaces)</title>
  164. <para>
  165. XML-RPC accepte le concept d'espace de noms, ce qui permet de grouper les méthodes
  166. XML-RPC. Ceci aide à prévenir les collisions de noms (deux fonctions avec le même nom),
  167. de différentes classes. Par exemple le serveur XML-RPC sert des méthodes dans l'espace
  168. "system" :
  169. </para>
  170. <itemizedlist>
  171. <listitem>
  172. <para>system.listMethods</para>
  173. </listitem>
  174. <listitem>
  175. <para>system.methodHelp</para>
  176. </listitem>
  177. <listitem>
  178. <para>system.methodSignature</para>
  179. </listitem>
  180. </itemizedlist>
  181. <para>
  182. En interne la correspondance est faite avec les méthodes du même nom, de
  183. <classname>Zend_XmlRpc_Server</classname>.
  184. </para>
  185. <para>
  186. Si vous voulez ajouter un espace de noms aux méthodes que vous servez, procédez
  187. alors comme suit :
  188. </para>
  189. <programlisting language="php"><![CDATA[
  190. // Toutes les méthodes publiques de My_Service_Class seront accessibles
  191. // via myservice.METHODNAME
  192. $server->setClass('My_Service_Class', 'myservice');
  193. // la fonction 'somefunc' sera accessible via funcs.somefunc
  194. $server->addFunction('somefunc', 'funcs');
  195. ]]></programlisting>
  196. </sect2>
  197. <sect2 id="zend.xmlrpc.server.request">
  198. <title>Requêtes personnalisées</title>
  199. <para>
  200. La plupart du temps, vous utiliserez l'objet de requête par défaut
  201. <classname>Zend_XmlRpc_Request_Http</classname>, sans vous en occuper. En revanche si
  202. vous avez un besoin spécifique, comme par exemple journaliser la requête, traiter une
  203. requête CLI, GUI, ou autre environnement, vous devrez alors créer un objet étendant
  204. <classname>Zend_XmlRpc_Request</classname>. Implémentez les méthodes
  205. <methodname>getMethod()</methodname> et <methodname>getParams()</methodname> afin que le serveur puisse analyser
  206. ces informations pour traiter la requête.
  207. </para>
  208. </sect2>
  209. <sect2 id="zend.xmlrpc.server.response">
  210. <title>Réponses personnalisées</title>
  211. <para>
  212. Comme avec les objets de requête, <classname>Zend_XmlRpc_Server</classname> peut
  213. retourner des objets de réponse personnalisés. Par défaut il s'agit d'objets
  214. <classname>Zend_XmlRpc_Response_Http</classname> qui envoient un en-tête <acronym>HTTP</acronym>
  215. Content-Type <acronym>HTTP</acronym> pour XML-RPC. Vous pourriez utiliser des objets de réponse
  216. personnalisés pour par exemple renvoyer les réponses vers STDOUT, ou les
  217. journaliser.
  218. </para>
  219. <para>
  220. Pour utiliser une classe de réponse personnalisée, utilisez
  221. <methodname>Zend_XmlRpc_Server::setResponseClass()</methodname> avant d'appeler
  222. <methodname>handle()</methodname>.
  223. </para>
  224. </sect2>
  225. <sect2 id="zend.xmlrpc.server.fault">
  226. <title>Gérer les exceptions grâce aux erreurs (Faults)</title>
  227. <para>
  228. <classname>Zend_XmlRpc_Server</classname> attrape les Exceptions générées par vos
  229. classes/fonctions, et génère une réponse XML-RPC "fault" lorsqu'une exception a été
  230. rencontrée. Par défaut, les message et code des exceptions ne sont pas attachés dans la
  231. réponse XML-RPC. Ceci est du au fait que de telles exceptions peuvent en dire trop, au
  232. regard de la sécurité de votre application.
  233. </para>
  234. <para>
  235. Des classes d'exception peuvent cependant être mises en liste blanche, et donc
  236. utilisées pour les réponses d'erreur ("fault"). Utilisez simplement
  237. <methodname>Zend_XmlRpc_Server_Fault::attachFaultException()</methodname> en lui passant
  238. une classe d'exception :
  239. </para>
  240. <programlisting language="php"><![CDATA[
  241. Zend_XmlRpc_Server_Fault::attachFaultException('My_Project_Exception');
  242. ]]></programlisting>
  243. <para>
  244. Si vous héritez correctement vos exceptions, vous pouvez alors passer en liste
  245. blanche l'exception de plus bas niveau, et ainsi accepter plusieurs types d'exceptions
  246. qui en hériteront. Évidemment, les Zend_XmlRpc_Server_Exceptions sont elles
  247. automatiquement mises en liste blanche, afin de pouvoir traiter les requêtes vers des
  248. méthodes inexistantes, ou toute autre erreur "générique".
  249. </para>
  250. <para>
  251. Toute exception rencontrée, mais non mise en liste blanche, donnera naissance à
  252. une réponse d'erreur avec le code "404" et le message "Unknown error".
  253. </para>
  254. </sect2>
  255. <sect2 id="zend.xmlrpc.server.caching">
  256. <title>Cacher la définition du serveur entre les requêtes</title>
  257. <para>
  258. Attacher beaucoup de classes au serveur XML-RPC peut consommer beaucoup de
  259. ressources, car l'introspection de chaque classe/fonction est mise en place.
  260. </para>
  261. <para>
  262. Pour améliorer les performances, <classname>Zend_XmlRpc_Server_Cache</classname>
  263. peut être utilisé pour mettre en cache la définition d'un serveur. Combiné à
  264. <methodname>__autoload()</methodname>, ceci améliore grandement les performances.
  265. </para>
  266. <para>Un exemple d'utilisation :</para>
  267. <programlisting language="php"><![CDATA[
  268. function __autoload($class)
  269. {
  270. Zend_Loader::loadClass($class);
  271. }
  272. $cacheFile = dirname(__FILE__) . '/xmlrpc.cache';
  273. $server = new Zend_XmlRpc_Server();
  274. if (!Zend_XmlRpc_Server_Cache::get($cacheFile, $server)) {
  275. require_once 'My/Services/Glue.php';
  276. require_once 'My/Services/Paste.php';
  277. require_once 'My/Services/Tape.php';
  278. $server->setClass('My_Services_Glue', 'glue');
  279. // espace de noms glue
  280. $server->setClass('My_Services_Paste', 'paste');
  281. // espace de noms paste
  282. $server->setClass('My_Services_Tape', 'tape');
  283. // espace de noms tape
  284. Zend_XmlRpc_Server_Cache::save($cacheFile, $server);
  285. }
  286. echo $server->handle();
  287. ]]></programlisting>
  288. <para>
  289. L'exemple ci dessus essaye de récupérer la définition du serveur via le fichier
  290. <filename>xmlrpc.cache</filename>. Si ceci échoue, alors les classes nécessaires au
  291. service sont chargées, attachées au serveur, et une tentative de création de cache est
  292. lancée.
  293. </para>
  294. </sect2>
  295. <sect2 id="zend.xmlrpc.server.use">
  296. <title>Exemples d'utilisation</title>
  297. <para>
  298. Voici quelques exemples qui démontrent les diverses options disponibles pour un
  299. serveur XML-RPC.
  300. </para>
  301. <example id="zend.xmlrpc.server.use.attach-function">
  302. <title>Utilisation basique</title>
  303. <para>L'exemple ci dessous attache une fonction au service XML-RPC.</para>
  304. <programlisting language="php"><![CDATA[
  305. /**
  306. * Retourne le hash MD5 d'une valeur
  307. *
  308. * @param string $value Valeur à hasher
  309. * @return string Hash MD5 de la valeur
  310. */
  311. function md5Value($value)
  312. {
  313. return md5($value);
  314. }
  315. $server = new Zend_XmlRpc_Server();
  316. $server->addFunction('md5Value');
  317. echo $server->handle();
  318. ]]></programlisting>
  319. </example>
  320. <example id="zend.xmlrpc.server.use.attach-class">
  321. <title>Attacher une classe</title>
  322. <para>
  323. L'exemple ci dessous montre comment attacher les méthodes publiques d'une
  324. classe en tant que méthodes XML-RPC.
  325. </para>
  326. <programlisting language="php"><![CDATA[
  327. $server = new Zend_XmlRpc_Server();
  328. $server->setClass('Services_Comb');
  329. echo $server->handle();
  330. ]]></programlisting>
  331. </example>
  332. <example id="zend.xmlrpc.server.use.attach-class-with-arguments">
  333. <title>Attaching a class with arguments</title>
  334. <para>
  335. The following example illustrates how to attach a class' public
  336. methods and passing arguments to its methods. This can be used to specify certain
  337. defaults when registering service classes.
  338. </para>
  339. <programlisting language="php"><![CDATA[
  340. class Services_PricingService
  341. {
  342. /**
  343. * Calculate current price of product with $productId
  344. *
  345. * @param ProductRepository $productRepository
  346. * @param PurchaseRepository $purchaseRepository
  347. * @param integer $productId
  348. */
  349. public function calculate(ProductRepository $productRepository,
  350. PurchaseRepository $purchaseRepository,
  351. $productId)
  352. {
  353. ...
  354. }
  355. }
  356. $server = new Zend_XmlRpc_Server();
  357. $server->setClass('Services_PricingService',
  358. 'pricing',
  359. new ProductRepository(),
  360. new PurchaseRepository());
  361. ]]></programlisting>
  362. <para>
  363. The arguments passed at <methodname>setClass()</methodname> at server construction time are
  364. injected into the method call <command>pricing.calculate()</command> on remote invokation.
  365. In the example above, only the argument <varname>$purchaseId</varname> is expected from the client.
  366. </para>
  367. </example>
  368. <example id="zend.xmlrpc.server.use.attach-class-with-arguments-constructor">
  369. <title>Passing arguments only to constructor</title>
  370. <para>
  371. <classname>Zend_XmlRpc_Server</classname> allows to restrict argument passing to
  372. constructors only. This can be used for constructor dependency injection.
  373. To limit injection to constructors, call <methodname>sendArgumentsToAllMethods</methodname>
  374. and pass <code>false</code> as an argument. This disables the default behavior of all arguments
  375. being injected into the remote method. In the example below the instance of
  376. <classname>ProductRepository</classname> and <classname>PurchaseRepository</classname> is only
  377. injected into the constructor of <classname>Services_PricingService2</classname>.
  378. </para>
  379. <programlisting language="php"><![CDATA[
  380. class Services_PricingService2
  381. {
  382. /**
  383. * @param ProductRepository $productRepository
  384. * @param PurchaseRepository $purchaseRepository
  385. */
  386. public function __construct(ProductRepository $productRepository,
  387. PurchaseRepository $purchaseRepository)
  388. {
  389. ...
  390. }
  391. /**
  392. * Calculate current price of product with $productId
  393. *
  394. * @param integer $productId
  395. * @return double
  396. */
  397. public function calculate($productId)
  398. {
  399. ...
  400. }
  401. }
  402. $server = new Zend_XmlRpc_Server();
  403. $server->sendArgumentsToAllMethods(false);
  404. $server->setClass('Services_PricingService2',
  405. 'pricing',
  406. new ProductRepository(),
  407. new PurchaseRepository());
  408. ]]></programlisting>
  409. </example>
  410. <example id="zend.xmlrpc.server.use.attach-instance">
  411. <title>Attaching a class instance</title>
  412. <para>
  413. <methodname>setClass()</methodname> allows to register a previously instantiated
  414. object at the server. Just pass an instance instead of the class name. Obviously
  415. passing arguments to the constructor is not possible with pre-instantiated
  416. objects.
  417. </para>
  418. </example>
  419. <example id="zend.xmlrpc.server.use.attach-several-classes-namespaces">
  420. <title>Attacher plusieurs classes grâce aux espaces de noms</title>
  421. <para>
  422. L'exemple ci dessous montre comment attacher plusieurs classes grâce aux
  423. espaces de noms.
  424. </para>
  425. <programlisting language="php"><![CDATA[
  426. require_once 'Services/Comb.php';
  427. require_once 'Services/Brush.php';
  428. require_once 'Services/Pick.php';
  429. $server = new Zend_XmlRpc_Server();
  430. $server->setClass('Services_Comb', 'comb');
  431. // méthodes appelées sous la forme comb.*
  432. $server->setClass('Services_Brush', 'brush');
  433. // méthodes appelées sous la forme brush.*
  434. $server->setClass('Services_Pick', 'pick');
  435. // méthodes appelées sous la forme pick.*
  436. echo $server->handle();
  437. ]]></programlisting>
  438. </example>
  439. <example id="zend.xmlrpc.server.use.exceptions-faults">
  440. <title>Spécifier les exceptions à utiliser en cas d'erreurs dans les réponses
  441. XML-RPC</title>
  442. <para>
  443. L'exemple ci dessous montre comment spécifier les exceptions à utiliser en cas
  444. d'erreurs dans les réponses XML-RPC.
  445. </para>
  446. <programlisting language="php"><![CDATA[
  447. require_once 'Services/Exception.php';
  448. require_once 'Services/Comb.php';
  449. require_once 'Services/Brush.php';
  450. require_once 'Services/Pick.php';
  451. // Utilise les Services_Exception pour les erreurs
  452. Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');
  453. $server = new Zend_XmlRpc_Server();
  454. $server->setClass('Services_Comb', 'comb');
  455. // méthodes appelées sous la forme comb.*
  456. $server->setClass('Services_Brush', 'brush');
  457. // méthodes appelées sous la forme brush.*
  458. $server->setClass('Services_Pick', 'pick');
  459. // méthodes appelées sous la forme pick.*
  460. echo $server->handle();
  461. ]]></programlisting>
  462. </example>
  463. <example id="zend.xmlrpc.server.use.custom-request-object">
  464. <title>Utiliser un objet de requête personnalisé</title>
  465. <para>
  466. Some use cases require to utilize a custom request object.
  467. For example, <acronym>XML/RPC</acronym> is not bound to
  468. <acronym>HTTP</acronym> as a transfer protocol. It is possible to use
  469. other transfer protocols like <acronym>SSH</acronym> or telnet to send
  470. the request and response data over the wire. Another use case is
  471. authentication and authorization. In case of a different transfer
  472. protocol, one need to change the implementation to read request data.
  473. </para>
  474. <para>
  475. L'exemple suivant montre comment utiliser un objet de requête
  476. personnalisé.
  477. </para>
  478. <programlisting language="php"><![CDATA[
  479. require_once 'Services/Request.php';
  480. require_once 'Services/Exception.php';
  481. require_once 'Services/Comb.php';
  482. require_once 'Services/Brush.php';
  483. require_once 'Services/Pick.php';
  484. // Utilise les Services_Exception pour les erreurs
  485. Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');
  486. $server = new Zend_XmlRpc_Server();
  487. $server->setClass('Services_Comb', 'comb');
  488. // méthodes appelées sous la forme comb.*
  489. $server->setClass('Services_Brush', 'brush');
  490. // méthodes appelées sous la forme brush.*
  491. $server->setClass('Services_Pick', 'pick');
  492. // méthodes appelées sous la forme pick.*
  493. // Crée un objet de requête
  494. $request = new Services_Request();
  495. echo $server->handle($request);
  496. ]]></programlisting>
  497. </example>
  498. <example id="zend.xmlrpc.server.use.custom-response-object">
  499. <title>Utiliser un objet de réponse personnalisé</title>
  500. <para>
  501. L'exemple suivant montre comment utiliser un objet de réponse
  502. personnalisé.
  503. </para>
  504. <programlisting language="php"><![CDATA[
  505. require_once 'Services/Request.php';
  506. require_once 'Services/Response.php';
  507. require_once 'Services/Exception.php';
  508. require_once 'Services/Comb.php';
  509. require_once 'Services/Brush.php';
  510. require_once 'Services/Pick.php';
  511. // Utilise les Services_Exception pour les erreurs
  512. Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');
  513. $server = new Zend_XmlRpc_Server();
  514. $server->setClass('Services_Comb', 'comb');
  515. // méthodes appelées sous la forme comb.*
  516. $server->setClass('Services_Brush', 'brush');
  517. // méthodes appelées sous la forme brush.*
  518. $server->setClass('Services_Pick', 'pick');
  519. // méthodes appelées sous la forme pick.*
  520. // Crée un objet de requête
  521. $request = new Services_Request();
  522. // Utilise une réponse personnalisée
  523. $server->setResponseClass('Services_Response');
  524. echo $server->handle($request);
  525. ]]></programlisting>
  526. </example>
  527. </sect2>
  528. <sect2 id="zend.xmlrpc.server.performance">
  529. <title>Optimisation des performances</title>
  530. <example id="zend.xmlrpc.server.performance.caching">
  531. <title>Cache entre les requêtes</title>
  532. <para>
  533. Les exemples suivants montrent comment gérer une politique de cache
  534. inter-requêtes.
  535. </para>
  536. <programlisting language="php"><![CDATA[
  537. require_once 'Services/Request.php';
  538. require_once 'Services/Response.php';
  539. require_once 'Services/Exception.php';
  540. require_once 'Services/Comb.php';
  541. require_once 'Services/Brush.php';
  542. require_once 'Services/Pick.php';
  543. // Specifier un fichier de cache
  544. $cacheFile = dirname(__FILE__) . '/xmlrpc.cache';
  545. // Utilise les Services_Exception pour les erreurs
  546. Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');
  547. $server = new Zend_XmlRpc_Server();
  548. // Essaye de récupérer la définition du serveur via le cache
  549. if (!Zend_XmlRpc_Server_Cache::get($cacheFile, $server)) {
  550. $server->setClass('Services_Comb', 'comb');
  551. // méthodes appelées sous la forme comb.*
  552. $server->setClass('Services_Brush', 'brush');
  553. // méthodes appelées sous la forme brush.*
  554. $server->setClass('Services_Pick', 'pick');
  555. // méthodes appelées sous la forme pick.*
  556. // Sauve le cache
  557. Zend_XmlRpc_Server_Cache::save($cacheFile, $server));
  558. }
  559. // Crée un objet de requête
  560. $request = new Services_Request();
  561. // Utilise une réponse personnalisée
  562. $server->setResponseClass('Services_Response');
  563. echo $server->handle($request);
  564. ]]></programlisting>
  565. </example>
  566. <note>
  567. <para>
  568. The server cache file should be located outside the document root.
  569. </para>
  570. </note>
  571. <example id="zend.xmlrpc.server.performance.xmlgen">
  572. <title>Optimizing XML generation</title>
  573. <para>
  574. <classname>Zend_XmlRpc_Server</classname> uses
  575. <classname>DOMDocument</classname> of <acronym>PHP</acronym>
  576. extension <emphasis>ext/dom</emphasis> to generate it's
  577. <acronym>XML</acronym> output. While <emphasis>ext/dom</emphasis> is
  578. available on a lot of hosts it is is not exactly the fastest.
  579. Benchmarks have shown, that <classname>XMLWriter</classname>
  580. from <emphasis>ext/xmlwriter</emphasis> performs better.
  581. </para>
  582. <para>
  583. If <emphasis>ext/xmlwriter</emphasis> is available on your host, you can
  584. select a the <classname>XMLWriter</classname>-based generator
  585. to leaverage the performance differences.
  586. </para>
  587. <programlisting language="php"><![CDATA[
  588. require_once 'Zend/XmlRpc/Server.php';
  589. require_once 'Zend/XmlRpc/Generator/XmlWriter.php';
  590. Zend_XmlRpc_Value::setGenerator(new Zend_XmlRpc_Generator_XmlWriter());
  591. $server = new Zend_XmlRpc_Server();
  592. ...
  593. ]]></programlisting>
  594. </example>
  595. <note>
  596. <title>Benchmark your application</title>
  597. <para>
  598. Performance is determined by a lot of parameters and
  599. benchmarks only apply for the specific test case. Differences
  600. come from PHP version, installed extensions, webserver and
  601. operating system just to name a few. Please make sure to
  602. benchmark your application on your own and decide which
  603. generator to use based on <emphasis>your</emphasis> numbers.
  604. </para>
  605. </note>
  606. <note>
  607. <title>Benchmark your client</title>
  608. <para>
  609. This optimization makes sense for the client side too. Just
  610. select the alternate <acronym>XML</acronym> generator before
  611. doing any work with <classname>Zend_XmlRpc_Client</classname>.
  612. </para>
  613. </note>
  614. </sect2>
  615. </sect1>