API17:JDocumentHTML

JDocumentHTML

Description

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.

Methods

Visibility	Method name	Description
public	__construct	Class constructor.
public	addCustomTag	Adds a custom html string to the head block.
public	addFavicon	Adds a shortcut icon (favicon).
public	addHeadLink	Adds <link> tags to the head of the document.
public	countMenuChildren	Count the number of child menu items.
public	countModules	Count the modules based on the given condition.
public	getBuffer	Get the contents of a document include.
public	getHeadData	Get the html document head data.
public	mergeHeadData	Merge the html document head data.
public	parse	Parses the template and populates the buffer.
public	render	Outputs the template to the browser.
public	setBuffer	Set the contents a document includes.
public	setHeadData	Set the html document head data.
protected	_fetchTemplate	Fetch the template, and initialise the params.

• Defined in libraries/joomla/document/html/html.php
• Extends JDocument

Importing

jimport( 'joomla.document.html.html' );

See also

• JDocumentHTML source code on BitBucket
• Subpackage Document
• Other versions of JDocumentHTML