XmlRpc/Response/Http.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  

\Zend_XmlRpc_Response_Http

Package: Zend\XmlRpc
HTTP response

Container for accessing an XMLRPC return value and creating the XML response.

Parent(s)
\Zend_XmlRpc_Response
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_XmlRpc_Response  
Version
$Id: Http.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

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

Methods

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

Constructor

Inherited from: \Zend_XmlRpc_Response::__construct()

Can optionally pass in the return value and type hinting; otherwise, the return value can be set via setReturnValue().

Parameters
NameTypeDescription
$returnmixed
$typestring
methodpublic__toString() : string

Override __toString() to send HTTP Content-Type header

Returns
TypeDescription
string
methodprotected_getXmlRpcReturn() : \Zend_XmlRpc_Value
inherited

Retrieve the XMLRPC value for the return value

Inherited from: \Zend_XmlRpc_Response::_getXmlRpcReturn()
Returns
TypeDescription
\Zend_XmlRpc_Value
methodpublicgetEncoding() : string
inherited

Retrieve current response encoding

Inherited from: \Zend_XmlRpc_Response::getEncoding()
Returns
TypeDescription
string
methodpublicgetFault() : null | \Zend_XmlRpc_Fault
inherited

Returns the fault, if any.

Inherited from: \Zend_XmlRpc_Response::getFault()
Returns
TypeDescription
null | \Zend_XmlRpc_Fault
methodpublicgetReturnValue() : mixed
inherited

Retrieve the return value

Inherited from: \Zend_XmlRpc_Response::getReturnValue()
Returns
TypeDescription
mixed
methodpublicisFault() : boolean
inherited

Is the response a fault response?

Inherited from: \Zend_XmlRpc_Response::isFault()
Returns
TypeDescription
boolean
methodpublicloadXml(string $response) : boolean
inherited

Load a response from an XML response

Inherited from: \Zend_XmlRpc_Response::loadXml()

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
inherited

Return response as XML

Inherited from: \Zend_XmlRpc_Response::saveXml()
Returns
TypeDescription
string
methodpublicsetEncoding(string $encoding) : \Zend_XmlRpc_Response
inherited

Set encoding to use in response

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

Set the return value

Inherited from: \Zend_XmlRpc_Response::setReturnValue()

Sets the return value, with optional type hinting if provided.

Parameters
NameTypeDescription
$valuemixed
$typestring
Documentation was generated by phpDocumentor 2.0.0a12.