[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/XmlRpc/Server/ -> Fault.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 201 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_XmlRpc_Server_Fault:: (7 methods):
  __construct()
  getInstance()
  attachFaultException()
  detachFaultException()
  attachObserver()
  detachObserver()
  getException()


Class: Zend_XmlRpc_Server_Fault  - X-Ref

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.

__construct(Exception $e)   X-Ref
Constructor

param: Exception $e
return: Zend_XmlRpc_Server_Fault

getInstance(Exception $e)   X-Ref
Return Zend_XmlRpc_Server_Fault instance

param: Exception $e
return: Zend_XmlRpc_Server_Fault

attachFaultException($classes)   X-Ref
Attach valid exceptions that can be used to define xmlrpc faults

param: string|array $classes Class name or array of class names
return: void

detachFaultException($classes)   X-Ref
Detach fault exception classes

param: string|array $classes Class name or array of class names
return: void

attachObserver($class)   X-Ref
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.

param: string $class
return: boolean

detachObserver($class)   X-Ref
Detach an observer

param: string $class
return: boolean

getException()   X-Ref
Retrieve the exception

return: Exception



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1