spunQ_Exception Class Reference

Our custom exception class. More...

Inheritance diagram for spunQ_Exception:

List of all members.

Public Member Functions
	__construct ($message=NULL)
	Constructor.
	getExtendedMessage ()
	Use this instead of getMessage().
	prettyPrint ($useHtml=false)
	Prints a nice error message including backtrace.
	prettyPrintHtml ()
	Prints a nice error message including backtrace - in html.
	printBacktrace ($indent=NULL)
	Prints the backtrace of this exception.
	getBacktrace ()
	Fetches the backtrace of this exception.
Protected Attributes
	$backtrace = NULL
	The backtrace of this exception.

---

Detailed Description

Our custom exception class.

Definition at line 6 of file Exception.exception.php.

---

Constructor & Destructor Documentation

spunQ_Exception::__construct

(

$

message = NULL

)

Constructor.

Will call parent constructor with the result of getExtendedMessage(), so be sure that this function can return a valid value before calling this from a sub-class.

Reimplemented in spunQ_DatabaseException, spunQ_InvalidObjectException, spunQ_ParentTypeStorageNotFoundException, spunQ_QueryException, spunQ_Error, spunQ_FrameworkError, spunQ_InfiniteRecursionException, spunQ_FileFormatException, spunQ_IOException, spunQ_FileHasNoAliasException, spunQ_HtmlException, spunQ_HttpEntryPointNotFoundException, spunQ_UnresolvedAliasException, spunQ_ConfigurationError, spunQ_DocumentationError, spunQ_InitializationError, spunQ_IllegalValueException, spunQ_PropertyPathException, spunQ_TypeNotFoundException, spunQ_UndefinedClassError, and spunQ_ExternalApplicationFailureException.

Definition at line 20 of file Exception.exception.php.

---

Member Function Documentation

spunQ_Exception::getBacktrace

(

)

Fetches the backtrace of this exception.

Returns:

spunQ.util.Backtrace

Definition at line 91 of file Exception.exception.php.

spunQ_Exception::getExtendedMessage

(

)

Use this instead of getMessage().

Exception::getMessage() is declared final in PHP. That's why we need this second function. This is just ridiculous.

Returns:

string

Reimplemented in spunQ_LocalizedError, and spunQ_LocalizedException.

Definition at line 35 of file Exception.exception.php.

spunQ_Exception::prettyPrint

(

$

useHtml = false

)

Prints a nice error message including backtrace.

Parameters:

$useHtml

Whether to generate html text. Will cause prettyPrintHtml() to be called.

Returns:

spunQ_Exception $this

Definition at line 45 of file Exception.exception.php.

spunQ_Exception::prettyPrintHtml

(

)

Prints a nice error message including backtrace - in html.

Returns:

spunQ_Exception $this

Definition at line 63 of file Exception.exception.php.

spunQ_Exception::printBacktrace

(

$

indent = NULL

)

Prints the backtrace of this exception.

Parameters:

$indent

The string to prepend to every line. Will be passed to spunQ_Backtrace::toString().

Returns:

spunQ_Exception $this

Definition at line 82 of file Exception.exception.php.

---

Member Data Documentation

spunQ_Exception::$backtrace = NULL [protected]

The backtrace of this exception.

Type:

spunQ.util.Backtrace

Definition at line 12 of file Exception.exception.php.

---

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

• Exception.exception.php