Previous Next

Zend_XmlRpc_Server

Einführung

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.

Grundlegende Benutzung

Ein Beispiel der grundlegendsten Benutzung:

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

Server-Struktur

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.

Konventionen

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.

Nutzen von Namensräumen

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

Eigene Request-Objekte

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.

Eigene Antwort-Objekte

Ä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.

Verarbeiten von Exceptions durch Fehler

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

Zwischenspeichern von Serverdefinitionen zwischen den Anfragen

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.

Nutzungsbeispiele

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.

Grundlegende Benutzung

Folgendes Beispiel fügt eine Funktion als ausführbare XML-RPC-Methode hinzu und verarbeitet eingehende Aufrufe.

/**
 * 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();

Hinzufügen einer Klasse

Das nächste Beispiel illustriert, wie man die öffentlichen Methoden eienr Klasse als ausführbare XML-RPC-Methoden hinzufügt.

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

Mehrere Klassen unter der Nutzung von Namensräumen hinzufügen

Das nächste Beispiel zeigt, wie man mehrer Klassen mit ihren eigenen Namensräumen hinzufügt.

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();

Bestimmen von Exceptions als valide Fehler-Antwort

Im nächsten Beispiel wird gezeigt, wie man jede Exception, die von Services_Exception abgeleitet wurde, als Fehler-Antwort nutzen kann, dessen Nachricht und Code erhalten bleibt.

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();

Nutzen eines eigenen Anfrage-Objekts

Im folgenden Beispiel wird ein eigenes Anfrage-Objekt instanziert und durch den Server verarbeitet.

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

Nutzen eigener Antwort-Objekte

Das nachstehende Beispiel zeigt, wie man eine eigene Antwort-Klasse als zurückgegebene Antwort für den Server setzt.

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

Zwischenspeichern von Serverdefinition zwischen den Anfragen

Dieses Beispiel zeigt, wie man Serverdefinitionen zwischen verschiedenen Anfragen zwischenspeichern kann.

// 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);
Previous Next
Introduction to Zend Framework
Übersicht
Installation
Zend_Acl
Einführung
Verfeinern der Zugriffskontrolle
Fortgeschrittene Verwendung
Zend_Amf
Einführung
Zend_Amf_Server
Zend_Auth
Einführung
Datenbanktabellen Authentifizierung
Digest Authentication
HTTP Authentication Adapter
LDAP Authentifizierung
Open ID Authentifikation
Zend_Cache
Einführung
Die Theorie des Cachens
Zend_Cache Frontends
Zend_Cache Backends
Zend_Captcha
Einführung
Captcha Anwendung
Captcha Adapter
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung in Getopt
Definieren von Getopt Regeln
Holen von Optionen und Argumenten
Konfigurieren von Zend_Console_Getopt
Zend_Controller
Zend_Controller Schnellstart
Zend_Controller Grundlagen
Der Front Controller
Das Request Objekt
Der Standard Router
Der Dispatcher
Action Kontroller
Action Helfer
Das Response Objekt
Plugins
Eine konventionelle modulare Verzeichnis Struktur verwenden
MVC Ausnahmen
Migration von vorhergehenden Versionen
Zend_Currency
Einführung in Zend_Currency
Arbeiten mit Währungen
Migration von vorhergehenden Versionen
Zend_Date
Einführung
Theorie der Arbeitsweise
Basis Methoden
Zend_Date API Übersicht
Erstellen von Datumswerten
Konstanten für generelle Datums Funktionen
Funktionierende Beispiele
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Dojo Form Elemente und Dekoratore
Zend_Dom
Einführung
Zend_Dom_Query
Zend_Exception
Verwenden von Ausnahmen
Zend_Feed
Einführung
Feeds importieren
Feeds von Websites abrufen
Einen RSS Feed konsumieren
Einen Atom Feed konsumieren
Einen einzelnen Atom Eintrag konsumieren
Verändern der Feed- und Eintragsstruktur
Eigene Klassen für Feeds und Einträge
Zend_File
Zend_File_Transfer
Prüfungen für Zend_File_Transfer
Filter für Zend_File_Transfer
Migration von vorhergehenden Versionen
Zend_Filter
Einführung
Standard Filter Klassen
Filter Ketten
Filter schreiben
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Schnellstart mit Zend_Form
Erstellen von Form Elementen mit Hilfe von Zend_Form_Element
Erstellen von Form durch Verwendung von Zend_Form
Erstellen von eigenem Form Markup durch Zend_Form_Decorator
Standard Form Elemente die mit dem With Zend Framework ausgeliefert werden
Standard Form Dekoratore die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung zu Gdata
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Using Google Health
Google Tabellenkalkulation verwenden
Google Apps Provisionierung verwenden
Google Base verwenden
Picasa Web Alben verwenden
Verwenden der YouTube Daten API
Gdata Ausnahmen auffangen
Zend_Http
Zend_Http_Client - Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
JSON Objects
XML zu JSON Konvertierung
Zend_Json_Server - JSON-RPC server
Zend_Layout
Einführung
Zend_Layout Schnellstart
Zend_Layout Konfigurations Optionen
Erweiterte Verwendung von Zend_Layout
Zend_Ldap
Einleitung
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Plugins laden
Zend_Locale
Einführung
Zend_Locale verwenden
Normalisierung und Lokalisierung
Arbeiten mit Daten und Zeiten
Unterstützte Gebietsschemata
Migrieren von vorhergehenden Versionen
Zend_Log
Übersicht
Writer
Formatter
Filter
Zend_Mail
Einführung
Versand über SMTP
Versand von mehreren E-Mails über eine SMTP Verbindung
Verwendung von unterschiedlichen Versandwegen
HTML E-Mail
Anhänge
Empfänger hinzufügen
Die MIME Abgrenzung kontrollieren
Zusätzliche Kopfzeilen
Zeichensätze
Kodierung
SMTP Authentifizierung
SMTP Übertragungen sichern
Lesen von Mail Nachrichten
Zend_Measure
Einführung
Erstellung einer Maßeinheit
Ausgabe von Maßeinheiten
Manipulation von Maßeinheiten
Arten von Maßeinheiten
Zend_Memory
Übersicht
Memory Manager
Memory Objekte
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
Einführung
Zend_OpenId_Consumer Grundlagen
Zend_OpenId_Provider
Zend_Paginator
Einführung
Verwendung
Konfiguration
Advanced usage
Zend_Pdf
Einführung
Erstellen und Laden von PDF Dokumenten
Änderungen von PDF Dokumenten speichern
Dokument Seiten
Zeichnen
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Registry
Die Registry verwenden
Zend_Rest
Einführung
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Überblick
Indexerstellung
Einen Index durchsuchen
Abfragesprache
Abfrage Erzeugungs API
Zeichensätze
Erweiterbarkeit
Zusammenarbeit Mit Java Lucene
Erweitert
Die besten Anwendungen
Zend_Server
Einführung
Zend_Server_Reflection
Zend_Service
Einführung
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Einführung
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Mitgelieferte Services
Zend_Service_StrikeIron: Erweiterte Verwendung
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Einführung
Grundsätzliche Verwendung
Fortgeschrittene Benutzung
Globales Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Zugriffsmethoden
AutoDiscovery
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Translate
Einführung
Adapter für Zend_Translate
Benutzen von Übersetzungs Adaptoren
Migration von vorhergehenden Versionen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Zend_Version
Auslesen der Version des Zend Frameworks
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Voraussetzungen
PHP Version
PHP Erweiterungen
Zend Framework Komponenten
Zend Framework Abhängigkeiten
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Performance Guide
Einführung
Laden von Klassen
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen