Docs for class JDocumentRenderer

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 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.

JDocumentRenderer

Description

Abstract class for a renderer

since: 1.5
abstract:

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

 JObject   (Subpackage Base)

 JDocumentRenderer   (Subpackage Document)

Direct descendents

Class	Description
JDocumentRendererModules	JDocument Modules renderer
JDocumentRendererMessage	JDocument system message renderer
JDocumentRendererComponent	Component renderer
JDocumentRendererHead	JDocument head renderer
JDocumentRendererModule	JDocument Module renderer
JDocumentRendererAtom	JDocumentRenderer_Atom is a feed that implements the atom specification
JDocumentRendererRSS	JDocumentRenderer_RSS is a feed that implements RSS 2.0 Specification

Variable Summary

object $_doc

Method Summary

JDocumentRenderer __construct (object A &$doc)

string getContentType ()

string render (string $name, [ $params = array()], [string $content = null], array $array)

Variables

object $_doc = null (line 34)

reference to the JDocument object that instantiated the renderer

access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 50)

Class constructor

access: protected

JDocumentRenderer __construct (object A &$doc)

object A &$doc: reference to the JDocument object that instantiated the renderer

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

getContentType (line 74)

Return the content type of the renderer

return: The contentType

string getContentType ()

render (line 64)

Renders a script and returns the results as a string

return: The output of the script
access: public
abstract:

string render (string $name, [ $params = array()], [string $content = null], array $array)

string $name: The name of the element to render
array $array: Array of values
string $content: Override the output of the renderer
$params

Redefined in descendants as:

JDocumentRendererModules::render() : Renders multiple modules script and returns the results as a string
JDocumentRendererMessage::render() : Renders the error stack and returns the results as a string
JDocumentRendererComponent::render() : Renders a component script and returns the results as a string
JDocumentRendererHead::render() : Renders the document head and returns the results as a string
JDocumentRendererModule::render() : Renders a module script and returns the results as a string
JDocumentRendererAtom::render() : Render the feed
JDocumentRendererRSS::render() : Render the feed

Inherited Methods

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

Documentation generated on Sat, 14 Nov 2009 11:18:27 +0000 by phpDocumentor 1.3.1