Docs For Class RequestHandlerXMLRPC

Description

Implements interfaces:

Request handler for XMLRPC request.

Acts as a PrimaryRequestHandler with precedence of 2. Returns a path of "xmlrpc/<methodname>".

Allows unified request access, but though XMLRPC does not have named arguments you have to name them first.

Located in /phpsatk-lib/global/org.eenterphace.sat.request.xmlrpc/request.xmlrpc.php (line 39)

Method Summary

RequestHandlerXMLRPC __construct ()

string getApp ()

mixed getArg (string $name)

mixed getArgByIndex (int $index)

int getArgCount ()

string getMethod ()

void getOutputType ()

string getPath ()

string getType (string $name)

string getTypeByIndex (int $index)

boolean isUsable ()

void nameArg (int $index, string $name)

void registerRequestHandler ()

Methods

Constructor __construct (line 110)

Initializes a new XMLRPC request handler object

Parses the XMLRPC request using the functions provided by the 'xmlrpc' extension.

access: public

RequestHandlerXMLRPC __construct ()

getApp (line 254)

Gets the application to launch

access: public

string getApp ()

getArg (line 214)

Gets a named argument

access: public

mixed getArg (string $name)

string $name: Name of argument (set through nameArg())

getArgByIndex (line 196)

Gets the value of an argument

access: public

mixed getArgByIndex (int $index)

int $index: Argument index

getArgCount (line 147)

Gets the number of arguments provided

access: public

int getArgCount ()

getMethod (line 135)

Gets the method called

access: public

string getMethod ()

getOutputType (line 261)

Gets the output type for this kind of request - 'xmlrpc'

access: public

void getOutputType ()

getPath (line 245)

Gets the "virtual" path for this request for usage by the controller

Returns "xmlrpc/<methodname>"

access: public

string getPath ()

getType (line 180)

Gets the type of a specified named argument

access: public

string getType (string $name)

string $name: Name of argument (set through nameArg())

getTypeByIndex (line 158)

Gets the type of a argument

access: public
todo: Maybe some mapping needed

string getTypeByIndex (int $index)

int $index: Argument index

isUsable (line 74)

Checks whether the current request is an xmlrpc request.

Uses the definitions of the XMLRPC specification:

Request must be done using HTTP-POST
Request must have a Content-Type of "text/xml"
Request must have a valid Content-Length

Also checks whether the 'xmlrpc' extension is loaded.

access: public
static:

boolean isUsable ()

nameArg (line 234)

Names a argument

XMLRPC arguments are not named, so they are only distinguisable through their posititon. This is avoided by setting a name for each argument (mapping names to the indeces).

access: public

void nameArg (int $index, string $name)

int $index: Argument index
string $name: Argument name to map to

registerRequestHandler (line 99)

Registers the XMLRPC request data with the Request object

access: public
static:

void registerRequestHandler ()