spunQ_Error Class Reference

Exceptions that are thrown because of a programming error. More...

Inheritance diagram for spunQ_Error:

List of all members.

Public Member Functions
	__construct ($message)
	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

Exceptions that are thrown because of a programming error.

Not all exceptions are caused by bad programming. Any exception that indicates that the programmer messed up according to the rules of the framework (missing required code documentation/wrong inheritance/...). Exceptions of this type would possibly be compiler errors if the spunQ rules could be considered a language syntax.

Definition at line 10 of file Error.error.php.

---

Constructor & Destructor Documentation

spunQ_Error::__construct

(

$

message

)

Constructor.

Parameters:

$message

The message of this exception. This parameter is passed to the builtin Exception type

Reimplemented from spunQ_Exception.

Reimplemented in spunQ_FrameworkError, spunQ_ConfigurationError, spunQ_DocumentationError, spunQ_InitializationError, and spunQ_UndefinedClassError.

Definition at line 17 of file Error.error.php.

---

Member Function Documentation

spunQ_Exception::getBacktrace

(

)

[inherited]

Fetches the backtrace of this exception.

Returns:

spunQ.util.Backtrace

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

spunQ_Exception::getExtendedMessage

(

)

[inherited]

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

)

[inherited]

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

(

)

[inherited]

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

)

[inherited]

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, inherited]

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:

• Error.error.php