XmlRpc/Server/Fault.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_XmlRpc
- Subpackage
- Server
- Version
- $Id$
\Zend_XmlRpc_Server_Fault
Package: Zend_XmlRpc\Server
Returns
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.
- Parent(s)
- \Zend_XmlRpc_Fault
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_faultExceptionClasses = array('Zend_XmlRpc_Server_Exception' => true)static
Array of exception classes that may define xmlrpc faults
Default value
array('Zend_XmlRpc_Server_Exception' => true)Details- Type
- array
array $_observers = array()static
Array of fault observers
Default value
array()Details- Type
- array
Methods
__construct(\Exception $e) : \Zend_XmlRpc_Server_FaultConstructor
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $e | \Exception |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Server_Fault |
attachFaultException(string | array $classes) : voidstatic
Attach valid exceptions that can be used to define xmlrpc faults
Parameters
| Name | Type | Description |
|---|---|---|
| $classes | string | array | Class name or array of class names |
attachObserver(string $class) : booleanstatic
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.
Parameters| Name | Type | Description |
|---|---|---|
| $class | string |
| Type | Description |
|---|---|
| boolean |
detachFaultException(string | array $classes) : voidstatic
Detach fault exception classes
Parameters
| Name | Type | Description |
|---|---|---|
| $classes | string | array | Class name or array of class names |
detachObserver(string $class) : booleanstatic
Detach an observer
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $class | string |
| Type | Description |
|---|---|
| boolean |
getException() : \ExceptionRetrieve the exception
Returns
Details
| Type | Description |
|---|---|
| \Exception |
- Access
- public
getInstance(\Exception $e) : \Zend_XmlRpc_Server_Faultstatic
Return Zend_XmlRpc_Server_Fault instance
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $e | \Exception |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Server_Fault |