XML_RPC
[ class tree: XML_RPC ] [ index: XML_RPC ] [ all elements ]

File: RPC.php

Source Location: /XML_RPC-1.5.5/XML/RPC.php

Classes:

XML_RPC_Base
The common methods and properties for all of the XML_RPC classes
XML_RPC_Client
The methods and properties for submitting XML RPC requests
XML_RPC_Response
The methods and properties for interpreting responses to XML RPC requests
XML_RPC_Message
The methods and properties for composing XML RPC messages
XML_RPC_Value
The methods and properties that represent data in XML RPC format

Page Details:

PHP implementation of the XML-RPC protocol

This is a PEAR-ified version of Useful inc's XML-RPC for PHP. It has support for HTTP transport, proxies and authentication.

PHP versions 4 and 5

Includes:

include_once('PEAR.php') [line 27]

string $GLOBALS['XML_RPC_Array'] [line 107]

Data types
Default value:   'array'


[ Top ]



boolean $GLOBALS['XML_RPC_auto_base64'] [line 193]

Should we automatically base64 encode strings that contain characters

which can cause PHP's SAX-based XML parser to break?

Default value:   false


[ Top ]



string $GLOBALS['XML_RPC_backslash'] [line 185]

Compose backslashes for escaping regexp
Default value:   chr(92) . chr(92)


[ Top ]



string $GLOBALS['XML_RPC_Base64'] [line 101]

Data types
Default value:   'base64'


[ Top ]



string $GLOBALS['XML_RPC_Boolean'] [line 77]

Data types
Default value:   'boolean'


[ Top ]



string $GLOBALS['XML_RPC_DateTime'] [line 95]

Data types
Default value:   'dateTime.iso8601'


[ Top ]



string $GLOBALS['XML_RPC_defencoding'] [line 166]

Default XML encoding (ISO-8859-1, UTF-8 or US-ASCII)
Default value:   'UTF-8'


[ Top ]



string $GLOBALS['XML_RPC_Double'] [line 83]

Data types
Default value:   'double'


[ Top ]



array $GLOBALS['XML_RPC_err'] [line 137]

Error message numbers
Default value:   array(
    'unknown_method'      => 1,
    'invalid_return'      => 2,
    'incorrect_params'    => 3,
    'introspect_unknown'  => 4,
    'http_error'          => 5,
    'not_response_object' => 6,
    'invalid_request'     => 7,
)


[ Top ]



int $GLOBALS['XML_RPC_erruser'] [line 172]

User error codes start at 800
Default value:   800


[ Top ]



int $GLOBALS['XML_RPC_errxml'] [line 178]

XML parse error codes start at 100
Default value:   100


[ Top ]



string $GLOBALS['XML_RPC_I4'] [line 65]

Data types
Default value:   'i4'


[ Top ]



string $GLOBALS['XML_RPC_Int'] [line 71]

Data types
Default value:   'int'


[ Top ]



array $GLOBALS['XML_RPC_str'] [line 151]

Error message strings
Default value:   array(
    'unknown_method'      => 'Unknown method',
    'invalid_return'      => 'Invalid return payload: enable debugging to examine incoming payload',
    'incorrect_params'    => 'Incorrect parameters passed to method',
    'introspect_unknown'  => 'Can\'t introspect: method unknown',
    'http_error'          => 'Didn\'t receive 200 OK from remote server.',
    'not_response_object' => 'The requested method didn\'t return an XML_RPC_Response object.',
    'invalid_request'     => 'Invalid request payload',
)


[ Top ]



string $GLOBALS['XML_RPC_String'] [line 89]

Data types
Default value:   'string'


[ Top ]



string $GLOBALS['XML_RPC_Struct'] [line 113]

Data types
Default value:   'struct'


[ Top ]



array $GLOBALS['XML_RPC_Types'] [line 120]

Data type meta-types
Default value:   array(
    $GLOBALS['XML_RPC_I4']       => 1,
    $GLOBALS['XML_RPC_Int']      => 1,
    $GLOBALS['XML_RPC_Boolean']  => 1,
    $GLOBALS['XML_RPC_String']   => 1,
    $GLOBALS['XML_RPC_Double']   => 1,
    $GLOBALS['XML_RPC_DateTime'] => 1,
    $GLOBALS['XML_RPC_Base64']   => 1,
    $GLOBALS['XML_RPC_Array']    => 2,
    $GLOBALS['XML_RPC_Struct']   => 3,
)


[ Top ]



array $GLOBALS['XML_RPC_valid_parents'] [line 200]

