Class JDocumentRenderer

Description

Abstract class for a renderer

  • since: 11.1

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

JObject
   |
   --JDocumentRenderer
Direct descendents
Class Description
JDocumentRendererAtom JDocumentRenderer_Atom is a feed that implements the atom specification
JDocumentRendererRSS JDocumentRenderer_RSS is a feed that implements RSS 2.0 Specification
JDocumentRendererModule JDocument Module renderer
JDocumentRendererHead JDocument head renderer
JDocumentRendererComponent Component renderer
JDocumentRendererMessage JDocument system message renderer
JDocumentRendererModules JDocument Modules renderer
Variable Summary
Method Summary
JDocumentRenderer __construct (JDocument &$doc)
string getContentType ()
string render (string $name, [array $params = null], [string $content = null])
Variables
JDocument $_doc = null (line 27)

Reference to the JDocument object that instantiated the renderer

  • since: 11.1
  • access: protected
string $_mime = "text/html" (line 35)

Renderer mime type

  • since: 11.1
  • access: protected

Redefined in descendants as:

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 44)

Class constructor

  • since: 11.1
  • access: public
JDocumentRenderer __construct (JDocument &$doc)
  • JDocument &$doc: A reference to the JDocument object that instantiated the renderer

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
getContentType (line 71)

Return the content type of the renderer

  • return: The contentType
  • since: 11.1
  • access: public
string getContentType ()
render (line 60)

Renders a script and returns the results as a string

  • return: The output of the script
  • since: 11.1
  • access: public
string render (string $name, [array $params = null], [string $content = null])
  • string $name: The name of the element to render
  • array $params: Array of values
  • string $content: Override the output of the renderer

Redefined in descendants as:

Inherited Methods

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:59:10 -0500 by phpDocumentor 1.4.4