Zend_XmlRpc_Server ist als vollständiger XML-RPC Server geplant, der den » Spezifikationen auf www.xmlrpc.com folgt. Des Weiteren implementiert er die Methode system.multicall(), welche dem Entwickler erlaubt, mehrere Anfragen aufzureihen.

Ein Beispiel der grundlegendsten Benutzung:

$server = new Zend_XmlRpc_Server();
$server->setClass('My_Service_Class');
echo $server->handle();

        

Zend_XmlRpc_Server ist aus einer Vielfalt von Komponenten zusammengesetzt, die vom Server selbst über Anfrage-, Antwort- und bis hin zu Fehler-Objekten reicht.

Um den Zend_XmlRpc_Server zu erstellen, muss der Entwickler dem Server eine oder mehrere Klassen oder Funktionen durch die Methoden setClass() und addFunction() hinzufügen.

Wenn dieses erstmal erledigt wurde, kann man entweder der Methode Zend_XmlRpc_Server::handle() ein Zend_XmlRpc_Request-Objekt übergeben oder es wird ein Zend_XmlRpc_Request_Http instanziert, falls keines angegeben wurde - die Anfrage wird also aus php://input geladen.

Zend_XmlRpc_Server::handle() versucht daraufhin, den zuständigen Handler, der durch die angeforderte Methode bestimmt wird, auszuführen. Es wird entweder ein Zend_XmlRpc_Response- oder ein Zend_XmlRpc_Server_Fault-Objekt zurückgegeben. Beide Objekte besitzen eine Methode __toString(), die eine valide XML-RPC Antwort im XML-Format zurückgibt, die direkt ausgegeben werden kann.

Zend_XmlRpc_Server ermöglicht es dem Entwickler, Funktionen und Methodenaufrufe als ausführbare XML-RPC Methoden anzufügen. Durch Zend_Server_Reflection wird die Überwachung aller angefügten Methoden - durch Nutzung der DocBlocks der Methoden und Funktionen werden deren Hilfstexte und Signaturen ermittelt - ermöglicht.

XML-RPC Typen werden nicht zwingend 1:1 zu PHP-Typen konvertiert. Dennoch wird versucht, einen passenden Typ, anhand der in @param- und @return-Zeilen enthaltenen Werte, zu ermitteln. Einige XML-RPC-Typen besitzen jedoch kein direktes Äquivalent und sollten deshalb mittels phpdoc auf einen XML-RPC-Typen hinweisen. Diese beinhalten:

• dateTime.iso8601, ein String, formatiert als YYYYMMDDTHH:mm:ss

• base64, base64-kodierte Daten

• struct, jegliches assoziatives Array

'Anbei ein Beispiel für einen solchen Hinweis:

/**
* Dies ist eine Beispielfunktion.
*
* @param base64 $val1 Base64-kodierte Daten
* @param dateTime.iso8601 $val2 Ein ISO-Datum
* @param struct $val3 ein assoziatives Array
* @return struct
*/
function myFunc($val1, $val2, $val3)
{
}

        

PhpDocumentor validiert keine Typen, die in Parameter- oder Rückgabewerten angegeben sind, weshalb dies keinen Einfluss auf die API-Dokumentation hat. Das Angeben der Hinweise ist notwendig, da der Server die, dem Methodenaufruf zugewiesenen, Parameter validiert.

Es ist genauso gut möglich, mehrere Werte als Parameter oder für die Rückgabe anzugeben; die XML-RPC Spezifikation schlägt sogar vor, dass system.methodeSignatur ein Array, das alle möglichen Methodensignaturen (d.h. jegliche Kombination aus Parametern und Rückgabewerten) enthält, zurückgibt. Um dies zu erreichen, kann man, wie man es normalerweise auch beim PhpDocumentor auch tun würde, einfach den '|'-Operator nutzen.

/**
* Dies ist eine Beispiel-Funktion.
*
* @param string|base64 $val1 String oder base64-kodierte Daten
* @param string|dateTime.iso8601 $val2 String oder ein ISO-Datum
* @param array|struct $val3 Normal indiziertes oder assoziatives Array
* @return boolean|struct
*/
function myFunc($val1, $val2, $val3)
{
}

        

Dennoch eine Anmerkung: Das Erlaubung von vielen Signaturen kann zu Verwirrung für Entwickler führen, die diese Services nutzen; man sollte einer XML-RPC Methode deshalb nur eine Signatur zuweisen.

