Class TXmlRpcProtocol

Description

TXmlRpcProtocol class

Implements the XML RPC protocol

Located in /Web/Services/TRpcService.php (line 416)

TRpcProtocol
   |
   --TXmlRpcProtocol
Method Summary
TXmlRpcProtocol __construct ()
void __destruct ()
void addMethod (string $methodName,  $methodDetails, array $handlerDetails)
string callMethod (string $requestPayload)
string createErrorResponse (TRpcException $exception)
array decode (string $data)
string encode (mixed $data)
Variables

Inherited Variables

Inherited from TRpcProtocol

TRpcProtocol::$rpcMethods
Methods
Constructor __construct (line 428)

Constructor

  • access: public
TXmlRpcProtocol __construct ()
Destructor __destruct (line 436)

Destructor

  • access: public
void __destruct ()
addMethod (line 448)

Registers a new RPC method and handler details

  • access: public
void addMethod (string $methodName,  $methodDetails, array $handlerDetails)
  • string $methodName
  • array $handlerDetails: containing the callback handler
  • $methodDetails

Redefinition of:
TRpcProtocol::addMethod()
Registers a new RPC method and handler details
callMethod (line 462)

Handles the RPC request

  • return: XML RPC response
  • access: public
string callMethod (string $requestPayload)
  • string $requestPayload

Redefinition of:
TRpcProtocol::callMethod()
createErrorResponse (line 487)

Turns the given exception into an XML RPC fault

  • return: XML RPC fault
  • access: public
string createErrorResponse (TRpcException $exception)

Redefinition of:
TRpcProtocol::createErrorResponse()
createResponseHeaders (line 499)

Sets the correct response headers

  • access: public
void createResponseHeaders (THttpResponse $response)

Redefinition of:
TRpcProtocol::createResponseHeaders()
decode (line 510)

Decodes XML encoded data into PHP data

  • return: PHP data
  • access: public
array decode (string $data)
  • string $data: in XML format

Redefinition of:
TRpcProtocol::decode()
encode (line 520)

Encodes PHP data into XML data

  • return: XML encoded PHP data
  • access: public
string encode (mixed $data)
  • mixed $data: PHP data

Redefinition of:
TRpcProtocol::encode()

Inherited Methods

Inherited From TRpcProtocol

TRpcProtocol::addMethod()
TRpcProtocol::callApiMethod()
TRpcProtocol::callMethod()
TRpcProtocol::createErrorResponse()
TRpcProtocol::createResponseHeaders()
TRpcProtocol::decode()
TRpcProtocol::encode()

Documentation generated on Mon, 25 Jun 2012 14:39:07 +0200 by phpDocumentor 1.4.3