A class that adds various capabilities to an existing XML-RPC server.
More...
|
|
| $server |
| | Original XML-RPC server.
|
| |
|
| $whitelist |
| | Whitelist of XML-RPC methods to announce.
|
| |
A class that adds various capabilities to an existing XML-RPC server.
- See also
- http://scripts.incutio.com/xmlrpc/introspection.html for documentation on introspection-related capabilities.
-
http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php for documentation on interoperability faults.
- Authors
- François Poirotte click.nosp@m.y@er.nosp@m.ebot..nosp@m.net
Definition at line 29 of file CapableServer.php.
| static fpoirotte\XRL\CapableServer::adaptType |
( |
|
$type | ) |
|
|
staticprotected |
Return XML-RPC type that comes the closest to some type used in documentation comments.
- Parameters
-
| string | $type | A type used in a documentation comment. |
- Return values
-
| string | The closest XML-RPC, or null if none could be derived. |
Definition at line 159 of file CapableServer.php.
| static fpoirotte\XRL\CapableServer::enable |
( |
\fpoirotte\XRL\Server |
$server, |
|
|
array |
$whitelist = null |
|
) |
| |
|
static |
| static fpoirotte\XRL\CapableServer::extractTypes |
( |
|
$doc | ) |
|
|
staticprotected |
Extract parameter and return type information from a documentation comment.
- Parameters
-
| string | $doc | Documentation comment the types will be extracted from. |
- Return values
-
| array | Array with type information. The "retval" key contains information about the return type, while the array in the "params" key contains information about each parameter's type (indexed by its name). |
Definition at line 92 of file CapableServer.php.
| fpoirotte\XRL\CapableServer::getCapabilities |
( |
| ) |
|
Get the server's capabilities.
- Return values
-
| array | Array of capabilities supported by this server. Each entry contains two keys:
- specURL (URL to that capability's specification)
- specVersion (version of the capability)
|
Definition at line 196 of file CapableServer.php.
| fpoirotte\XRL\CapableServer::listMethods |
( |
| ) |
|
List the methods supported by the server.
- Return values
-
| array | Array with the names of available methods. |
Definition at line 222 of file CapableServer.php.
| fpoirotte\XRL\CapableServer::methodHelp |
( |
|
$method | ) |
|
Get help about a procedure.
- Parameters
-
| string | $method | Name of the procedure. |
- Return values
-
| string | Human readable help message for the given procedure. |
Definition at line 284 of file CapableServer.php.
| fpoirotte\XRL\CapableServer::methodSignature |
( |
|
$method | ) |
|
Return possible signatures for a method.
- Parameters
-
| string | $method | Name of the method. |
- Return values
-
| array | An array containing:
- The return type of the method as its first value
- The types for the method's parameters in the following values
|
Definition at line 242 of file CapableServer.php.
| fpoirotte\XRL\CapableServer::multicall |
( |
array |
$requests | ) |
|
Perform several calls to XML-RPC methods in a single go.
- Parameters
-
| array | $requests | Array of requests, each described as a struct with the following information:
- "methodName": name of the method to call
- "params": array of parameters for the method
|
- Return values
-
| array | Array of responses, one for each request, in the same order. Each response may be either a fault or an array with a single element (the call's result). |
- Note
- Recursive calls to system.multicall are forbidden.
Definition at line 352 of file CapableServer.php.
The documentation for this class was generated from the following file:
1.8.11