Docs for class JDocumentRenderer

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JDocumentRenderer

Description

Abstract class for a renderer

since: 1.5
author: Johan Janssens <[email protected]>
abstract:

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

 JObject   (Subpackage Base)

 JDocumentRenderer   (Subpackage Document)

Direct descendents

Class	Description
JDocumentRenderer_Modules	JDocument Modules renderer
JDocumentRenderer_Component	Component renderer
JDocumentRenderer_Message	JDocument system message renderer
JDocumentRenderer_Module	JDocument Module renderer
JDocumentRenderer_Head	JDocument head renderer
JDocumentRenderer_RSS	JDocumentRenderer_RSS is a feed that implements RSS 2.0 Specification
JDocumentRenderer_Atom	JDocumentRenderer_Atom is a feed that implements the atom 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 35)

reference to the JDocument object that instantiated the renderer

access: protected

Methods

Constructor __construct (line 51)

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

Return the content type of the renderer

return: The contentType

string getContentType ()

render (line 65)

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:

JDocumentRenderer_Modules::render() : Renders multiple modules script and returns the results as a string
JDocumentRenderer_Component::render() : Renders a component script and returns the results as a string
JDocumentRenderer_Message::render() : Renders the error stack and returns the results as a string
JDocumentRenderer_Module::render() : Renders a module script and returns the results as a string
JDocumentRenderer_Head::render() : Renders the document head and returns the results as a string
JDocumentRenderer_RSS::render() : Render the feed
JDocumentRenderer_Atom::render() : Render the feed

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:20:08 +0000 by phpDocumentor 1.3.1