Skip to content

CI_Xmlrpcs

Jump to bottom
Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

CI_Xmlrpcs

XML-RPC server class

  • Class name: CI_Xmlrpcs
  • Namespace:
  • Parent class: CI_Xmlrpc

Properties

$methods

public array $methods = array()

Array of methods mapped to function names and signatures

  • Visibility: public

$debug_msg

public string $debug_msg = ''

Debug Message

  • Visibility: public

$system_methods

public array $system_methods = array()

XML RPC Server methods

  • Visibility: public

$object

public object $object = FALSE

Configuration object

  • Visibility: public

$debug

public boolean $debug = FALSE

Debug flag

  • Visibility: public

$xmlrpcI4

public string $xmlrpcI4 = 'i4'

I4 data type

  • Visibility: public

$xmlrpcInt

public string $xmlrpcInt = 'int'

Integer data type

  • Visibility: public

$xmlrpcBoolean

public string $xmlrpcBoolean = 'boolean'

Boolean data type

  • Visibility: public

$xmlrpcDouble

public string $xmlrpcDouble = 'double'

Double data type

  • Visibility: public

$xmlrpcString

public string $xmlrpcString = 'string'

String data type

  • Visibility: public

$xmlrpcDateTime

public string $xmlrpcDateTime = 'dateTime.iso8601'

DateTime format

  • Visibility: public

$xmlrpcBase64

public string $xmlrpcBase64 = 'base64'

Base64 data type

  • Visibility: public

$xmlrpcArray

public string $xmlrpcArray = 'array'

Array data type

  • Visibility: public

$xmlrpcStruct

public string $xmlrpcStruct = 'struct'

Struct data type

  • Visibility: public

$xmlrpcTypes

public array $xmlrpcTypes = array()

Data types list

  • Visibility: public

$valid_parents

public array $valid_parents = array()

Valid parents list

  • Visibility: public

$xmlrpcerr

public array $xmlrpcerr = array()

Response error numbers list

  • Visibility: public

$xmlrpcstr

public array<mixed,string> $xmlrpcstr = array()

Response error messages list

  • Visibility: public

$xmlrpc_defencoding

public string $xmlrpc_defencoding = 'UTF-8'

Encoding charset

  • Visibility: public

$xmlrpcName

public string $xmlrpcName = 'XML-RPC for CodeIgniter'

XML-RPC client name

  • Visibility: public

$xmlrpcVersion

public string $xmlrpcVersion = '1.1'

XML-RPC version

  • Visibility: public

$xmlrpcerruser

public integer $xmlrpcerruser = 800

Start of user errors

  • Visibility: public

$xmlrpcerrxml

public integer $xmlrpcerrxml = 100

Start of XML parse errors

  • Visibility: public

$xmlrpc_backslash

public string $xmlrpc_backslash = ''

Backslash replacement value

  • Visibility: public

$client

public object $client

XML-RPC Client object

  • Visibility: public

$method

public string $method

XML-RPC Method name

  • Visibility: public

$data

public array $data

XML-RPC Data

  • Visibility: public

$message

public string $message = ''

XML-RPC Message

  • Visibility: public

$error

public string $error = ''

Request error message

  • Visibility: public

$result

public object $result

XML-RPC result object

  • Visibility: public

$response

public array $response = array()

XML-RPC Reponse

  • Visibility: public

$xss_clean

public boolean $xss_clean = TRUE

XSS Filter flag

  • Visibility: public

Methods

__construct

void CI_Xmlrpc::__construct(array $config)

Constructor

Initializes property default values

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $config array

initialize

void CI_Xmlrpc::initialize(array $config)

Initialize

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $config array

set_system_methods

void CI_Xmlrpcs::set_system_methods()

Setting of System Methods

  • Visibility: public

serve

void CI_Xmlrpcs::serve()

Main Server Function

  • Visibility: public

add_to_map

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

Add Method to Class

  • Visibility: public

Arguments

  • $methodname mixed
  • $function mixed
  • $sig mixed
  • $doc mixed

parseRequest

object CI_Xmlrpcs::parseRequest($data)

Parse Server Request

  • Visibility: public

Arguments

  • $data mixed

_execute

mixed CI_Xmlrpcs::_execute($m)

Executes the Method

  • Visibility: protected

Arguments

  • $m mixed

listMethods

object CI_Xmlrpcs::listMethods($m)

Server Function: List Methods

  • Visibility: public

Arguments

  • $m mixed

methodSignature

object CI_Xmlrpcs::methodSignature($m)

Server Function: Return Signature for Method

  • Visibility: public

Arguments

  • $m mixed

methodHelp

object CI_Xmlrpcs::methodHelp($m)

Server Function: Doc String for Method

  • Visibility: public

Arguments

  • $m mixed

multicall

object CI_Xmlrpcs::multicall($m)

Server Function: Multi-call

  • Visibility: public

Arguments

  • $m mixed

multicall_error

object CI_Xmlrpcs::multicall_error($err)

Multi-call Function: Error Handling

  • Visibility: public

Arguments

  • $err mixed

do_multicall

object CI_Xmlrpcs::do_multicall($call)

Multi-call Function: Processes method

  • Visibility: public

Arguments

  • $call mixed

server

void CI_Xmlrpc::server(string $url, integer $port, string $proxy, integer $proxy_port)

Parse server URL

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

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

timeout

void CI_Xmlrpc::timeout(integer $seconds)

Set Timeout

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $seconds integer

method

void CI_Xmlrpc::method(string $function)

Set Methods

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $function string - <p>Method name</p>

request

void CI_Xmlrpc::request(array $incoming)

Take Array of Data and Create Objects

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $incoming array

set_debug

void CI_Xmlrpc::set_debug(boolean $flag)

Set Debug

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $flag boolean

values_parsing

object CI_Xmlrpc::values_parsing(mixed $value)

Values Parsing

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $value mixed

send_request

boolean CI_Xmlrpc::send_request()

Sends XML-RPC Request

  • Visibility: public
  • This method is defined by CI_Xmlrpc

display_error

string CI_Xmlrpc::display_error()

Returns Error

  • Visibility: public
  • This method is defined by CI_Xmlrpc

display_response

string CI_Xmlrpc::display_response()

Returns Remote Server Response

  • Visibility: public
  • This method is defined by CI_Xmlrpc

send_error_message

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

Sends an Error Message for Server Request

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $number integer
  • $message string

send_response

object CI_Xmlrpc::send_response(array $response)

Send Response for Server Request

  • Visibility: public
  • This method is defined by CI_Xmlrpc

Arguments

  • $response array
Clone this wiki locally