Class JDocumentError

Description

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

  • since: 11.1

Located in /libraries/joomla/document/error/error.php (line 19)

JObject
   |
   --JDocument
      |
      --JDocumentError
Variable Summary
object $_error
Method Summary
JDocumentError __construct ([array $options = array()])
string render ([boolean $cache = false], [array $params = array()])
string renderBacktrace ()
boolean setError (object $error)
string _loadTemplate (string $directory, string $filename)
Variables
Methods
Constructor __construct (line 36)

Class constructor

  • since: 11.1
  • access: public
JDocumentError __construct ([array $options = array()])
  • array $options: Associative array of attributes

Redefinition of:
JDocument::__construct()
Class constructor.
render (line 79)

Render the document

  • return: The rendered data
  • since: 11.1
  • access: public
string 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 150)

Render the backtrace

  • return: The contents of the backtrace
  • since: 11.1
  • access: public
string renderBacktrace ()
setError (line 56)

Set error object

  • return: True on success
  • since: 11.1
  • access: public
boolean setError (object $error)
  • object $error: Error object to set

Redefinition of:
JObject::setError()
Add an error message.
_loadTemplate (line 123)

Load a template file

  • return: The contents of the template
  • since: 11.1
  • access: public
string _loadTemplate (string $directory, string $filename)
  • string $directory: The name of the template
  • string $filename: The actual filename

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::getInstance()
JDocument::getLanguage()
JDocument::getLink()
JDocument::getMetaData()
JDocument::getMimeEncoding()
JDocument::getModifiedDate()
JDocument::getTitle()
JDocument::getType()
JDocument::loadRenderer()
JDocument::parse()
JDocument::render()
JDocument::setBase()
JDocument::setBuffer()
JDocument::setCharset()
JDocument::setDescription()
JDocument::setDirection()
JDocument::setGenerator()
JDocument::setLanguage()
JDocument::setLineEnd()
JDocument::setLink()
JDocument::setMetaData()
JDocument::setMimeEncoding()
JDocument::setModifiedDate()
JDocument::setTab()
JDocument::setTitle()
JDocument::setType()
JDocument::_getLineEnd()
JDocument::_getTab()

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:54:28 -0500 by phpDocumentor 1.4.4