Das Zend Framework bietet Unterstützung, als Client - durch das Zend_XmlRpc_Client Paket - entfernte XML-RPC-Dienste zu nutzen. Seine wichtigsten Möglichkeiten beinhalten das automatische Umwandeln zwischen PHP und XML-RPC, ein Server Proxy-Objekt und den Zugriff auf Server-Prüfungsmöglichkeiten.

Der Konstruktor von Zend_XmlRpc_Client erhält den URL des Endpunktes des entfernten XML-RPC-Server als ersten Parameter. Die zurückgegebene Instanz kann genutzt werden, um eine beliebige Anzahl von entfernten Methoden (des Endpunktes) aufzurufen.

Um eine entfernte Methode mittels des XML-RPC-Clients aufzurufen, muss man den Client instanzieren und dessen Methode call() aufrufen. Das hierunter gegebene Codebeispiel demonstriert den XML-RPC server der Zend Framework Webseite. Es kann benutzen, um Zend_XmlRpc-Komponenten zu testen oder auszuprobieren.

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

echo $client->call('test.sayHello');

// hello
            

Der - durch den Aufruf einer entfernten Methode - zurückgegebene, typenlose XML-RPC Wert wird automatisch zu dessen nativen PHP-Äquivalent umgeformt. In obigem Beispiel wird ein string zurückgegeben und ist sofort benutzbar.

Der erste Parameter the Methode call() ist der Name der aufzurufenden Methode. Wenn die entfernte Methode weitere Parameter benötigt, können diese durch einen zweiten, optionalen Parameter des Typs array angegeben werden, wie folgendes Beispiel zeigt:

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$arg1 = 1.1;
$arg2 = 'foo';

$result = $client->call('test.sayHello', array($arg1, $arg2));

// $result ist ein nativer PHP-Typ
            

Wenn die entfernte Methode keine Parameter erwartet, kann der optionale Parameter weggelassen oder stattdessen ein leeres array() übergeben werden. Das, die Parameter - für die entfernte Methode - enthaltende, Array kann native PHP-Typen, Zend_XmlRpc_Value-Objekte oder eine Mischung aus Beidem enthalten.

Die call()-Methode konvertiert automatisch die XML-RPC-Antwort in dessen äquivalenten nativen PHP-Typen und gibt sie zurück. Ein Zend_XmlRpc_Response-Objekt als Rückgabewert ist auch verfübar durch das Aufrufen der Methode getLastResponse() nach dem Aufruf (der entfernten Methode).

Einige entfernte Methodenaufrufe benötigen Parameter. Diese werden an die Methode call() des Zend_XmlRpc_Clients als Array im zweiten Parameter übergeben. Jeder Parameter kann entweder ein nativer PHP-Typ sein, der automatisch konvertiert wird, oder ein Objekt, das einem speziellen XML-RPC-Typen (eines der Zend_XmlRpc_Value-Objekte) entspricht.

Ein anderer Weg um entfernte Methoden mittels des XML-RPC-Clients aufzurufen, wird durch die Benutzung des Server-Proxys eröffnet. Dies ist ein PHP-Objekt, das einen entfernten XML-RPC Namensraum umleitet, sodass es möglichst so aussieht, als würde ein natives PHP-Objekt angesprochen werden statt des XML-RPC-Services.

Um einen Server-Proxy zu instanzieren, muss die Methode getProxy() der Klasse Zend_XmlRpc_Client aufgerufen werden. Jeder Methodenaufruf wird zur entsprechenden entfernten Methode weitergeleitet. Die Parameter können übergeben werden, wie bei jeder anderen PHP-Methode.

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$server = $client->getProxy();           // Umleitung im Standard-Namenraum

$hello = $server->test->sayHello(1, 2);  // test.Hello(1, 2) gibt "hello" zurück
            

