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 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 attachObserver(). Observers need only implement a static 'observe' method.

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

• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• license: New BSD License

Located in /XmlRpc/Server/Fault.php (line 50)

Zend_XmlRpc_Fault
   |
   --Zend_XmlRpc_Server_Fault

static array $_faultExceptionClasses = array('Zend_XmlRpc_Server_Exception' => true) (line 60)

• var: Array of exception classes that may define xmlrpc faults
• access: protected

static array $_observers = array() (line 65)

• var: Array of fault observers
• access: protected

Exception $_exception (line 55)

• access: protected

Inherited Variables

Inherited from Zend_XmlRpc_Fault

Zend_XmlRpc_Fault::$_code
Zend_XmlRpc_Fault::$_encoding
Zend_XmlRpc_Fault::$_internal
Zend_XmlRpc_Fault::$_message

static attachFaultException (line 115)

Attach valid exceptions that can be used to define xmlrpc faults

• access: public

static void attachFaultException (string|array $classes)

• string|array $classes: Class name or array of class names

static attachObserver (line 159)

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.

• access: public

static boolean attachObserver (string $class)

• string $class

static detachFaultException (line 134)

Detach fault exception classes

• access: public

static void detachFaultException (string|array $classes)

• string|array $classes: Class name or array of class names

static detachObserver (line 181)

Detach an observer

• access: public

static boolean detachObserver (string $class)

• string $class

static getInstance (line 104)

Return Zend_XmlRpc_Server_Fault instance

• access: public

static Zend_XmlRpc_Server_Fault getInstance ( $e)

• Exception $e

Constructor __construct (line 73)

Constructor

• access: public

Zend_XmlRpc_Server_Fault __construct ( $e)

• Exception $e

---

Redefinition of:

Zend_XmlRpc_Fault::__construct()

Constructor

getException (line 197)

Retrieve the exception

• access: public

Exception getException ()

Inherited Methods

Inherited From Zend_XmlRpc_Fault

Zend_XmlRpc_Fault::__construct()
Zend_XmlRpc_Fault::getCode()
Zend_XmlRpc_Fault::getEncoding()
Zend_XmlRpc_Fault::getMessage()
Zend_XmlRpc_Fault::isFault()
Zend_XmlRpc_Fault::loadXml()
Zend_XmlRpc_Fault::saveXml()
Zend_XmlRpc_Fault::setCode()
Zend_XmlRpc_Fault::setEncoding()
Zend_XmlRpc_Fault::setMessage()
Zend_XmlRpc_Fault::__toString()