Valid parents of XML elements
Default value:   array(
    'BOOLEAN' => array('VALUE'),'I4'=>array('VALUE'),'INT'=>array('VALUE'),'STRING'=>array('VALUE'),'DOUBLE'=>array('VALUE'),'DATETIME.ISO8601'=>array('VALUE'),'BASE64'=>array('VALUE'),'ARRAY'=>array('VALUE'),'STRUCT'=>array('VALUE'),'PARAM'=>array('PARAMS'),'METHODNAME'=>array('METHODCALL'),'PARAMS'=>array('METHODCALL','METHODRESPONSE'),'MEMBER'=>array('STRUCT'),'NAME'=>array('MEMBER'),'DATA'=>array('ARRAY'),'FAULT'=>array('METHODRESPONSE'),'VALUE'=>array('MEMBER','DATA','PARAM','FAULT'),)


[ Top ]



array $GLOBALS['XML_RPC_xh'] [line 236]

Stores state during parsing

quick explanation of components:

  • ac = accumulates values
  • qt = decides if quotes are needed for evaluation
  • cm = denotes struct or array (comma needed)
  • isf = indicates a fault
  • lv = indicates "looking for a value": implements the logic to allow values with no types to be strings
  • params = stores parameters in method calls
  • method = stores method name

Default value:   array()


[ Top ]



XML_RPC_ERROR_ALREADY_INITIALIZED [line 49]

XML_RPC_ERROR_ALREADY_INITIALIZED = 104
The array or struct has already been started

Error constants


[ Top ]



XML_RPC_ERROR_CONNECTION_FAILED [line 45]

XML_RPC_ERROR_CONNECTION_FAILED = 103
Communication error

Error constants


[ Top ]



XML_RPC_ERROR_INCORRECT_PARAMS [line 53]

XML_RPC_ERROR_INCORRECT_PARAMS = 105
Incorrect parameters submitted

Error constants


[ Top ]



XML_RPC_ERROR_INVALID_TYPE [line 37]

XML_RPC_ERROR_INVALID_TYPE = 101
Parameter values don't match parameter types

Error constants


[ Top ]



XML_RPC_ERROR_NON_NUMERIC_FOUND [line 41]

XML_RPC_ERROR_NON_NUMERIC_FOUND = 102
Parameter declared to be numeric but the values are not

Error constants


[ Top ]



XML_RPC_ERROR_PROGRAMMING [line 57]

XML_RPC_ERROR_PROGRAMMING = 106
Programming error by developer

Error constants


[ Top ]



XML_RPC_cd [line 510]

void XML_RPC_cd( $parser_resource, $data)

Character data handler for the XML parser


Parameters

   $parser_resource  
   $data  
[ Top ]



XML_RPC_decode [line 1946]

mixed XML_RPC_decode( object $XML_RPC_val)

Converts an XML_RPC_Value object into native PHP types
  • Return: the PHP values


Parameters

object   $XML_RPC_val   the XML_RPC_Value object to decode
[ Top ]



XML_RPC_ee [line 373]

void XML_RPC_ee( $parser_resource, $name)

End element handler for the XML parser


Parameters

   $parser_resource  
   $name  
[ Top ]



XML_RPC_encode [line 1978]

object the XML_RPC_encode( mixed $php_val)

Converts native PHP types into an XML_RPC_Value object
  • Return: XML_RPC_Value object


Parameters

mixed   $php_val   the PHP value or variable you want encoded
[ Top ]



XML_RPC_iso8601_decode [line 1926]

int XML_RPC_iso8601_decode( $idate, [ $utc = 0])

Convert a datetime string into a Unix timestamp

While timezones ought to be supported, the XML-RPC spec says:

"Don't assume a timezone. It should be specified by the server in its documentation what assumptions it makes about timezones."

This routine always assumes localtime unless $utc is set to 1, in which case UTC is assumed and an adjustment for locale is made when encoding.

  • Return: the unix timestamp of the date submitted


Parameters

   $idate  
   $utc  
[ Top ]



XML_RPC_iso8601_encode [line 1897]

string XML_RPC_iso8601_encode( $timet, [ $utc = 0])

Return an ISO8601 encoded string

While timezones ought to be supported, the XML-RPC spec says:

"Don't assume a timezone. It should be specified by the server in its documentation what assumptions it makes about timezones."

This routine always assumes localtime unless $utc is set to 1, in which case UTC is assumed and an adjustment for locale is made when encoding.

  • Return: the formatted date


Parameters

   $timet  
   $utc  
[ Top ]



XML_RPC_se [line 244]

void XML_RPC_se( $parser_resource, $name, $attrs)

Start element handler for the XML parser


Parameters

   $parser_resource  
   $name  
   $attrs  
[ Top ]



Documentation generated on Sat, 27 Aug 2011 03:00:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.