XML-RPC besitzt ein Konzept für Namensräume; Grundlegend erlaubt es das Gruppieren von XML-RPC-Methoden durch Punkt-separierte Namensräume. Dies hilft, Namenkollisionen zwischen Methoden, die durch verschiedene Klassen offeriert werden, zu verhindern. Beispielsweise kann der XML-RPC-Server mehrere Methoden im 'system'-Namensraum nutzen:

• system.listMethods

• system.methodHelp

• system.methodSignature

Intern werden die Methoden zu Methoden desselben Namens in der Klasse Zend_XmlRpc_Server umgeleitet.

Um angebotenen Methoden Namensräume hinzuzufügen, muss man lediglich beim Hinzufügen der gewünschten Klasse oder Funktion einen Namensraum angeben:

// Alle öffentlichten Methoden in My_Service_Class sind als
// myservice.METHODNAME verfügbar
$server->setClass('My_Service_Class', 'myservice');

// Funktion 'somefunc' ist als funcs.somefunc ansprechbar.
$server->addFunction('somefunc', 'funcs');

        

Die meiste Zeit wird man einfach den Standard-Anfragetyp Zend_XmlRpc_Request_Http, welcher im Zend_XmlRpc_Server enthalten ist, nutzen. Jedoch gibt es gelegentlich Fälle, in denen XML-RPC über die Kommandozeile (CLI), ein grafisches Benutzerinterface (GUI), eine andere Umgebung oder beim Protokollieren von ankommenden Anfragen erreichbar sein muss. Um dies zu bewerkstelligen, muss man ein eigenes Anfrage-Objekt kreieren, das Zend_XmlRpc_Request erweitert. Die wichtigste Sache, die man sich merken muss, ist sicherzustellen, dass die Methoden getMethod() und getParams() implementiert sind, so dass der XML-RPC-Server Informationen erhält, die er für das Abfertigen einer Anfrage benötigt.

Ähnlich wie bei den Anfrage-Objekten, kann der Zend_XmlRpc_Server auch eigene Antwortobjekte ausliefern; standardmäßig ist dies ein Zend_XmlRpc_Response_Http-Objekt, das einen passenden Content-Type HTTP-Header sendet, der für XML-RPC genutzt wird. Mögliche Nutzungen eines eigenen Objekts sind z.B. das Protokollieren von Antworten oder das Senden der Antworten zu STDOUT.

Um eine eigene Antwortklasse zu nutzen, muss Zend_XmlRpc_Server::setResponseClass() vor dem Aufruf von handle() aufgerufen werden.

Zend_XmlRpc_Server fängt die, durch eine ausgeführte Methode erzeugten, Exceptions and generiert daraus einen XML-RPC-Fehler als Antwort, wenn eine Exception gefangen wurde. Normalerweise werden die Exceptionnachrichten und -codes nicht in der Fehler-Antwort genutzt. Dies ist eine gewollte Entscheidung um den Code zu schützen; viele Exceptions entblößen mehr Informationen über den Code oder die Umgebung als der Entwickler wünscht (ein Paradebeispiel beinhaltet Datenbankabstraktion- oder die Zugriffsschichten-Exceptions).

Exception-Klassen können jedoch anhand einer Weißliste (Whitelist) als Fehler-Antworten zurückgegeben werden. Dazu muss man lediglich die gewünschte Exception mittels Zend_XmlRpc_Server_Fault::attachFaultException() zur Weißliste hinzufügen:

Zend_XmlRpc_Server_Fault::attachFaultException('My_Project_Exception');

        

Abgeleitete Exceptions lassen sich als ganze Familie von Exceptions hinzufügen, indem man deren Basisklasse angibt. Zend_XmlRpc_Server_Exceptions sind immer auf der Weißliste zu finden, da sie spezielle Serverfehler berichten (undefinierte Methoden, etc.).

Jede Exception, die nicht auf der Weißliste zu finden ist, generiert eine Antwort mit dem '404' Code und der Nachricht 'Unknown error'.

Das Hinzufügen einer Vielzahl von Klassen zu einer XML-RPC-Server Instanz kann zu einem großen Ressourcenverbrauch führen; jede Klasse muss via Reflection (Zend_Server_Reflection) inspiziert werden, welche eine Liste von allen möglichen Signaturen, die der Server verwenden kann, zurückgibt.

Um die Einbußen zu reduzieren, kann Zend_XmlRpc_Server_Cache genutzt werden, welche die Serverdefinitionen zwischen den Anfragen zwischenspeichert. Wenn dies mit __autoload() kombiniert wird, kann es zu einem großen Geschwindigkeitsschub kommen.

