CodeIgniter v3.0.0 API
\

\CI_Xmlrpcs

XML-RPC server class

Summary

Methods
Properties
Constants
__construct()
initialize()
server()
timeout()
method()
request()
set_debug()
values_parsing()
send_request()
display_error()
display_response()
send_error_message()
send_response()
set_system_methods()
serve()
add_to_map()
parseRequest()
listMethods()
methodSignature()
methodHelp()
multicall()
multicall_error()
do_multicall()
$debug
$xmlrpcI4
$xmlrpcInt
$xmlrpcBoolean
$xmlrpcDouble
$xmlrpcString
$xmlrpcDateTime
$xmlrpcBase64
$xmlrpcArray
$xmlrpcStruct
$xmlrpcTypes
$valid_parents
$xmlrpcerr
$xmlrpcstr
$xmlrpc_defencoding
$xmlrpcName
$xmlrpcVersion
$xmlrpcerruser
$xmlrpcerrxml
$xmlrpc_backslash
$client
$method
$data
$message
$error
$result
$response
$xss_clean
$methods
$debug_msg
$system_methods
$object
No constants found
_execute()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$debug

$debug : boolean

Debug flag

Type

boolean

$xmlrpcI4

$xmlrpcI4 : string

I4 data type

Type

string

$xmlrpcInt

$xmlrpcInt : string

Integer data type

Type

string

$xmlrpcBoolean

$xmlrpcBoolean : string

Boolean data type

Type

string

$xmlrpcDouble

$xmlrpcDouble : string

Double data type

Type

string

$xmlrpcString

$xmlrpcString : string

String data type

Type

string

$xmlrpcDateTime

$xmlrpcDateTime : string

DateTime format

Type

string

$xmlrpcBase64

$xmlrpcBase64 : string

Base64 data type

Type

string

$xmlrpcArray

$xmlrpcArray : string

Array data type

Type

string

$xmlrpcStruct

$xmlrpcStruct : string

Struct data type

Type

string

$xmlrpcTypes

$xmlrpcTypes : array

Data types list

Type

array

$valid_parents

$valid_parents : array

Valid parents list

Type

array

$xmlrpcerr

$xmlrpcerr : array

Response error numbers list

Type

array

$xmlrpcstr

$xmlrpcstr : array<mixed,string>

Response error messages list

Type

array<mixed,string>

$xmlrpc_defencoding

$xmlrpc_defencoding : string

Encoding charset

Type

string

$xmlrpcName

$xmlrpcName : string

XML-RPC client name

Type

string

$xmlrpcVersion

$xmlrpcVersion : string

XML-RPC version

Type

string

$xmlrpcerruser

$xmlrpcerruser : integer

Start of user errors

Type

integer

$xmlrpcerrxml

$xmlrpcerrxml : integer

Start of XML parse errors

Type

integer

$xmlrpc_backslash

$xmlrpc_backslash : string

Backslash replacement value

Type

string

$client

$client : object

XML-RPC Client object

Type

object

$method

$method : string

XML-RPC Method name

Type

string

$data

$data : array

XML-RPC Data

Type

array

$message

$message : string

XML-RPC Message

Type

string

$error

$error : string

Request error message

Type

string

$result

$result : object

XML-RPC result object

Type

object

$response

$response : array

XML-RPC Response

Type

array

$xss_clean

$xss_clean : boolean

XSS Filter flag

Type

boolean

$methods

$methods : array

Array of methods mapped to function names and signatures

Type

array

$debug_msg

$debug_msg : string

Debug Message

Type

string

$system_methods

$system_methods : array

XML RPC Server methods

Type

array

$object

$object : object

Configuration object

Type

object

Methods

__construct()

__construct(array  $config = array()) : void

Initialize XMLRPC class

Initializes property default values

Parameters

array $config

initialize()

initialize(array  $config = array()) : void

Initialize Prefs and Serve

Parameters

array $config

server()

server(string  $url, integer  $port = 80, string  $proxy = FALSE, integer  $proxy_port = 8080) : void

Parse server URL

Parameters

string $url
integer $port
string $proxy
integer $proxy_port

timeout()

timeout(integer  $seconds = 5) : void

Set Timeout

Parameters

integer $seconds

method()

method(string  $function) : void

Set Methods

Parameters

string $function

Method name

request()

request(array  $incoming) : void

Take Array of Data and Create Objects

Parameters

array $incoming

set_debug()

set_debug(boolean  $flag = TRUE) : void

Set Debug

Parameters

boolean $flag

values_parsing()

values_parsing(mixed  $value) : object

Values Parsing

Parameters

mixed $value

Returns

object

send_request()

send_request() : boolean

Sends XML-RPC Request

Returns

boolean

display_error()

display_error() : string

Returns Error

Returns

string

display_response()

display_response() : string

Returns Remote Server Response

Returns

string

send_error_message()

send_error_message(integer  $number, string  $message) : object

Sends an Error Message for Server Request

Parameters

integer $number
string $message

Returns

object

send_response()

send_response(array  $response) : object

Send Response for Server Request

Parameters

array $response

Returns

object

set_system_methods()

set_system_methods() : void

Setting of System Methods

serve()

serve() : void

Main Server Function

add_to_map()

add_to_map(  $methodname,   $function,   $sig,   $doc) : void

Add Method to Class

Parameters

$methodname
$function
$sig
$doc

parseRequest()

parseRequest(  $data = '') : object

Parse Server Request

Parameters

$data

Returns

object —

xmlrpc response

listMethods()

listMethods(  $m) : object

Server Function: List Methods

Parameters

$m

Returns

object

methodSignature()

methodSignature(  $m) : object

Server Function: Return Signature for Method

Parameters

$m

Returns

object

methodHelp()

methodHelp(  $m) : object

Server Function: Doc String for Method

Parameters

$m

Returns

object

multicall()

multicall(  $m) : object

Server Function: Multi-call

Parameters

$m

Returns

object

multicall_error()

multicall_error(  $err) : object

Multi-call Function: Error Handling

Parameters

$err

Returns

object

do_multicall()

do_multicall(  $call) : object

Multi-call Function: Processes method

Parameters

$call

Returns

object

_execute()

_execute(  $m) : mixed

Executes the Method

Parameters

$m

Returns

mixed