## Zend_XmlRpc_Request

Description

XmlRpc Request object

Encapsulates an XmlRpc request, holding the method call and all parameters. Provides accessors for these, as well as the ability to load from XML and to create the XML request string.

Additionally, if errors occur setting the method or parsing XML, a fault is generated and stored in $_fault; developers may check for it using isFault() and getFault().

- version: $Id: Request.php 2810 2007-01-16 01:40:21Z bkarwin $
- license: New BSD License
- copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/XmlRpc/Request.php (line 53)

Direct descendents

Class | Description
--- | ---
Zend_XmlRpc_Request_Http | XmlRpc Request object -- Request via HTTP
Zend_XmlRpc_Request_Stdin | XmlRpc Request object -- Request via STDIN

Variable Summary
string $_encoding
Zend_XmlRpc_Fault $_fault
string $_method
array $_params
string $_xml
Method Summary
Zend_XmlRpc_Request __construct ([string $method = null], [array $params = null])
void addParam (mixed $value, [string $type = null])
string getEncoding ()
null|Zend_XmlRpc_Fault getFault ()
string getMethod ()
array getParams ()
boolean isFault ()
boolean loadXml (string $request)
string saveXML ()
Zend_XmlRpc_Request setEncoding (string $encoding)
boolean setMethod (string $method)
void setParams ()
array _getXmlRpcParams ()
string __toString ()
Variables
string $_encoding = 'UTF-8' (line 59)

Request character encoding

- access: protected

Zend_XmlRpc_Fault $_fault = null (line 83)

Fault object, if any

- access: protected

string $_method (line 65)

Method to call

- access: protected

array $_params = array() (line 77)

Method parameters

- access: protected

string $_xml (line 71)

XML request

- access: protected

Redefined in descendants as:

- Zend_XmlRpc_Request_Http::$_xml : Raw XML as received via request
- Zend_XmlRpc_Request_Stdin::$_xml : Raw XML as received via request

Methods
Constructor __construct (line 92)

Create a new XML-RPC request

- access: public

Zend_XmlRpc_Request __construct ([string $method = null], [array $params = null])

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

Redefined in descendants as:

- Zend_XmlRpc_Request_Http::__construct() : Constructor
- Zend_XmlRpc_Request_Stdin::__construct() : Constructor

addParam (line 164)

Add a parameter to the parameter stack

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

- access: public

void addParam (mixed $value, [string $type = null])

- mixed $value
- string $type: Optional; type hinting

getEncoding (line 121)

Retrieve current request encoding

- access: public

string getEncoding ()
getFault (line 318)

Retrieve the fault response, if any

- access: public

null|Zend_XmlRpc_Fault getFault ()
getMethod (line 149)

Retrieve call method

- access: public

string getMethod ()
getParams (line 236)

Retrieve the array of parameters

- access: public

array getParams ()
isFault (line 308)

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

- access: public

boolean isFault ()
loadXml (line 247)

Load XML and parse into request components

- return: True on success, false if an error occurred.
- access: public

boolean loadXml (string $request)

- string $request

saveXML (line 346)

Create XML request

- access: public

string saveXML ()
setEncoding (line 110)

Set encoding to use in request

- access: public

Zend_XmlRpc_Request setEncoding (string $encoding)

- string $encoding

setMethod (line 132)

Set method to call

- return: Returns true on success, false if method name is invalid
- access: public

boolean setMethod (string $method)

- string $method

setParams (line 191)

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:

1. $array = array(
2. array(
3. 'value' => $value,
4. 'type' => $type
5. )[, ... ]
6. );

- access: public

void setParams ()
_getXmlRpcParams (line 328)

Retrieve method parameters as XMLRPC values

- access: protected

array _getXmlRpcParams ()
__toString (line 376)

Return XML request

- access: public

string __toString ()

Documentation generated on Wed, 21 Feb 2007 11:58:21 -0800 by phpDocumentor 1.3.1