Class: XML_RPC2_Server

Source Location: /XML_RPC2-1.0.5/XML/RPC2/Server.php

Class Overview

XML_RPC2_Server is the frontend class for exposing PHP functions via XML-RPC.

Author(s):

Sergio Carvalho <sergio.carvalho at portugalmail.com>

Copyright:

2004-2006 Sergio Carvalho

Variables

Methods

Child classes:

XML_RPC2_Backend_Xmlrpcext_Server: XML_RPC server class XMLRPCext extension-based backend

XML_RPC2_Backend_Php_Server: XML_RPC server class PHP-only backend.

Inherited Variables

Inherited Methods

Class Details

[line 97]
XML_RPC2_Server is the frontend class for exposing PHP functions via XML-RPC.

Exporting a programatic interface via XML-RPC using XML_RPC2 is exceedingly easy:

The first step is to assemble all methods you wish to export into a class. You may either create a (abstract) class with exportable methods as static, or use an existing instance of an object.

You'll then need to document the methods using PHPDocumentor tags. XML_RPC2 will use the documentation for server introspection. You'll get something like this:

 class ExampleServer {

     /**
      * hello says hello
      *
      * @param string  Name
      * @return string Greetings
      */
     public static function hello($name)
         return "Hello $name";
     }
 }

Now, instantiate the server, using the Factory method to select a backend and a call handler for you:

 require_once 'XML/RPC2/Server.php';

 $server = XML_RPC2_Server::create('ExampleServer');
 $server->handleCall();

This will create a server exporting all of the 'ExampleServer' class' methods. If you wish to export instance methods as well, pass an object instance to the factory instead:

 require_once 'XML/RPC2/Server.php';

 $server = XML_RPC2_Server::create(new ExampleServer());
 $server->handleCall();

Author: Sergio Carvalho <sergio.carvalho@portugalmail.com>
Copyright: 2004-2006 Sergio Carvalho
Link: http://pear.php.net/package/XML_RPC2
Abstract:
License: LGPL License 2.1

[ Top ]

Class Variables

$autoDocument = true

[line 132]

display html documentation of xmlrpc exported methods when there is no post datas

Access: protected

Type:

boolean

[ Top ]

$autoDocumentExternalLinks = true

[line 139]

display external links at the end of autodocumented page

Access: protected

Type:

boolean

[ Top ]

$callHandler = null

[line 109]

callHandler field

The call handler is responsible for executing the server exported methods

Access: protected

Type:

mixed

[ Top ]

$encoding = 'iso-8859-1'

[line 125]

encoding field

TODO : work on encoding for this backend

Access: protected

Type:

string

[ Top ]

$prefix = ''

[line 116]

prefix field

Access: protected

Type:

string

[ Top ]

$signatureChecking = true

[line 149]

signature checking flag

if set to true, the server will check the method signature before calling the corresponding php method

Access: protected

Type:

boolean

[ Top ]

Method Detail

__construct (Constructor) [line 160]

XML_RPC2_Server __construct(
object
$callHandler, [array
$options = array()])

Create a new XML-RPC Server.

Access: protected

Overridden in child classes as:

XML_RPC2_Backend_Xmlrpcext_Server::__construct(): Create a new XML-RPC Server.

XML_RPC2_Backend_Php_Server::__construct(): Create a new XML-RPC Server.

Parameters:

object	`$callHandler`	—	the call handler will receive a method call for each remote call received.
array	`$options`	—	associative array of options

[ Top ]

autoDocument [line 260]

string autoDocument(
)

autoDocument. Produce an HTML page from the result of server introspection

Return: HTML document describing this server
Access: public

[ Top ]

create [line 190]

object a create(
mixed
$callTarget, [array
$options = array()])

Factory method to select a backend and return a new XML_RPC2_Server based on the backend

Return: server class instance
Access: public

Parameters:

mixed	`$callTarget`	—	either a class name or an object instance.
array	`$options`	—	associative array of options

[ Top ]

errorToException [line 236]

void errorToException(
int
$errno, string
$errstr, string
$errfile, int
$errline)

Transform an error into an exception

Access: public

Parameters:

int	`$errno`	—	error number
string	`$errstr`	—	error string
string	`$errfile`	—	error file
int	`$errline`	—	error line

[ Top ]

getContentLength [line 318]

integer getContentLength(
string
$content)

Gets the content legth of a serialized XML-RPC message in bytes

Return: the content length in bytes.
Access: protected

Parameters:

string $content — the serialized XML-RPC message.

[ Top ]

handleCall [line 223]

void handleCall(
)

Receive the XML-RPC request, decode the HTTP payload, delegate execution to the call handler, and output the encoded call handler response.

Abstract:
Access: public

Overridden in child classes as:

XML_RPC2_Backend_Xmlrpcext_Server::handleCall(): Respond to the XML-RPC request.

XML_RPC2_Backend_Php_Server::handleCall(): Receive the XML-RPC request, decode the HTTP payload, delegate execution to the call handler, and output the encoded call handler response.

[ Top ]