Class: NS_XML_RPC_Service_Handler

Source Location: /handlers/NS_XML_RPC_Service_Handler.php

Class Overview

NS_Handler
   |
   --NS_Connection_Handler
      |
      --NS_HTTP_Service_Handler
         |
         --NS_XML_RPC_Service_Handler

XML-RPC Service handler class

Author(s):

Variables

$request_url

Methods

Child classes:

NS_Persistent_XML_RPC_Service_Handler: Persistent XML-RPC server class

NS_Direct_XML_RPC_Service_Handler: Direct XML-RPC server class

Inherited Constants

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::COMPRESS_AUTO
NS_HTTP_Service_Handler::COMPRESS_OFF
NS_HTTP_Service_Handler::DEFAULT_CONTENT_TYPE
NS_HTTP_Service_Handler::MAX_REQUEST_LENGTH
NS_HTTP_Service_Handler::SERVER_STRING

Class: NS_Connection_Handler

NS_Connection_Handler::FAIL_CONNREFUSED
NS_Connection_Handler::FAIL_CRYPTO
NS_Connection_Handler::FAIL_TIMEOUT

Inherited Variables

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::$compress
NS_HTTP_Service_Handler::$compress_level
NS_HTTP_Service_Handler::$request_content
NS_HTTP_Service_Handler::$request_headers
NS_HTTP_Service_Handler::$request_method
NS_HTTP_Service_Handler::$request_protocol

Class: NS_Handler

NS_Handler::$socket

Inherited Methods

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::__construct()
NS_HTTP_Service_Handler::Handle_Request()
NS_HTTP_Service_Handler::on_Read()

Class: NS_Connection_Handler

NS_Connection_Handler::Connect(): Connect
NS_Connection_Handler::Disconnect(): Disconnect
NS_Connection_Handler::on_Accept(): Event called on received connection
NS_Connection_Handler::on_Connect(): Event called on established connection
NS_Connection_Handler::on_Connect_Fail(): Event called on failed connection
NS_Connection_Handler::on_Disconnect(): Event called on disconnection
NS_Connection_Handler::on_Fork_Done(): Event called after forking, both on master and child processes
NS_Connection_Handler::on_Fork_Prepare(): Event called before forking
NS_Connection_Handler::on_Read(): Event called on data reception
NS_Connection_Handler::Write(): Send data over the connection
NS_Connection_Handler::Write_Stream(): Send open stream over the connection

Class: NS_Handler

NS_Handler::Set_Option(): Set a stream context option

Class Details

[line 39]
XML-RPC Service handler class

Tags:

abstract:

[ Top ]

Class Variables

$request_url = ""

[line 45]

Request URL

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

static method Variable_To_XML_String [line 53]

static string Variable_To_XML_String(
string
$var)

Convert a PHP variable to XML string representation

Tags:

access:

protected

Parameters:

string

$var

[ Top ]

static method XML_Add_Fault_Envelope [line 270]

static void XML_Add_Fault_Envelope(
Exception
$e)

Tags:

access:

protected

Parameters:

Exception

[ Top ]

static method XML_Add_MethodResponse_Envelope [line 264]

static string XML_Add_MethodResponse_Envelope(
string
$xml_result)

Add XMLRPC response envelope

Tags:

access:

protected

Parameters:

string

$xml_result

[ Top ]

static method XML_Params_To_Array [line 242]

static array XML_Params_To_Array(
SimpleXmlElement
$xml)

Convert XMLRPC method call params stored in a SimpleXmlElement object to a php array

Tags:

access:

protected

Parameters:

SimpleXmlElement

$xml

[ Top ]

static method XML_Struct_To_Array [line 192]

static array XML_Struct_To_Array(
SimpleXmlElement
$xml)

Convert a XMLRPC struct or array stored in a SimpleXmlElement object to php array

Tags:

access:

protected

Parameters:

SimpleXmlElement

$xml

[ Top ]

static method XML_Value_To_Variable [line 134]

static mixed XML_Value_To_Variable(
SimpleXmlElement
$xml)

Convert a XMLRPC value stored in a SimpleXmlElement object to php variable

Tags:

access:

protected

Parameters:

SimpleXmlElement

$xml

[ Top ]

method on_Call [line 329]

mixed on_Call(
string
$method, array
$args)

Event called on XML-RPC method call

The value returned by on_Call() will be sent back as the XMLRPC method call response

Tags:

abstract:
access:	public

Overridden in child classes as:

NS_Persistent_XML_RPC_Service_Handler::on_Call()

NS_Direct_XML_RPC_Service_Handler::on_Call()

Parameters:

string	$method
array	$args

[ Top ]

method on_Request [line 276]

void on_Request(

$url)

Tags:

access:

public

Parameters:

$url

[ Top ]

Documentation generated on Thu, 10 May 2012 22:01:25 +0200 by phpDocumentor 1.4.4