PEAR_Exception Class Reference

Inheritance diagram for PEAR_Exception:

Public Member Functions
	__construct ($message, $p2=null, $p3=null)
	getErrorData ()
	getCause ()
	getCauseMessage (&$causes)
	getTraceSafe ()
	getErrorClass ()
	getErrorMethod ()
	__toString ()
	toHtml ()
	toText ()

Static Public Member Functions
static	addObserver ($callback, $label= 'default')
static	removeObserver ($label= 'default')
static	getUniqueId ()

Public Attributes
const	OBSERVER_PRINT = -2
const	OBSERVER_TRIGGER = -4
const	OBSERVER_DIE = -8

Protected Attributes
	$cause

Detailed Description

Definition at line 97 of file Exception.php.

Constructor & Destructor Documentation

PEAR_Exception::__construct	(		$message,
			$p2 = null,
			$p3 = null
	)

Supported signatures:

• PEAR_Exception(string $message);
• PEAR_Exception(string $message, int $code);
• PEAR_Exception(string $message, Exception $cause);
• PEAR_Exception(string $message, Exception $cause, int $code);
• PEAR_Exception(string $message, PEAR_Error $cause);
• PEAR_Exception(string $message, PEAR_Error $cause, int $code);
• PEAR_Exception(string $message, array $causes);
• PEAR_Exception(string $message, array $causes, int $code);

  Parameters

  string	exception message
  int|Exception|PEAR_Error|array|null	exception cause
  int|null	exception code or null

Definition at line 121 of file Exception.php.

Member Function Documentation

PEAR_Exception::__toString

(

)

Definition at line 315 of file Exception.php.

static PEAR_Exception::addObserver (   $callback,   $label = 'default'  )

static

Parameters

mixed	$callback	- A valid php callback, see php func is_callable() A PEAR_Exception::OBSERVER_* constant An array(const PEAR_Exception::OBSERVER_*, mixed $options)
string	$label	The name of the observer. Use this if you want to remove it later with removeObserver()

Definition at line 156 of file Exception.php.

PEAR_Exception::getCause

(

)

Returns the exception that caused this exception to be thrown public

Returns

Exception|array The context of the exception

Definition at line 225 of file Exception.php.

PEAR_Exception::getCauseMessage

(

&

$causes

)

Function must be public to call on caused exceptions

Parameters

array

Definition at line 234 of file Exception.php.

PEAR_Exception::getErrorClass

(

)

Definition at line 303 of file Exception.php.

PEAR_Exception::getErrorData

(

)

Return specific error information that can be used for more detailed error messages or translation.

This method may be overridden in child exception classes in order to add functionality not present in PEAR_Exception and is a placeholder to define API

The returned array must be an associative array of parameter => value like so:

array('name' => $name, 'context' => array(...))

Returns

array

Definition at line 215 of file Exception.php.

PEAR_Exception::getErrorMethod

(

)

Definition at line 309 of file Exception.php.

PEAR_Exception::getTraceSafe

(

)

Definition at line 291 of file Exception.php.

static PEAR_Exception::getUniqueId ( )

static

Returns

int unique identifier for an observer

Definition at line 169 of file Exception.php.

static PEAR_Exception::removeObserver (   $label = 'default' )

static

Definition at line 161 of file Exception.php.

PEAR_Exception::toHtml

(

)

Definition at line 323 of file Exception.php.

PEAR_Exception::toText

(

)

Definition at line 377 of file Exception.php.

Member Data Documentation

PEAR_Exception::$cause

protected

Definition at line 102 of file Exception.php.

const PEAR_Exception::OBSERVER_DIE = -8

Definition at line 101 of file Exception.php.

const PEAR_Exception::OBSERVER_PRINT = -2

Definition at line 99 of file Exception.php.

const PEAR_Exception::OBSERVER_TRIGGER = -4

Definition at line 100 of file Exception.php.

---

The documentation for this class was generated from the following file:

• libs/PEAR.1.9.5/PEAR/Exception.php