JDocumentHTML

From Joomla! Documentation

Revision as of 22:39, 3 July 2009 by Chris Davenport (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

This class defines a web page document. Note that templates are executed within the scope of this object, so $this in a template is an object of type JDocumentHTML.

Contents

Availability

Joomla 1.5 Joomla 1.6

Defined in

/libraries/joomla/document/html/html.php

Extends

Get and Set Methods

Properties which do not have specific get or set methods listed here can be retrieved or set using the inherited from JDocument or JObject->get method.

Get method Set method Description
getBuffer setBuffer Contents of the document buffer. Overrides the JDocument methods JDocument->getBuffer and JDocument->setBuffer respectively.
getHeadData setHeadData Data destined for the HTML <head> section in array form. Separate methods to get and set all the fields in this array are provided and should normally be used in preference to these methods.

Importing

Do not import this class directly; it is imported and instantiated by JDocument->getInstance.

Other Methods

addCustomTag Adds a custom HTML string to the document head.
addFavicon Adds a favicon.ico for the document.
addHeadLink Adds <link> tags to the document head. See separate reference page for further information.
countMenuChildren Counts the number of child menu items.
countModules Counts the number of modules enabled in one or more module positions.
render Renders the HTML document.

See also

Personal tools