\JDocumentHTML

DocumentHTML class, provides an easy interface to parse and display a HTML document

Synopsis

class JDocumentHTML extends JDocument {

// members
public $_links;
public $_custom;
public $template;
public $baseurl;
public $params;
public $_file;
protected $_template;
protected $_template_tags;
protected $_caching;
private $_html5;

// Inherited members from JDocument
public $title;
public $description;
public $link;
public $base;
public $language;
public $direction;
public $_generator;
public $_mdate;
public $_tab;
public $_lineEnd;
public $_charset;
public $_mime;
public $_namespace;
public $_profile;
public $_scripts;
public $_script;
public $_styleSheets;
public $_style;
public $_metaTags;
public $_engine;
public $_type;
public $_buffer;
protected $instances;
protected $mediaVersion;

// methods
public void __construct()
public array getHeadData()
public JDocumentHTML setHeadData()
public JDocumentHTML mergeHeadData()
public JDocumentHTML addHeadLink()
public JDocumentHTML addFavicon()
public JDocumentHTML addCustomTag()
public Boolean isHtml5()
public void setHtml5()
public The getBuffer()
public JDocumentHTML setBuffer()
public JDocumentHTML parse()
public The render()
public integer countModules()
public integer countMenuChildren()
protected string _loadTemplate()
protected JDocumentHTML _fetchTemplate()
protected JDocumentHTML _parseTemplate()
protected string _renderTemplate()

// Inherited methods from JDocument
public void __construct()
public static getInstance()
public JDocument setType()
public string getType()
public The getBuffer()
public JDocument setBuffer()
public string getMetaData()
public JDocument setMetaData()
public JDocument addScript()
public JDocument addScriptVersion()
public JDocument addScriptDeclaration()
public JDocument addStyleSheet()
public JDocument addStyleSheetVersion()
public JDocument addStyleDeclaration()
public JDocument setCharset()
public string getCharset()
public JDocument setLanguage()
public string getLanguage()
public JDocument setDirection()
public string getDirection()
public JDocument setTitle()
public string getTitle()
public JDocument setMediaVersion()
public string getMediaVersion()
public JDocument setBase()
public string getBase()
public JDocument setDescription()
public string getDescription()
public JDocument setLink()
public string getLink()
public JDocument setGenerator()
public string getGenerator()
public JDocument setModifiedDate()
public string getModifiedDate()
public JDocument setMimeEncoding()
public string getMimeEncoding()
public JDocument setLineEnd()
public string _getLineEnd()
public JDocument setTab()
public string _getTab()
public JDocumentRenderer loadRenderer()
public JDocument parse()
public The render()

}

Hierarchy

Extends

JDocument

Tasks

Tasks

Line	Task
558	remove code: $component = JApplicationHelper::getComponentName();

Members

private

$_html5 — boolean
Set to true when the document should be output as HTML%

protected

$_caching — integer
Integer with caching setting
$_template — string
String holding parsed template
$_template_tags — array
Array of parsed template JDoc tags
$instances — array
JDocument instances container.
$mediaVersion — string
Media version added to assets

public

$_file — array
File name

$_generator — string
Document generator

$_lineEnd — string
Contains the line end string

$_links — array
Array of Header <link> tags

$_mdate — string
Document modified date

$_metaTags — array
Array of meta tags

$_mime — string
Document mime type

$_namespace — string
Document namespace

$_profile — string
Document profile

$_script — array
Array of scripts placed in the header

$_scripts — array
Array of linked scripts

$_style — array
Array of included style declarations

$_styleSheets — array
Array of linked style sheets

$_tab — string
Tab string

$_type — string
The document type

$base — string
Document base URL

$baseurl — string
Base url

$description — string
Document description

$direction — string
Contains the document direction setting

$language — string
Contains the document language setting

$link — string
Document full URL

$params — array
Array of template parameters

$template — string
Name of the template

$title — string
Document title

Methods

protected

_fetchTemplate() — Fetch the template, and initialise the params
_loadTemplate() — Load a template file
_parseTemplate() — Parse a document template
_renderTemplate() — Render pre-parsed template

public

__construct() — Class constructor
addCustomTag() — Adds a custom HTML string to the head block
addFavicon() — Adds a shortcut icon (favicon)
addHeadLink() — Adds <link> tags to the head of the document
countMenuChildren() — Count the number of child menu items
countModules() — Count the modules based on the given condition
getBuffer() — Get the contents of a document include
getHeadData() — Get the HTML document head data
isHtml5() — Returns whether the document is set up to be output as HTML5
mergeHeadData() — Merge the HTML document head data
parse() — Parses the template and populates the buffer
render() — Outputs the template to the browser.
setBuffer() — Set the contents a document includes
setHeadData() — Set the HTML document head data
setHtml5() — Sets whether the document should be output as HTML5

Inherited from JDocument

public

_getLineEnd() — Returns the lineEnd
_getTab() — Returns a string containing the unit for indenting HTML
addScript() — Adds a linked script to the page
addScriptDeclaration() — Adds a script to the page
addScriptVersion() — Adds a linked script to the page with a version to allow to flush it. Ex: myscript.js54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
addStyleDeclaration() — Adds a stylesheet declaration to the page
addStyleSheet() — Adds a linked stylesheet to the page
addStyleSheetVersion() — Adds a linked stylesheet version to the page. Ex: template.css?54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
getBase() — Return the base URI of the document.
getBuffer() — Get the contents of the document buffer
getCharset() — Returns the document charset encoding.
getDescription() — Return the title of the page.
getDirection() — Returns the document direction declaration.
getGenerator() — Returns the document generator
getInstance() — Returns the global JDocument object, only creating it if it doesn't already exist.
getLanguage() — Returns the document language.
getLink() — Returns the document base url
getMediaVersion() — Return the media version
getMetaData() — Gets a meta tag.
getMimeEncoding() — Return the document MIME encoding that is sent to the browser.
getModifiedDate() — Returns the document modified date
getTitle() — Return the title of the document.
getType() — Returns the document type
loadRenderer() — Load a renderer
parse() — Parses the document and prepares the buffers
render() — Outputs the document
setBase() — Sets the base URI of the document
setBuffer() — Set the contents of the document buffer
setCharset() — Sets the document charset
setDescription() — Sets the description of the document
setDirection() — Sets the global document direction declaration. Default is left-to-right (ltr).
setGenerator() — Sets the document generator
setLanguage() — Sets the global document language declaration. Default is English (en-gb).
setLineEnd() — Sets the line end style to Windows, Mac, Unix or a custom string.
setLink() — Sets the document link
setMediaVersion() — Set the assets version
setMetaData() — Sets or alters a meta tag.
setMimeEncoding() — Sets the document MIME encoding that is sent to the browser.
setModifiedDate() — Sets the document modified date
setTab() — Sets the string used to indent HTML
setTitle() — Sets the title of the document
setType() — Set the document type