XmlRpc/Request.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
\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 $_fault; developers may check for it using isFault() and getFault().
- Children
- \Zend_XmlRpc_Request_Http
- \Zend_XmlRpc_Request_Stdin
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Request.php 25033 2012-08-17 19:50:08Z matthew $
Properties
string $_encoding = 'UTF-8'Request character encoding
'UTF-8'Details- Type
- string
\Zend_XmlRpc_Fault $_fault = nullFault object, if any
nullDetails- Type
- \Zend_XmlRpc_Fault
string $_method = Method to call
- Type
- string
array $_params = array()Method parameters
array()Details- Type
- array
array $_types = array()XML-RPC type for each param
array()Details- Type
- array
string $_xml = XML request
- Type
- string
array $_xmlRpcParams = array()XML-RPC request params
array()Details- Type
- array
Methods
__construct(string $method = null, array $params = null) : voidCreate a new XML-RPC request
| Name | Type | Description |
|---|---|---|
| $method | string | (optional) |
| $params | array | (optional) |
__toString() : stringReturn XML request
| Type | Description |
|---|---|
| string |
_getXmlRpcParams() : arrayRetrieve method parameters as XMLRPC values
| Type | Description |
|---|---|
| array |
addParam(mixed $value, string $type = null) : voidAdd a parameter to the parameter stack
Adds a parameter to the parameter stack, associating it with the type $type if provided
| Name | Type | Description |
|---|---|---|
| $value | mixed | |
| $type | string | Optional; type hinting |
getEncoding() : stringRetrieve current request encoding
| Type | Description |
|---|---|
| string |
getFault() : null | \Zend_XmlRpc_FaultRetrieve the fault response, if any
| Type | Description |
|---|---|
| null | \Zend_XmlRpc_Fault |
getMethod() : stringRetrieve call method
| Type | Description |
|---|---|
| string |
getParams() : arrayRetrieve the array of parameters
| Type | Description |
|---|---|
| array |
getTypes() : arrayReturn parameter types
| Type | Description |
|---|---|
| array |
isFault() : booleanDoes the current request contain errors and should it return a fault response?
| Type | Description |
|---|---|
| boolean |
loadXml(string $request) : booleanLoad XML and parse into request components
| Name | Type | Description |
|---|---|---|
| $request | string |
| Type | Description |
|---|---|
| boolean | True on success, false if an error occurred. |
saveXml() : stringCreate XML request
| Type | Description |
|---|---|
| string |
setEncoding(string $encoding) : \Zend_XmlRpc_RequestSet encoding to use in request
| Name | Type | Description |
|---|---|---|
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Request |
setMethod(string $method) : booleanSet method to call
| Name | Type | Description |
|---|---|---|
| $method | string |
| Type | Description |
|---|---|
| boolean | Returns true on success, false if method name is invalid |
setParams() : voidSet 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
)[, ... ]
);
- Access
- public