Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
An XML-RPC server implementation
Example:
require_once 'Zend/XmlRpc/Server.php';
require_once 'Zend/XmlRpc/Server/Cache.php';
require_once 'Zend/XmlRpc/Server/Fault.php';
require_once 'My/Exception.php';
require_once 'My/Fault/Observer.php';
// Instantiate server
$server = new Zend_XmlRpc_Server();
// Allow some exceptions to report as fault responses:
Zend_XmlRpc_Server_Fault::attachFaultException('My_Exception');
Zend_XmlRpc_Server_Fault::attachObserver('My_Fault_Observer');
// Get or build dispatch table:
if (!Zend_XmlRpc_Server_Cache::get($filename, $server)) {
require_once 'Some/Service/Class.php';
require_once 'Another/Service/Class.php';
// Attach Some_Service_Class in 'some' namespace
$server->setClass('Some_Service_Class', 'some');
// Attach Another_Service_Class in 'another' namespace
$server->setClass('Another_Service_Class', 'another');
// Create dispatch table cache file
Zend_XmlRpc_Server_Cache::save($filename, $server);
}
$response = $server->handle();
echo $response;

string
$_responseClass= ''Zend_XmlRpc_Response_Http''
Class to use for responses; defaults to {@link Zend_XmlRpc_Response_Http}
'Zend_XmlRpc_Response_Http'
Details
bool
$_sendArgumentsToAllMethods= 'true'
Send arguments to all methods or just constructor?
true
Details
__call(
string $method, array $params
)
:
mixed
Proxy calls to system object
Name | Type | Description |
---|---|---|
$method | string | |
$params | array |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_XmlRpc_Server_Exception |

_fixType(
string $type
)
:
string
Map PHP type to XML-RPC type
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
string |

_handle(
\Zend_XmlRpc_Request $request
)
:
\Zend_XmlRpc_Response
Handle an xmlrpc call (actual work)
Name | Type | Description |
---|---|---|
$request | \Zend_XmlRpc_Request |
Type | Description |
---|---|
\Zend_XmlRpc_Response |
Exception | Description |
---|---|
\Zend_XmlRpcServer_Exception|\Exception | Zend_XmlRpcServer_Exceptions are thrown for internal errors; otherwise, any other exception may be thrown by the callback |

addFunction(
string|array $function, string $namespace
=
''
)
:
void
Attach a callback as an XMLRPC method
Attaches a callback as an XMLRPC method, prefixing the XMLRPC method name with $namespace, if provided. Reflection is done on the callback's docblock to create the methodHelp for the XMLRPC method.
Additional arguments to pass to the function at dispatch may be passed; any arguments following the namespace will be aggregated and passed at dispatch time.
Name | Type | Description |
---|---|---|
$function | string|array | Valid callback |
$namespace | string | Optional namespace prefix |
Exception | Description |
---|---|
\Zend_XmlRpc_Server_Exception |

fault(
string|\Exception $fault
=
null, int $code
=
404
)
:
\Zend_XmlRpc_Server_Fault
Raise an xmlrpc server fault
Name | Type | Description |
---|---|---|
$fault | string|\Exception | |
$code | int |
Type | Description |
---|---|
\Zend_XmlRpc_Server_Fault |

getFunctions(
)
:
array
Returns a list of registered methods
Returns an array of dispatchables (Zend_Server_Reflection_Function, _Method, and _Class items).
Type | Description |
---|---|
array |

getRequest(
)
:
null|\Zend_XmlRpc_Request
Return currently registered request object
Type | Description |
---|---|
null|\Zend_XmlRpc_Request |

getSystem(
)
:
\Zend_XmlRpc_Server_System
Retrieve system object
Type | Description |
---|---|
\Zend_XmlRpc_Server_System |

handle(
\Zend_XmlRpc_Request $request
=
false
)
:
\Zend_XmlRpc_Response|\Zend_XmlRpc_Fault
Handle an xmlrpc call
Name | Type | Description |
---|---|---|
$request | \Zend_XmlRpc_Request | Optional |
Type | Description |
---|---|
\Zend_XmlRpc_Response|\Zend_XmlRpc_Fault |

loadFunctions(
array|\Zend_Server_Definition $definition
)
:
void
Load methods as returned from {@link getFunctions}
Typically, you will not use this method; it will be called using the results pulled from {@link Zend_XmlRpc_Server_Cache::get()}.
Name | Type | Description |
---|---|---|
$definition | array|\Zend_Server_Definition |
Exception | Description |
---|---|
\Zend_XmlRpc_Server_Exception | on invalid input |

sendArgumentsToAllMethods(
$flag
=
null
)
:
void
Send arguments to all methods?
If setClass() is used to add classes to the server, this flag defined how to handle arguments. If set to true, all methods including constructor will receive the arguments. If set to false, only constructor will receive the arguments
Name | Type | Description |
---|---|---|
$flag |

setClass(
string|object $class, string $namespace
=
'', mixed $argv
=
null
)
:
void
Attach class methods as XMLRPC method handlers
$class may be either a class name or an object. Reflection is done on the class or object to determine the available public methods, and each is attached to the server as an available method; if a $namespace has been provided, that namespace is used to prefix the XMLRPC method names.
Any additional arguments beyond $namespace will be passed to a method at invocation.
Name | Type | Description |
---|---|---|
$class | string|object | |
$namespace | string | Optional |
$argv | mixed | Optional arguments to pass to methods |
Exception | Description |
---|---|
\Zend_XmlRpc_Server_Exception | on invalid input |

setPersistence(
mixed $mode
)
:
void
Do nothing; persistence is handled via {@link Zend_XmlRpc_Server_Cache}
Name | Type | Description |
---|---|---|
$mode | mixed |

setRequest(
string|\Zend_XmlRpc_Request $request
)
:
\Zend_XmlRpc_Server
Set the request object
Name | Type | Description |
---|---|---|
$request | string|\Zend_XmlRpc_Request |
Type | Description |
---|---|
\Zend_XmlRpc_Server |
Exception | Description |
---|---|
\Zend_XmlRpc_Server_Exception | on invalid request class or object |