XmlRpc/Server.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_XmlRpc
- Subpackage
- Server
- Version
- $Id: Server.php 24593 2012-01-05 20:35:02Z matthew $
Package: Zend\XmlRpc\ServerAn 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;
- Parent(s)
- \Zend_Server_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
Properties



string $_responseClass = 'Zend_XmlRpc_Response_Http'
Class to use for responses; defaults to {@link Zend_XmlRpc_Response_Http}
Default value'Zend_XmlRpc_Response_Http'
Details- Type
- string



bool $_sendArgumentsToAllMethods = true
Send arguments to all methods or just constructor?
Default valuetrue
Details- Type
- bool



array $_typeMap = array('i4' => 'i4', 'int' => 'int', 'integer' => 'int', 'Zend_Crypt_Math_BigInteger' => 'i8', 'i8' => 'i8', 'ex:i8' => 'i8', 'double' => 'double', 'float' => 'double', 'real' => 'double', 'boolean' => 'boolean', 'bool' => 'boolean', 'true' => 'boolean', 'false' => 'boolean', 'string' => 'string', 'str' => 'string', 'base64' => 'base64', 'dateTime.iso8601' => 'dateTime.iso8601', 'date' => 'dateTime.iso8601', 'time' => 'dateTime.iso8601', 'time' => 'dateTime.iso8601', 'Zend_Date' => 'dateTime.iso8601', 'DateTime' => 'dateTime.iso8601', 'array' => 'array', 'struct' => 'struct', 'null' => 'nil', 'nil' => 'nil', 'ex:nil' => 'nil', 'void' => 'void', 'mixed' => 'struct')
PHP types => XML-RPC types
Default valuearray('i4' => 'i4', 'int' => 'int', 'integer' => 'int', 'Zend_Crypt_Math_BigInteger' => 'i8', 'i8' => 'i8', 'ex:i8' => 'i8', 'double' => 'double', 'float' => 'double', 'real' => 'double', 'boolean' => 'boolean', 'bool' => 'boolean', 'true' => 'boolean', 'false' => 'boolean', 'string' => 'string', 'str' => 'string', 'base64' => 'base64', 'dateTime.iso8601' => 'dateTime.iso8601', 'date' => 'dateTime.iso8601', 'time' => 'dateTime.iso8601', 'time' => 'dateTime.iso8601', 'Zend_Date' => 'dateTime.iso8601', 'DateTime' => 'dateTime.iso8601', 'array' => 'array', 'struct' => 'struct', 'null' => 'nil', 'nil' => 'nil', 'ex:nil' => 'nil', 'void' => 'void', 'mixed' => 'struct')
Details- Type
- array



array $magic_methods = array('__call', '__clone', '__construct', '__destruct', '__get', '__isset', '__set', '__set_state', '__sleep', '__tostring', '__unset', '__wakeup')
Default valuearray('__call', '__clone', '__construct', '__destruct', '__get', '__isset', '__set', '__set_state', '__sleep', '__tostring', '__unset', '__wakeup')
Details- Type
- array
- Inherited_from
- \Zend_Server_Abstract::$$magic_methods
Methods



__call(string $method, array $params) : mixed
Proxy calls to system object
ParametersName | Type | Description |
---|
$method | string | |
---|
$params | array | |
---|
ReturnsThrows 


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


_handle(\Zend_XmlRpc_Request $request) : \Zend_XmlRpc_Response
Handle an xmlrpc call (actual work)
ParametersReturnsThrowsException | 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.
ParametersName | Type | Description |
---|
$function | string | array | Valid callback |
---|
$namespace | string | Optional namespace prefix |
---|
Throws


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


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
Parameters


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.
ParametersName | Type | Description |
---|
$class | string | object | |
---|
$namespace | string | Optional |
---|
$argv | mixed | Optional arguments to pass to methods |
---|
Throws


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



setResponseClass(string $class) : boolean
Set the class to use for the response
ParametersName | Type | Description |
---|
$class | string | |
---|
ReturnsType | Description |
---|
boolean | True if class was set, false if not |