XmlRpc/Response.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
\Zend_XmlRpc_Response
Package: Zend_XmlRpc
Returns
XmlRpc Response
Container for accessing an XMLRPC return value and creating the XML response.
- Children
- \Zend_XmlRpc_Response_Http
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
string $_encoding = 'UTF-8'Response character encoding
Default value
'UTF-8'Details- Type
- string
null|\Zend_XmlRpc_Fault $_fault = nullFault, if response is a fault response
Default value
nullDetails- Type
- null | \Zend_XmlRpc_Fault
mixed $_returnReturn value
Details
- Type
- mixed
string $_typeReturn type
Details
- Type
- string
Methods
__construct(mixed $return = null, string $type = null) : voidConstructor
Can optionally pass in the return value and type hinting; otherwise, the
return value can be set via {@link setReturnValue()}.
Parameters| Name | Type | Description |
|---|---|---|
| $return | mixed | |
| $type | string |
__toString() : stringReturn XML response
Returns
| Type | Description |
|---|---|
| string |
_getXmlRpcReturn() : \Zend_XmlRpc_ValueRetrieve the XMLRPC value for the return value
Returns
| Type | Description |
|---|---|
| \Zend_XmlRpc_Value |
getEncoding() : stringRetrieve current response encoding
Returns
| Type | Description |
|---|---|
| string |
getFault() : null | \Zend_XmlRpc_FaultReturns the fault, if any.
Returns
| Type | Description |
|---|---|
| null | \Zend_XmlRpc_Fault |
getReturnValue() : mixedRetrieve the return value
Returns
| Type | Description |
|---|---|
| mixed |
isFault() : booleanIs the response a fault response?
Returns
| Type | Description |
|---|---|
| boolean |
loadXml(string $response) : booleanLoad a response from an XML response
Attempts to load a response from an XMLRPC response, autodetecting if it
is a fault response.
Parameters| Name | Type | Description |
|---|---|---|
| $response | string |
| Type | Description |
|---|---|
| boolean | True if a valid XMLRPC response, false if a fault response or invalid input |
saveXml() : stringReturn response as XML
Returns
| Type | Description |
|---|---|
| string |
setEncoding(string $encoding) : \Zend_XmlRpc_ResponseSet encoding to use in response
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Response |
setReturnValue(mixed $value, string $type = null) : voidSet the return value
Sets the return value, with optional type hinting if provided.
Parameters| Name | Type | Description |
|---|---|---|
| $value | mixed | |
| $type | string |