Zend_XmlRpc_Request Class Reference

Inheritance diagram for Zend_XmlRpc_Request:

Public Member Functions
	__construct ($method=null, $params=null)
	setEncoding ($encoding)
	getEncoding ()
	setMethod ($method)
	getMethod ()
	addParam ($value, $type=null)
	setParams ()
	getParams ()
	getTypes ()
	loadXml ($request)
	isFault ()
	getFault ()
	saveXml ()
	__toString ()
Protected Member Functions
	_getXmlRpcParams ()
Protected Attributes
	$_encoding = 'UTF-8'
	$_method
	$_xml
	$_params = array()
	$_fault = null
	$_types = array()
	$_xmlRpcParams = array()

---

Detailed Description

Definition at line 48 of file Request.php.

---

Constructor & Destructor Documentation

__construct	(	$	method = null,
		$	params = null
	)

Create a new XML-RPC request

Parameters:

string	$method	(optional)
array	$params	(optional)

Definition at line 98 of file Request.php.

Here is the call graph for this function:

---

Member Function Documentation

__toString

(

)

Return XML request

Returns:

string

Definition at line 435 of file Request.php.

_getXmlRpcParams

(

)

[protected]

Retrieve method parameters as XMLRPC values

Returns:

array

Definition at line 382 of file Request.php.

Here is the call graph for this function:

Here is the caller graph for this function:

addParam	(	$	value,
		$	type = null
	)

Add a parameter to the parameter stack

Adds a parameter to the parameter stack, associating it with the type $type if provided

Parameters:

mixed	$value
string	$type	Optional; type hinting

Returns:

void

Definition at line 171 of file Request.php.

Here is the call graph for this function:

getEncoding

(

)

Retrieve current request encoding

Returns:

string

Definition at line 128 of file Request.php.

Here is the caller graph for this function:

getFault

(

)

Retrieve the fault response, if any

Returns:

null|Zend_XmlRpc_Fault

Definition at line 372 of file Request.php.

getMethod

(

)

Retrieve call method

Returns:

string

Definition at line 156 of file Request.php.

Here is the caller graph for this function:

getParams

(

)

Retrieve the array of parameters

Returns:

array

Definition at line 277 of file Request.php.

Here is the caller graph for this function:

getTypes

(

)

Return parameter types

Returns:

array

Definition at line 287 of file Request.php.

Here is the caller graph for this function:

isFault

(

)

Does the current request contain errors and should it return a fault response?

Returns:

boolean

Definition at line 362 of file Request.php.

loadXml

(

$

request

)

Load XML and parse into request components

Parameters:

string

$request

Returns:

boolean True on success, false if an error occurred.

Definition at line 298 of file Request.php.

Here is the call graph for this function:

Here is the caller graph for this function:

saveXml

(

)

Create XML request

Returns:

string

Definition at line 405 of file Request.php.

Here is the call graph for this function:

setEncoding

(

$

encoding

)

Set encoding to use in request

Parameters:

string

$encoding

Returns:

Zend_XmlRpc_Request

Definition at line 116 of file Request.php.

setMethod

(

$

method

)

Set method to call

Parameters:

string

$method

Returns:

boolean Returns true on success, false if method name is invalid

Definition at line 139 of file Request.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setParams

(

)

Set the parameters array

If called with a single, array value, that array is used to set the parameters stack. If called with multiple values or a single non-array value, the arguments are used to set the parameters stack.

Best is to call with array of the format, in order to allow type hinting when creating the XMLRPC values for each parameter: $array = array( array( 'value' => $value, 'type' => $type )[, ... ] );

public

Returns:

void

Definition at line 208 of file Request.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$_encoding = 'UTF-8' [protected]

Definition at line 54 of file Request.php.

$_fault = null [protected]

Definition at line 78 of file Request.php.

$_method [protected]

Definition at line 60 of file Request.php.

$_params = array() [protected]

Definition at line 72 of file Request.php.

$_types = array() [protected]

Definition at line 84 of file Request.php.

$_xml [protected]

Reimplemented in Zend_XmlRpc_Request_Http, and Zend_XmlRpc_Request_Stdin.

Definition at line 66 of file Request.php.

$_xmlRpcParams = array() [protected]

Definition at line 90 of file Request.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/XmlRpc/Request.php