Class Zend_XmlRpc_Request

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 Zend_XmlRpc_Request::$_fault; developers may check for it using Zend_XmlRpc_Request::isFault() and Zend_XmlRpc_Request::getFault().

Package: Zend\XmlRpc
Category: Zend
Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Request.php 20208 2010-01-11 22:37:37Z lars $
Located at code/core/Zend/XmlRpc/Request.php

Methods summary
`public`	# `__construct( string $method = null, array $params = null )` Create a new XML-RPC request Create a new XML-RPC request Parameters `$method` `string` $method (optional) `$params` `array` $params (optional)
`public Zend_XmlRpc_Request`	# `setEncoding( string $encoding )` Set encoding to use in request Set encoding to use in request Parameters `$encoding` `string` $encoding Returns `Zend_XmlRpc_Request`
`public string`	# `getEncoding( )` Retrieve current request encoding Retrieve current request encoding Returns `string`
`public boolean`	# `setMethod( string $method )` Set method to call Set method to call Parameters `$method` `string` $method Returns `boolean` Returns true on success, false if method name is invalid
`public string`	# `getMethod( )` Retrieve call method Retrieve call method Returns `string`
`public`	# `addParam( mixed $value, string $type = null )` Add a parameter to the parameter stack Add a parameter to the parameter stack Adds a parameter to the parameter stack, associating it with the type $type if provided Parameters `$value` `mixed` $value `$type` `string` $type Optional; type hinting
`public`	# `setParams( )` Set the parameters array 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 array`	# `getParams( )` Retrieve the array of parameters Retrieve the array of parameters Returns `array`
`public array`	# `getTypes( )` Return parameter types Return parameter types Returns `array`
`public boolean`	# `loadXml( string $request )` Load XML and parse into request components Load XML and parse into request components Parameters `$request` `string` $request Returns `boolean` True on success, false if an error occurred.
`public boolean`	# `isFault( )` Does the current request contain errors and should it return a fault response? Does the current request contain errors and should it return a fault response? Returns `boolean`
`public null\|Zend_XmlRpc_Fault`	# `getFault( )` Retrieve the fault response, if any Retrieve the fault response, if any Returns `null\|Zend_XmlRpc_Fault`
`protected array`	# `_getXmlRpcParams( )` Retrieve method parameters as XMLRPC values Retrieve method parameters as XMLRPC values Returns `array`
`public string`	# `saveXml( )` Create XML request Create XML request Returns `string`
`public string`	# `__toString( )` Return XML request Return XML request Returns `string`

Properties summary
`protected string`	`$_encoding`	`'UTF-8'`	# Request character encoding Request character encoding
`protected string`	`$_method`		# Method to call Method to call
`protected string`	`$_xml`		# XML request XML request
`protected array`	`$_params`	`array()`	# Method parameters Method parameters
`protected Zend_XmlRpc_Fault`	`$_fault`	`null`	# Fault object, if any Fault object, if any
`protected array`	`$_types`	`array()`	# XML-RPC type for each param XML-RPC type for each param
`protected array`	`$_xmlRpcParams`	`array()`	# XML-RPC request params XML-RPC request params

Packages

Classes

Class Zend_XmlRpc_Request

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns