XmlRpc/Fault.php

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
subpackage: Server
version: $Id: Fault.php 20208 2010-01-11 22:37:37Z lars $
Classes: Zend_XmlRpc_Fault

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_Fault
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
Properties: $_code; $_encoding; $_message; $_internal
Methods: __construct; setCode; getCode; setMessage; getMessage; setEncoding; getEncoding; loadXml; isFault; saveXml; __toString

Description

XMLRPC Faults

Container for XMLRPC faults, containing both a code and a message; additionally, has methods for determining if an XML response is an XMLRPC fault, as well as generating the XML for an XMLRPC fault response.

To allow method chaining, you may only use the {@link getInstance()} factory to instantiate a Zend_XmlRpc_Server_Fault.

Properties

$_code
jump to class

int $_code = ''

Fault code

Details

$_code: int
visibility: protected
default
final: false
static: false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Fault character encoding

Details

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

$_internal
jump to class

array $_internal = 'array'

Internal fault codes => messages

Details

$_internal: array
visibility: protected
default: array
final: false
static: false

$_message
jump to class

string $_message = ''

Fault message

Details

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

Methods

__construct
jump to class

__construct(
           $code
              =
              404,  $message
          )
        
        :
        Zend_XmlRpc_Fault

Constructor

Arguments

$code
$message

Output

Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Return XML fault response

Output

string

Details

visibility: public
final: false
static: false

getCode
jump to class

getCode(
          
          )
        
        :
        int

Return fault code

Output

int

Details

visibility: public
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Retrieve current fault encoding

Output

string

Details

visibility: public
final: false
static: false

getMessage
jump to class

getMessage(
          
          )
        
        :
        string

Retrieve fault message

Output

string

Details

visibility: public
final: false
static: false

isFault
jump to class

isFault(
          string $xml
          )
        
        :
        boolean

Determine if an XML response is an XMLRPC fault

Arguments

$xml: string

Output

boolean

Details

visibility: public
final: false
static: true

loadXml
jump to class

loadXml(
          string $fault
          )
        
        :
        boolean

Load an XMLRPC fault from XML

Arguments

$fault: string

Output

boolean: Returns true if successfully loaded fault response, false if response was not a fault response

Details

visibility: public
final: false
static: false
throws: if no or faulty XML provided, or if fault response does not contain either code or message

saveXml
jump to class

saveXml(
          
          )
        
        :
        string

Serialize fault to XML

Output

string

Details

visibility: public
final: false
static: false

setCode
jump to class

setCode(
          int $code
          )
        
        :
        Zend_XmlRpc_Fault

Set the fault code

Arguments

$code: int

Output

Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $encoding
          )
        
        :
        Zend_XmlRpc_Fault

Set encoding to use in fault response

Arguments

$encoding: string

Output

Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

setMessage
jump to class

setMessage(
           $message
          )
        
        :
        Zend_XmlRpc_Fault

Retrieve fault message

Arguments

$message: string

Output

Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

API Documentation

XmlRpc/Fault.php

Description

Zend_XmlRpc_Faultjump to top

Description

Properties

$_codejump to class

Details

$_encodingjump to class

Details

$_internaljump to class

Details

$_messagejump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

__toStringjump to class

Output

Details

getCodejump to class

Output

Details

getEncodingjump to class

Output

Details

getMessagejump to class

Output

Details

isFaultjump to class

Arguments

Output

Details

loadXmljump to class

Arguments

Output

Details

saveXmljump to class

Output

Details

setCodejump to class

Arguments

Output

Details

setEncodingjump to class

Arguments

Output

Details

setMessagejump to class

Arguments

Output

Details

Zend_XmlRpc_Fault
jump to top

$_code
jump to class

$_encoding
jump to class

$_internal
jump to class

$_message
jump to class

__construct
jump to class

__toString
jump to class

getCode
jump to class

getEncoding
jump to class

getMessage
jump to class

isFault
jump to class

loadXml
jump to class

saveXml
jump to class

setCode
jump to class

setEncoding
jump to class

setMessage
jump to class