XmlRpc/Response.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
Classes: Zend_XmlRpc_Response

Description

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.

Zend_XmlRpc_Response
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_XmlRpc
version: $Id: Response.php 20208 2010-01-11 22:37:37Z lars $
Properties: $_return; $_type; $_encoding; $_fault
Methods: __construct; setEncoding; getEncoding; setReturnValue; getReturnValue; _getXmlRpcReturn; isFault; getFault; loadXml; saveXml; __toString

Description

XmlRpc Response

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

Properties

$_encoding
jump to class

string $_encoding = 'UTF-8'

Response character encoding

Details

$_encoding: string
visibility: protected
default: UTF-8
final: false
static: false

$_fault
jump to class

null|Zend_XmlRpc_Fault $_fault = 'null'

Fault, if response is a fault response

Details

$_fault: null|Zend_XmlRpc_Fault
visibility: protected
default: null
final: false
static: false

$_return
jump to class

mixed $_return = ''

Return value

Details

$_return: mixed
visibility: protected
default
final: false
static: false

$_type
jump to class

string $_type = ''

Return type

Details

$_type: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__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()}.

Arguments

$return: mixed
$type: string

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Return XML response

Output

string

Details

visibility: public
final: false
static: false

_getXmlRpcReturn
jump to class

_getXmlRpcReturn(
          
          )
        
        :
        Zend_XmlRpc_Value

Retrieve the XMLRPC value for the return value

Output

Zend_XmlRpc_Value

Details

visibility: protected
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Retrieve current response encoding

Output

string

Details

visibility: public
final: false
static: false

getFault
jump to class

getFault(
          
          )
        
        :
        null|Zend_XmlRpc_Fault

Returns the fault, if any.

Output

null|Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

getReturnValue
jump to class

getReturnValue(
          
          )
        
        :
        mixed

Retrieve the return value

Output

mixed

Details

visibility: public
final: false
static: false

isFault
jump to class

isFault(
          
          )
        
        :
        boolean

Is the response a fault response?

Output

boolean

Details

visibility: public
final: false
static: false

loadXml
jump to class

loadXml(
          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.

Arguments

$response: string

Output

boolean: True if a valid XMLRPC response, false if a fault response or invalid input

Details

visibility: public
final: false
static: false

saveXml
jump to class

saveXml(
          
          )
        
        :
        string

Return response as XML

Output

string

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $encoding
          )
        
        :
        Zend_XmlRpc_Response

Set encoding to use in response

Arguments

$encoding: string

Output

Zend_XmlRpc_Response

Details

visibility: public
final: false
static: false

setReturnValue
jump to class

setReturnValue(
          mixed $value, string $type
              =
              null
          )
        
        :
        void

Set the return value

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

Arguments

$value: mixed
$type: string

Details

visibility: public
final: false
static: false

API Documentation

XmlRpc/Response.php

Description

Zend_XmlRpc_Responsejump to top

Description

Properties

$_encodingjump to class

Details

$_faultjump to class

Details

$_returnjump to class

Details

$_typejump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_getXmlRpcReturnjump to class

Output

Details

getEncodingjump to class

Output

Details

getFaultjump to class

Output

Details

getReturnValuejump to class

Output

Details

isFaultjump to class

Output

Details

loadXmljump to class

Arguments

Output

Details

saveXmljump to class

Output

Details

setEncodingjump to class

Arguments

Output

Details

setReturnValuejump to class

Arguments

Details

Zend_XmlRpc_Response
jump to top

$_encoding
jump to class

$_fault
jump to class

$_return
jump to class

$_type
jump to class

__construct
jump to class

__toString
jump to class

_getXmlRpcReturn
jump to class

getEncoding
jump to class

getFault
jump to class

getReturnValue
jump to class

isFault
jump to class

loadXml
jump to class

saveXml
jump to class

setEncoding
jump to class

setReturnValue
jump to class