Ein Beispiel folgt:

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');   // glue. Namensraum
    $server->setClass('My_Services_Paste', 'paste'); // paste. Namensraum
    $server->setClass('My_Services_Tape', 'tape');   // tape. Namensraum

    Zend_XmlRpc_Server_Cache::save($cacheFile, $server);
}

echo $server->handle();

        

Obiges Beispiel zeigt, wie der Server versucht, eine Definition aus der Datei xmlrpc.cache, welches sich im selben Ordner wie das Skript befindet, zu laden. Wenn dies nicht erfolgreich ist, lädt es die Server-Klassen, die es benötigt, und fügt sie zum Server hinzu. Danach wird versucht, die Cache-Datei mit der Serverdefinition zu erstellen.

Unten finden sich etliche Beispiele für eine Nutzung, die das gesamte Spektrum der verfügbaren Optionen für den Entwickler darstellen. These Beispiele bauen immer auf den vorangegangenen Beispielen auf.

/**
 * Gibt die MD5-Summe eines Strings zurück.
 *
 * @param string $value Wert aus dem die MD5-Summe errechnet wird
 * @return string MD5-Summe des Werts
 */
function md5Value($value)
{
    return md5($value);
}

$server = new Zend_XmlRpc_Server();
$server->addFunction('md5Value');
echo $server->handle();

            

$server = new Zend_XmlRpc_Server();
$server->setClass('Services_Comb');
echo $server->handle();

            

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');   // Methoden werden als comb.* aufgerufen
$server->setClass('Services_Brush', 'brush'); // Methoden werden als brush.* aufgerufen
$server->setClass('Services_Pick', 'pick');   // Methoden werden als pick.* aufgerufen
echo $server->handle();

            

require_once 'Services/Exception.php';
require_once 'Services/Comb.php';
require_once 'Services/Brush.php';
require_once 'Services/Pick.php';

// Services_Exceptions dürfen als Fehler-Antwort genutzt werden
Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');

$server = new Zend_XmlRpc_Server();
$server->setClass('Services_Comb', 'comb');   // Methoden werden als comb.* aufgerufen
$server->setClass('Services_Brush', 'brush'); // Methoden werden als brush.* aufgerufen
$server->setClass('Services_Pick', 'pick');   // Methoden werden als pick.* aufgerufen
echo $server->handle();

            

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';

// Services_Exceptions dürfen als Fehler-Antwort genutzt werden
Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');

$server = new Zend_XmlRpc_Server();
$server->setClass('Services_Comb', 'comb');   // Methoden werden als comb.* aufgerufen
$server->setClass('Services_Brush', 'brush'); // Methoden werden als brush.* aufgerufen
$server->setClass('Services_Pick', 'pick');   // Methoden werden als pick.* aufgerufen

// Ein neues Anfrage-Objekt wird erstellt
$request = new Services_Request();

echo $server->handle($request);

            

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';

// Services_Exceptions dürfen als Fehler-Antwort genutzt werden
Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');

$server = new Zend_XmlRpc_Server();
$server->setClass('Services_Comb', 'comb');   // Methoden werden als comb.* aufgerufen
$server->setClass('Services_Brush', 'brush'); // Methoden werden als brush.* aufgerufen
$server->setClass('Services_Pick', 'pick');   // Methoden werden als pick.* aufgerufen

// Ein neues Anfrage-Objekt wird erstellt
$request = new Services_Request();

// Nutzen eigener Antwort-Klasse
$server->setResponseClass('Services_Response');

echo $server->handle($request);

            

// Definieren einer Cache-Datei
$cacheFile = dirname(__FILE__) . '/xmlrpc.cache';

// Services_Exceptions dürfen als Fehler-Antwort genutzt werden
Zend_XmlRpc_Server_Fault::attachFaultException('Services_Exception');

$server = new Zend_XmlRpc_Server();

// Versucht die Serverdefinition aus dem Cache zu laden
if (!Zend_XmlRpc_Server_Cache::get($cacheFile, $server)) {
    $server->setClass('Services_Comb', 'comb');   // Methoden werden als comb.* aufgerufen
    $server->setClass('Services_Brush', 'brush'); // Methoden werden als brush.* aufgerufen
    $server->setClass('Services_Pick', 'pick');   // Methoden werden als pick.* aufgerufen

    // Speichern des Caches
    Zend_XmlRpc_Server_Cache::save($cacheFile, $server));
}

// Ein neues Anfrage-Objekt wird erstellt
$request = new Services_Request();

// Nutzen eigener Antwort-Klasse
$server->setResponseClass('Services_Response');

echo $server->handle($request);