Joomla! 1.5 API

Packages

Package: Joomla-Framework

Other documents

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JDocumentError

Description
Description | Variables (details) | Methods (details)

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

  • since: 1.5

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

Class JObject   (Subpackage Base)

Abstract class JDocument
   
   Class JDocumentError   (Subpackage Document)
Variable Summary
Description | Variables (details) | Methods (details)
Variable object $_error
Method Summary
Description | Variables (details) | Methods (details)
Constructor JDocumentError __construct ([ $options = array()], string $type, array $attributes)
Method void render ([boolean $cache = false], [array $params = array()])
Method void renderBacktrace ()
Method boolean setError (object $error)
Method string _loadTemplate ( $directory, string $filename, string $template)
Variables
Description | Variables (details) | Methods (details)
object $_error (line 31)

Error Object

Inherited Variables

Inherited from JDocument

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

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 40)

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 76)

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 135)
void renderBacktrace ()
setError (line 59)

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 115)

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()

Joomla!


News


Sites


About


Get Started


About


Project Organization


Forum


Support Forums


Development


Sites


Forum General


Community


Joomla!


News


User Groups


Events


Translations


Directories


Extensions


Resources


Site Showcase


Developer


Resources


Production WG


Mailing Lists


Joomlacode


Shop


Merchandise


Books


Documentation


For Everyone


For Beginners


For Designers


Personae


Be a Documenter


 
 
©2005-2011 Open Source Matters, Inc. All rights reserved.    Joomla hosting by Rochen Ltd.    Design by Kontent Design    Accessibility Statement    Privacy Policy    Log in
Support Joomla!