XmlRpc/Server/Fault.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_XmlRpc
subpackage: Server
version: $Id: Fault.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_XmlRpc_Server_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_Server_Fault
jump to top

Extends from: Zend_XmlRpc_Fault
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
subpackage: Server
Properties: $_exception; $_faultExceptionClasses; $_observers
Methods: __construct; getInstance; attachFaultException; detachFaultException; attachObserver; detachObserver; getException

Description

XMLRPC Server Faults

Encapsulates an exception for use as an XMLRPC fault response. Valid exception classes that may be used for generating the fault code and fault string can be attached using {@link attachFaultException()}; all others use a generic '404 Unknown error' response.

You may also attach fault observers, which would allow you to monitor particular fault cases; this is done via {@link attachObserver()}. Observers need only implement a static 'observe' method.

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

Properties

$_exception
jump to class

Exception $_exception = ''

Details

$_exception: Exception
visibility: protected
default
final: false
static: false

$_faultExceptionClasses
jump to class

array $_faultExceptionClasses = 'array'

Details

$_faultExceptionClasses: array
Array of exception classes that may define xmlrpc faults
visibility: protected
default: array
final: false
static: true

$_observers
jump to class

array $_observers = 'array'

Details

$_observers: array
Array of fault observers
visibility: protected
default: array
final: false
static: true

Methods

__construct
jump to class

__construct(
          Exception $e
          )
        
        :
        Zend_XmlRpc_Server_Fault

Constructor

Arguments

$e: Exception

Output

Zend_XmlRpc_Server_Fault

Details

visibility: public
final: false
static: false

attachFaultException
jump to class

attachFaultException(
          string|array $classes
          )
        
        :
        void

Attach valid exceptions that can be used to define xmlrpc faults

Arguments

$classes: stringarray
Class name or array of class names

Details

visibility: public
final: false
static: true

attachObserver
jump to class

attachObserver(
          string $class
          )
        
        :
        boolean

Attach an observer class

Allows observation of xmlrpc server faults, thus allowing logging or mail notification of fault responses on the xmlrpc server.

Expects a valid class name; that class must have a public static method 'observe' that accepts an exception as its sole argument.

Arguments

$class: string

Output

boolean

Details

visibility: public
final: false
static: true

detachFaultException
jump to class

detachFaultException(
          string|array $classes
          )
        
        :
        void

Detach fault exception classes

Arguments

$classes: stringarray
Class name or array of class names

Details

visibility: public
final: false
static: true

detachObserver
jump to class

detachObserver(
          string $class
          )
        
        :
        boolean

Detach an observer

Arguments

$class: string

Output

boolean

Details

visibility: public
final: false
static: true

getException
jump to class

getException(
          
          )
        
        :
        Exception

Retrieve the exception

Output

Exception

Details

visibility: public
final: false
static: false
access: public

getInstance
jump to class

getInstance(
          Exception $e
          )
        
        :
        Zend_XmlRpc_Server_Fault

Return Zend_XmlRpc_Server_Fault instance

Arguments

$e: Exception

Output

Zend_XmlRpc_Server_Fault

Details

visibility: public
final: false
static: true

API Documentation

XmlRpc/Server/Fault.php

Description

Zend_XmlRpc_Server_Faultjump to top

Description

Properties

$_exceptionjump to class

Details

$_faultExceptionClassesjump to class

Details

$_observersjump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

attachFaultExceptionjump to class

Arguments

Details

attachObserverjump to class

Arguments

Output

Details

detachFaultExceptionjump to class

Arguments

Details

detachObserverjump to class

Arguments

Output

Details

getExceptionjump to class

Output

Details

getInstancejump to class

Arguments

Output

Details

Zend_XmlRpc_Server_Fault
jump to top

$_exception
jump to class

$_faultExceptionClasses
jump to class

$_observers
jump to class

__construct
jump to class

attachFaultException
jump to class

attachObserver
jump to class

detachFaultException
jump to class

detachObserver
jump to class

getException
jump to class

getInstance
jump to class