Difference between revisions of "JDocumentRenderer"
From Joomla! Documentation
(New page: <span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki>
</span>
{{Description:JDocumentRenderer}}
===...) |
|||
| Line 21: | Line 21: | ||
|Return the content type of the renderer | |Return the content type of the renderer | ||
|} | |} | ||
| + | |||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.document.renderer' );</source> | <source lang="php">jimport( 'joomla.document.renderer' );</source> | ||
Revision as of 12:34, 25 March 2010
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
[Edit Descripton] Template:Description:JDocumentRenderer
Defined in[edit]
libraries/joomla/document/renderer.php
Methods[edit]
| 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[edit]
jimport( 'joomla.document.renderer' );[Edit See Also] Template:SeeAlso:JDocumentRenderer
Examples[edit]
<CodeExamplesForm />
Adding support for new document renderers
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.
Defined in[edit]
libraries/joomla/document/renderer.php
Methods[edit]
| 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[edit]
jimport( 'joomla.document.renderer' );
Examples[edit]
Code Examples[edit]
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.
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.