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