Die Methode getProxy() erhält ein optionales Argument, welches den Namensraum des entfernten Servers definiert, zu welchem die Methodenaufrufe umgeleitet werden. Wenn kein Namensraum übergeben wird, wird zum Standard-Namensraum umgeleitet. Im nächsten Beispiel wird zum test-Namensraum umgeleitet:

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$test  = $client->getProxy('test');     // Leitet zum "test"-Namensraum um

$hello = $test->sayHello(1, 2);         // test.Hello(1,2) gibt "hello" zurück
            

Wenn der entfernte Server verschachtelte Namensräume jeglicher Tiefe erlaubt, können diese auch durch den Server-Proxy genutzt werden. Wenn der Server in obigem Beispiel eine Methode test.foo.bar() hätte, könnte es durch $test->foo->bar() aufgerufen werden.

Es gibt zwei Arten von Fehlern, die während eines XML-RPC Methodenaufruf autreten können: HTTP- und XML-RPC-Fehler. Der Zend_XmlRpc_Client erkennt beide und ermöglicht es, diese unabhängig voneinander zu entdecken und abzufangen.

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://foo/404');

try {

    $client->call('bar', array($arg1, $arg2));

} catch (Zend_XmlRpc_Client_HttpException $e) {

    // $e->getCode() gibt 404 zurück
    // $e->getMessage() gibt "Not Found" zurück

}
                

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

try {

    $client->call('badMethod');

} catch (Zend_XmlRpc_Client_FaultException $e) {

    // $e->getCode() gibt 1 zurück
    // $e->getMessage() gibt "Unknown method" zurück

}
                

Einige XML-RPC Server bieten de facto Überprüfungsmethoden unter dem XML-RPC Namesraum system.. Zend_XmlRpc_Client stellt spezielle Verfahren für Server mit diesen Möglichkeiten zur Verfügung.

Eine Instanz der Klasse Zend_XmlRpc_Client_ServerIntrospection kann über die Methode getIntrospector() der Klasse Zend_XmlRpcClient zurückgegeben werden. Sie kann dann genutzt werden, um Überwachungsoperationen auf dem Server auszuführen.

Intern erstellt die Methode call() des Zend_XmlRpc_Client-Objekts ein Anfrage-Objekt (Zend_XmlRpc_Request) und sendet es zu einer anderen Methode, doRequest(), die ein Antwort-Objekt (Zend_XmlRpc_Response) zurückgibt.

Die Methode doRequest() kann auch direkt genutzt werden:

<?php
require_once 'Zend/XmlRpc/Client.php';

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$request = new Zend_XmlRpc_Request();
$request->setMethod('test.sayHello');
$request->setParams(array('foo', 'bar'));

$client->doRequest($request);

// $server->getLastRequest() gibt ein Zend_XmlRpc_Request-Objekt zurück
// $server->getLastResponse() gibt ein Zend_XmlRpc_Response-Objekt zurück
            

Immer wenn eine XML-RPC-Methode vom Client aufgerufen wird, egal auf welche Weise - entweder über die Methode call(), die Methode doRequest() oder den Server-Proxy -, ist das Objekt der letzten Anfrage, sowie dessen resultierende Antwort-Objekte, immer durch die Methoden getLastRequest() und getLastResponse() verfügbar.

In jedem der vorangegangenen Beispiele wurde kein HTTP-Client bestimmt. In diesem Fall wird eine neue Instanz eines Zend_Http_Clients mit dessen standardmäßigen Einstellungen erstellt und automatisch vom Zend_XmlRpc_Client benutzt.

Der HTTP-Client kann zu jeder Zeit mit der Methode getHttpClient() zurückgegeben werden. In den meisten Fällen jedoch ist der Standard-HTTP-Client ausreichend. Allerdings erlaubt die Methode setHttpClient() das Setzen eines anderen HTTP-Clients.

Die Methode setHttpClient() ist besonders nützlich für UnitTests. Wenn es mit dem Zend_Http_Client_Adapter_Test kombiniert wird, können entfernte Services für das Testen nachgeahmt werden. In den UnitTests für Zend_XmlRpc_Client sind Beispiele, wie so was erreicht werden kann.