Class: XML_RPC_Message

Source Location: /XML_RPC-1.4.8/RPC.php

Class Overview

XML_RPC_Base
   |
   --XML_RPC_Message

The methods and properties for composing XML RPC messages

Author(s):

Daniel Convissor <danielc at php.net>
Stig Bakken <stig at php.net>
Edd Dumbill <edd at usefulinc.com>
Martin Jansen <mj at php.net>

Version:

Release: 1.4.8

Copyright:

1999-2001 Edd Dumbill, 2001-2005 The PHP Group

Variables

Methods

Inherited Variables

Inherited Methods

Class: XML_RPC_Base

XML_RPC_Base::isError(): Tell whether something is a PEAR_Error object
XML_RPC_Base::raiseError(): PEAR Error handling

Class Details

[line 1114]
The methods and properties for composing XML RPC messages

Author: Daniel Convissor <danielc@php.net>
Author: Stig Bakken <stig@php.net>
Author: Edd Dumbill <edd@usefulinc.com>
Author: Martin Jansen <mj@php.net>
Version: Release: 1.4.8
Copyright: 1999-2001 Edd Dumbill, 2001-2005 The PHP Group
Link: http://pear.php.net/package/XML_RPC

[ Top ]

Class Variables

$debug = 0

[line 1120]

The current debug mode (1 = on, 0 = off)

Type:

integer

[ Top ]

$methodname = ''

[line 1137]

The method presently being evaluated

Type:

string

[ Top ]

$params = array()

[line 1142]

Type:

array

[ Top ]

$payload = ''

[line 1148]

The XML message being generated

Type:

string

[ Top ]

$remove_extra_lines = true

[line 1155]

Should extra line breaks be removed from the payload?

Since: Property available since Release 1.4.6

Type:

boolean

[ Top ]

$response_payload = ''

[line 1162]

The XML response from the remote server

Since: Property available since Release 1.4.6

Type:

string

[ Top ]

$send_encoding = ''

[line 1131]

The encoding to be used for outgoing messages

Defaults to the value of $GLOBALS['XML_RPC_defencoding']

See: XML_RPC_Message::setSendEncoding(), $GLOBALS['XML_RPC_defencoding'], XML_RPC_Message::xml_header()

Type:

string

[ Top ]

Method Detail

XML_RPC_Message (Constructor) [line 1168]

void XML_RPC_Message(

$meth, [
$pars = 0])

Parameters:

	`$meth`	—
	`$pars`	—

[ Top ]

addParam [line 1260]

void addParam(

$par)

Parameters:

$par —

[ Top ]

createPayload [line 1219]

void createPayload(
)

Fills the XML_RPC_Message::$payload property

Part of the process makes sure all line endings are in DOS format (CRLF), which is probably required by specifications.

Uses: XML_RPC_Message::xml_header(), - XML_RPC_Message::xml_footer()

[ Top ]

getEncoding [line 1326]

string getEncoding(
string
$data)

Determine the XML's encoding via the encoding attribute in the XML declaration

If the encoding parameter is not set or is not ISO-8859-1, UTF-8 or US-ASCII, $XML_RPC_defencoding will be returned.

Return: the encoding to be used
Link: http://php.net/xml_parser_create
Since: Method available since Release 1.2.0

Parameters:

string $data — the XML that will be parsed

[ Top ]

getNumParams [line 1292]

int getNumParams(
)

Return: the number of parameters

[ Top ]

getParam [line 1275]

object the getParam(
int
$i)

Obtains an XML_RPC_Value object for the given parameter

Return: XML_RPC_Value object. If the parameter doesn't exist, an XML_RPC_Response object.
Since: Returns XML_RPC_Response object on error since Release 1.3.0

Parameters:

int $i — the index number of the parameter to obtain

[ Top ]

method [line 1240]

string method(
[
$meth = ''])

Return: the name of the method

Parameters:

$meth —

[ Top ]

parseResponse [line 1364]

object a parseResponse(
[
$data = ''])

Return: new XML_RPC_Response object

Parameters:

$data —

[ Top ]

parseResponseFile [line 1352]

object a parseResponseFile(

$fp)

Return: new XML_RPC_Response object

Parameters:

$fp —

[ Top ]

serialize [line 1251]

string serialize(
)

Return: the payload

[ Top ]

setSendEncoding [line 1307]

void setSendEncoding(
string
$type)

Sets the XML declaration's encoding attribute

See: XML_RPC_Message::$send_encoding, XML_RPC_Message::xml_header()
Since: Method available since Release 1.2.0

Parameters:

string $type — the encoding type (ISO-8859-1, UTF-8 or US-ASCII)

[ Top ]

xml_footer [line 1204]

string xml_footer(
)

Return: the closing </methodCall> tag

[ Top ]

xml_header [line 1190]

string xml_header(
)

Produces the XML declaration including the encoding attribute

The encoding is determined by this class' $send_encoding property. If the $send_encoding property is not set, use $GLOBALS['XML_RPC_defencoding'].

Return: the XML declaration and <methodCall> element
See: XML_RPC_Message::setSendEncoding(), XML_RPC_Message::$send_encoding, $GLOBALS['XML_RPC_defencoding']

[ Top ]