Class JDocumentHtml

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

JDocument

JDocumentHtml

Package: Joomla\Platform\Document
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/document/html.php

Methods summary

`public`	# `__construct( array $options = array() )` Class constructor Class constructor Parameters `$options` `array` - $options Associative array of options Since 11.1 Overrides `JDocument::__construct`
`public array`	# `getHeadData( )` Get the HTML document head data Get the HTML document head data Returns `array` - The document head data in array form Since 11.1
`public JDocumentHTML`	# `resetHeadData( mixed $types = null )` Reset the HTML document head data Reset the HTML document head data Parameters `$types` `mixed` - $types type or types of the heads elements to reset Returns `JDocumentHTML` - instance of $this to allow chaining Since 3.7.0
`public JDocumentHTML\|null`	# `setHeadData( array $data )` Set the HTML document head data Set the HTML document head data Parameters `$data` `array` - $data The document head data in array form Returns `JDocumentHTML\|null` - instance of $this to allow chaining or null for empty input data Since 11.1
`public JDocumentHTML\|null`	# `mergeHeadData( array $data )` Merge the HTML document head data Merge the HTML document head data Parameters `$data` `array` - $data The document head data in array form Returns `JDocumentHTML\|null` - instance of $this to allow chaining or null for empty input data Since 11.1
`public JDocumentHTML`	# `addHeadLink( string $href, string $relation, string $relType = 'rel', array $attribs = array() )` Adds `<link>` tags to the head of the document Adds `<link>` tags to the head of the document $relType defaults to 'rel' as it is the most common relation type used. ('rev' refers to reverse relation, 'rel' indicates normal, forward relation.) Typical tag: `<link href="index.php" rel="Start">` Parameters `$href` `string` - $href The link that is being related. `$relation` `string` - $relation Relation of link. `$relType` `string` - $relType Relation type attribute. Either rel or rev (default: 'rel'). `$attribs` `array` - $attribs Associative array of remaining attributes. Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1
`public JDocumentHTML`	# `addFavicon( string $href, string $type = 'image/vnd.microsoft.icon', string $relation = 'shortcut icon' )` Adds a shortcut icon (favicon) Adds a shortcut icon (favicon) This adds a link to the icon shown in the favorites list or on the left of the url in the address bar. Some browsers display it on the tab, as well. Parameters `$href` `string` - $href The link that is being related. `$type` `string` - $type File type `$relation` `string` - $relation Relation of link Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1
`public JDocumentHTML`	# `addCustomTag( string $html )` Adds a custom HTML string to the head block Adds a custom HTML string to the head block Parameters `$html` `string` - $html The HTML to add to the head Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1
`public boolean`	# `isHtml5( )` Returns whether the document is set up to be output as HTML5 Returns whether the document is set up to be output as HTML5 Returns `boolean` - true when HTML5 is used Since 12.1
`public`	# `setHtml5( boolean $state )` Sets whether the document should be output as HTML5 Sets whether the document should be output as HTML5 Parameters `$state` `boolean` - $state True when HTML5 should be output Since 12.1
`public mixed\|string`	# `getBuffer( string $type = null, string $name = null, array $attribs = array() )` Get the contents of a document include Get the contents of a document include Parameters `$type` `string` - $type The type of renderer `$name` `string` - $name The name of the element to render `$attribs` `array` - $attribs Associative array of remaining attributes. Returns `mixed\|string` - The output of the renderer Since 11.1 Overrides `JDocument::getBuffer`
`public JDocumentHTML`	# `setBuffer( string $content, array $options = array() )` Set the contents a document includes Set the contents a document includes Parameters `$content` `string` - $content The content to be set in the buffer. `$options` `array` - $options Array of optional elements. Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1 Overrides `JDocument::setBuffer`
`public JDocumentHTML`	# `parse( array $params = array() )` Parses the template and populates the buffer Parses the template and populates the buffer Parameters `$params` `array` - $params Parameters for fetching the template Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1 Overrides `JDocument::parse`
`public string`	# `render( boolean $caching = false, array $params = array() )` Outputs the template to the browser. Outputs the template to the browser. Parameters `$caching` `boolean` - $caching If true, cache the output `$params` `array` - $params Associative array of attributes Returns `string` - The rendered data Since 11.1 Overrides `JDocument::render`
`public integer`	# `countModules( string $condition )` Count the modules based on the given condition Count the modules based on the given condition Parameters `$condition` `string` - $condition The condition to use Returns `integer` - Number of modules found Since 11.1
`public integer`	# `countMenuChildren( )` Count the number of child menu items of the current active menu item Count the number of child menu items of the current active menu item Returns `integer` - Number of child menu items Since 11.1
`protected string`	# `_loadTemplate( string $directory, string $filename )` Load a template file Load a template file Parameters `$directory` `string` - $directory The name of the template `$filename` `string` - $filename The actual filename Returns `string` - The contents of the template Since 11.1
`protected JDocumentHTML`	# `_fetchTemplate( array $params = array() )` Fetch the template, and initialise the params Fetch the template, and initialise the params Parameters `$params` `array` - $params Parameters to determine the template Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1
`protected JDocumentHTML`	# `_parseTemplate( )` Parse a document template Parse a document template Returns `JDocumentHTML` - instance of $this to allow chaining Since 11.1
`protected string`	# `_renderTemplate( )` Render pre-parsed template Render pre-parsed template Returns `string` - rendered template Since 11.1

Methods inherited from JDocument

_getLineEnd(), _getTab(), addScript(), addScriptDeclaration(), addScriptOptions(), addScriptVersion(), addStyleDeclaration(), addStyleSheet(), addStyleSheetVersion(), getBase(), getCharset(), getDescription(), getDirection(), getGenerator(), getInstance(), getLanguage(), getLink(), getMediaVersion(), getMetaData(), getMimeEncoding(), getModifiedDate(), getScriptOptions(), getTitle(), getType(), loadRenderer(), setBase(), setCharset(), setDescription(), setDirection(), setGenerator(), setLanguage(), setLineEnd(), setLink(), setMediaVersion(), setMetaData(), setMimeEncoding(), setModifiedDate(), setTab(), setTitle(), setType()

Magic methods summary

Properties summary

`public array`	`$_links`	# Array of Header `<link>` tags Array of Header `<link>` tags Since 11.1
`public array`	`$_custom`	# Array of custom tags Array of custom tags Since 11.1
`public string`	`$template`	# Name of the template Name of the template Since 11.1
`public string`	`$baseurl`	# Base url Base url Since 11.1
`public array`	`$params`	# Array of template parameters Array of template parameters Since 11.1
`public array`	`$_file`	# File name File name Since 11.1
`protected string`	`$_template`	# String holding parsed template String holding parsed template Since 11.1
`protected array`	`$_template_tags`	# Array of parsed template JDoc tags Array of parsed template JDoc tags Since 11.1
`protected integer`	`$_caching`	# Integer with caching setting Integer with caching setting Since 11.1

Properties inherited from JDocument

$_buffer, $_charset, $_engine, $_generator, $_lineEnd, $_mdate, $_metaTags, $_mime, $_namespace, $_profile, $_script, $_scripts, $_style, $_styleSheets, $_tab, $_type, $base, $description, $direction, $instances, $language, $link, $mediaVersion, $scriptOptions, $title

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JDocumentHtml

Methods summary

Parameters

Since

Overrides

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Methods inherited from JDocument

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Properties inherited from JDocument