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


Classes:
XML_RPC_Base
XML_RPC_Client
XML_RPC_Dump
XML_RPC_Message
XML_RPC_Response
XML_RPC_Server
XML_RPC_Value
Files:
Dump.php
protoport.php
RPC.php
Server.php
test_Dump.php

File: RPC.php

Source Location: /XML_RPC-1.4.1/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

LICENSE: License is granted to use or modify this software ("XML-RPC for PHP") for commercial or non-commercial use provided the copyright of the author is preserved in any distributed or derivative work.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

Data types
Default value:   'array'


[ Top ]


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

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


[ Top ]


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

Data types
Default value:   'base64'


[ Top ]


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

Data types
Default value:   'boolean'


[ Top ]


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

Data types
Default value:   'dateTime.iso8601'


[ Top ]


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

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


[ Top ]


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

Data types
Default value:   'double'


[ Top ]


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

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 185]

User error codes start at 800
Default value:   800


[ Top ]


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

XML parse error codes start at 100
Default value:   100


[ Top ]


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

Data types
Default value:   'i4'


[ Top ]


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

Data types
Default value:   'int'


[ Top ]


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

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 102]

Data types
Default value:   'string'


[ Top ]


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

Data types
Default value:   'struct'


[ Top ]


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

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 205]

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 241]

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 62]

XML_RPC_ERROR_ALREADY_INITIALIZED = 104
The array or struct has already been started

Error constants


[ Top ]


XML_RPC_ERROR_CONNECTION_FAILED [line 58]

XML_RPC_ERROR_CONNECTION_FAILED = 103
Communication error

Error constants


[ Top ]


XML_RPC_ERROR_INCORRECT_PARAMS [line 66]

XML_RPC_ERROR_INCORRECT_PARAMS = 105
Incorrect parameters submitted

Error constants


[ Top ]


XML_RPC_ERROR_INVALID_TYPE [line 50]

XML_RPC_ERROR_INVALID_TYPE = 101
Parameter values don't match parameter types

Error constants


[ Top ]


XML_RPC_ERROR_NON_NUMERIC_FOUND [line 54]

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 70]

XML_RPC_ERROR_PROGRAMMING = 106
Programming error by developer

Error constants


[ Top ]


XML_RPC_cd [line 510]

void XML_RPC_cd( mixed $parser_resource, mixed $data)

Character data handler for the XML parser


[ Top ]


XML_RPC_decode [line 1838]

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 377]

void XML_RPC_ee( mixed $parser_resource, mixed $name)

End element handler for the XML parser


[ Top ]


XML_RPC_encode [line 1870]

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 1818]

int XML_RPC_iso8601_decode( mixed $idate, [mixed $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


[ Top ]


XML_RPC_iso8601_encode [line 1789]

string XML_RPC_iso8601_encode( mixed $timet, [mixed $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


[ Top ]


XML_RPC_se [line 249]

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

Start element handler for the XML parser


[ Top ]


Documentation generated on Wed, 07 Sep 2005 01:10:12 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.