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().
category | Zend |
---|---|
package | Zend_XmlRpc |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
version | $Id$ |
__construct(string $method= null
, array $params= null
)
string
(optional)
array
(optional)
__toString() : string
string
addParam(mixed $value, string $type = null
) : void
Adds a parameter to the parameter stack, associating it with the type $type if provided
mixed
string
Optional; type hinting
getEncoding() : string
string
getFault() : null | \Zend_XmlRpc_Fault
null
\Zend_XmlRpc_Fault
getMethod() : string
string
getParams() : array
array
getTypes() : array
array
isFault() : boolean
boolean
loadXml(string $request) : boolean
string
boolean
True on success, false if an error occurred.saveXml() : string
string
setEncoding(string $encoding) : \Zend_XmlRpc_Request
string
\Zend_XmlRpc_Request
setMethod(string $method) : boolean
string
boolean
Returns true on success, false if method name is invalidsetParams() : void
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
)[, ... ]
);
access | public |
---|
_getXmlRpcParams() : array
array
$_encoding : string
'UTF-8'
$_fault : \Zend_XmlRpc_Fault
null
$_method : string
$_params : array
array()
$_types : array
array()
$_xml : string
$_xmlRpcParams : array
array()