DocumentError class, provides an easy interface to parse and display an error page

• since: 1.5
• author: Louis Landry <louis.landry@joomla.org>

Located in /joomla/document/error/error.php (line 26)

 JObject   (Subpackage Base)

 JDocument
   
    JDocumentError   (Subpackage Document)

object $_error (line 32)

Error Object

Inherited Variables

Inherited from JDocument

JDocument::$base
JDocument::$description
JDocument::$direction
JDocument::$language
JDocument::$link
JDocument::$title
JDocument::$_generator

Inherited from JObject

JObject::$_errors

Constructor __construct (line 41)

Class constructor

• access: protected

JDocumentError __construct ([ $options = array()], string $type, array $attributes)

• string $type: (either html or tex)
• array $attributes: Associative array of attributes
• $options

---

Redefinition of:

JDocument::__construct()

Class constructor

render (line 77)

Render the document

• access: public

void render ([boolean $cache = false], [array $params = array()])

• boolean $cache: If true, cache the output
• array $params: Associative array of attributes

---

Redefinition of:

JDocument::render()

Outputs the document

renderBacktrace (line 136)

void renderBacktrace ()

setError (line 60)

Set error object

• return: True on success
• since: 1.5
• access: public

boolean setError (object $error)

• object $error: Error object to set

---

Redefinition of:

JObject::setError()

Add an error message

_loadTemplate (line 116)

Load a template file

• return: The contents of the template

string _loadTemplate ( $directory, string $filename, string $template)

• string $template: The name of the template
• string $filename: The actual filename
• $directory

Inherited Methods

Inherited From JDocument

JDocument::__construct()
JDocument::addScript()
JDocument::addScriptDeclaration()
JDocument::addStyleDeclaration()
JDocument::addStyleSheet()
JDocument::getBase()
JDocument::getBuffer()
JDocument::getCharset()
JDocument::getDescription()
JDocument::getDirection()
JDocument::getGenerator()
JDocument::getHeadData()
JDocument::getInstance()
JDocument::getLanguage()
JDocument::getLink()
JDocument::getMetaData()
JDocument::getModifiedDate()
JDocument::getTitle()
JDocument::getType()
JDocument::loadRenderer()
JDocument::render()
JDocument::setBase()
JDocument::setBuffer()
JDocument::setCharset()
JDocument::setDescription()
JDocument::setDirection()
JDocument::setGenerator()
JDocument::setHeadData()
JDocument::setLanguage()
JDocument::setLineEnd()
JDocument::setLink()
JDocument::setMetaData()
JDocument::setMimeEncoding()
JDocument::setModifiedDate()
JDocument::setTab()
JDocument::setTitle()
JDocument::setType()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()