[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/XmlRpc/ -> Server.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 615 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_XmlRpc_Server:: (21 methods):
  __construct()
  __call()
  addFunction()
  setClass()
  fault()
  handle()
  loadFunctions()
  setEncoding()
  getEncoding()
  setPersistence()
  setRequest()
  getRequest()
  setResponseClass()
  getResponseClass()
  getDispatchTable()
  getFunctions()
  getSystem()
  sendArgumentsToAllMethods()
  _fixType()
  _handle()
  _registerSystemMethods()


Class: Zend_XmlRpc_Server  - X-Ref

An XML-RPC server implementation

Example:
<code>
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;
</code>

__construct()   X-Ref
Constructor

Creates system.* methods.

return: void

__call($method, $params)   X-Ref
Proxy calls to system object

param: string $method
param: array $params
return: mixed

addFunction($function, $namespace = '')   X-Ref
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.

param: string|array $function Valid callback
param: string $namespace Optional namespace prefix
return: void

setClass($class, $namespace = '', $argv = null)   X-Ref
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.

param: string|object $class
param: string $namespace Optional
param: mixed $argv Optional arguments to pass to methods
return: void

fault($fault = null, $code = 404)   X-Ref
Raise an xmlrpc server fault

param: string|Exception $fault
param: int $code
return: Zend_XmlRpc_Server_Fault

handle($request = false)   X-Ref
Handle an xmlrpc call

param: Zend_XmlRpc_Request $request Optional
return: Zend_XmlRpc_Response|Zend_XmlRpc_Fault

loadFunctions($definition)   X-Ref
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()}.

param: array|Zend_Server_Definition $definition
return: void

setEncoding($encoding)   X-Ref
Set encoding

param: string $encoding
return: Zend_XmlRpc_Server

getEncoding()   X-Ref
Retrieve current encoding

return: string

setPersistence($mode)   X-Ref
Do nothing; persistence is handled via {@link Zend_XmlRpc_Server_Cache}

param: mixed $mode
return: void

setRequest($request)   X-Ref
Set the request object

param: string|Zend_XmlRpc_Request $request
return: Zend_XmlRpc_Server

getRequest()   X-Ref
Return currently registered request object

return: null|Zend_XmlRpc_Request

setResponseClass($class)   X-Ref
Set the class to use for the response

param: string $class
return: boolean True if class was set, false if not

getResponseClass()   X-Ref
Retrieve current response class

return: string

getDispatchTable()   X-Ref
Retrieve dispatch table

return: array

getFunctions()   X-Ref
Returns a list of registered methods

Returns an array of dispatchables (Zend_Server_Reflection_Function,
_Method, and _Class items).

return: array

getSystem()   X-Ref
Retrieve system object

return: Zend_XmlRpc_Server_System

sendArgumentsToAllMethods($flag = null)   X-Ref
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

_fixType($type)   X-Ref
Map PHP type to XML-RPC type

param: string $type
return: string

_handle(Zend_XmlRpc_Request $request)   X-Ref
Handle an xmlrpc call (actual work)

param: Zend_XmlRpc_Request $request
return: Zend_XmlRpc_Response

_registerSystemMethods()   X-Ref
Register system methods with the server

return: void



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1