Actions

API16

JDocumentRenderer

From Joomla! Documentation

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

[Edit Descripton] JDocumentRenderer is an abstract class which provides a number of methods and properties to assist in rendering a particular document type. Not all document types implement renderers in this way. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information.

Contents

Defined in

libraries/joomla/document/renderer.php

Methods

Method name Description
__construct Class constructor
render Renders a script and returns the results as a string
getContentType Return the content type of the renderer

Importing

jimport( 'joomla.document.renderer' );

[Edit See Also] SeeAlso:JDocumentRenderer

Examples

<CodeExamplesForm />

Adding support for new document renderers

New renderer types are added by creating a new file in the renderer directory under the document type directory with the same name as the renderer. For example, to add a document renderer type called "myrenderer" for document type "mytype", you would create the file /libraries/joomla/document/mytype/renderer/myrenderer.php. This file will contain the class definition for JDocumentRendererMytype which extends JDocumentRenderer. Look at the code for existing document renderers to see what needs to be done.


Chris Davenport 12:39, 17 April 2011 (CDT) Edit comment