XmlRpc/Response.php

Show: PublicProtectedPrivateinherited
Table of Contents
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
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

>VPropertyprotectedstring $_encoding = 'UTF-8'
Response character encoding
Default value'UTF-8'Details
Type
string
>VPropertyprotectednull|\Zend_XmlRpc_Fault $_fault = null
Fault, if response is a fault response
Default valuenullDetails
Type
null | \Zend_XmlRpc_Fault
>VPropertyprotectedmixed $_return
Return value
Details
Type
mixed
>VPropertyprotectedstring $_type
Return type
Details
Type
string

Methods

methodpublic__construct(mixed $return = null, string $type = null) : void

Constructor

Can optionally pass in the return value and type hinting; otherwise, the return value can be set via {@link setReturnValue()}.
Parameters
NameTypeDescription
$returnmixed
$typestring
methodpublic__toString() : string

Return XML response

Returns
TypeDescription
string
methodprotected_getXmlRpcReturn() : \Zend_XmlRpc_Value

Retrieve the XMLRPC value for the return value

Returns
TypeDescription
\Zend_XmlRpc_Value
methodpublicgetEncoding() : string

Retrieve current response encoding

Returns
TypeDescription
string
methodpublicgetFault() : null | \Zend_XmlRpc_Fault

Returns the fault, if any.

Returns
TypeDescription
null | \Zend_XmlRpc_Fault
methodpublicgetReturnValue() : mixed

Retrieve the return value

Returns
TypeDescription
mixed
methodpublicisFault() : boolean

Is the response a fault response?

Returns
TypeDescription
boolean
methodpublicloadXml(string $response) : boolean

Load a response from an XML response

Attempts to load a response from an XMLRPC response, autodetecting if it is a fault response.
Parameters
NameTypeDescription
$responsestring
Returns
TypeDescription
booleanTrue if a valid XMLRPC response, false if a fault response or invalid input
methodpublicsaveXml() : string

Return response as XML

Returns
TypeDescription
string
methodpublicsetEncoding(string $encoding) : \Zend_XmlRpc_Response

Set encoding to use in response

Parameters
NameTypeDescription
$encodingstring
Returns
TypeDescription
\Zend_XmlRpc_Response
methodpublicsetReturnValue(mixed $value, string $type = null) : void

Set the return value

Sets the return value, with optional type hinting if provided.
Parameters
NameTypeDescription
$valuemixed
$typestring
Documentation was generated by phpDocumentor 2.2.0 .