Joomla! API

Class constructor

__construct(mixed||string|int options = []) :

since	1.7.0

Arguments

options: array<string|int, mixed>Associative array of options

Response

mixed

Fetch the template, and initialise the params

_fetchTemplate(mixed||string|int params = []) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

params: array<string|int, mixed>Parameters to determine the template

Response

HtmlDocumentinstance of $this to allow chaining

Returns the lineEnd

_getLineEnd() :

inherited

since	1.7.0

Response

string

Returns a string containing the unit for indenting HTML

_getTab() :

inherited

since	1.7.0

Response

string

Load a template file

_loadTemplate( directory,  filename) :

since	1.7.0

Arguments

directory: stringThe name of the template
filename: stringThe actual filename

Response

stringThe contents of the template

Parse a document template

_parseTemplate() : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Response

HtmlDocumentinstance of $this to allow chaining

Render pre-parsed template

_renderTemplate() :

since	1.7.0

Response

stringrendered template

Adds a custom HTML string to the head block

addCustomTag( html) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

html: stringThe HTML to add to the head

Response

HtmlDocumentinstance of $this to allow chaining

Adds a shortcut icon (favicon)

addFavicon( href,  type = 'image/vnd.microsoft.icon',  relation = 'icon') : \Joomla\CMS\Document\HtmlDocument

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.

since	1.7.0

Arguments

href: stringThe link that is being related.
type: stringFile type
relation: stringRelation of link

Response

HtmlDocumentinstance of $this to allow chaining

Adds <link> tags to the head of the document

addHeadLink( href,  relation,  relType = 'rel', mixed||string|int attribs = []) : \Joomla\CMS\Document\HtmlDocument

$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">

since	1.7.0

Arguments

href: stringThe link that is being related.
relation: stringRelation of link.
relType: stringRelation type attribute. Either rel or rev (default: 'rel').
attribs: array<string|int, mixed>Associative array of remaining attributes.

Response

HtmlDocumentinstance of $this to allow chaining

Adds a linked script to the page

addScript( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager Example: $wa->registerAndUseScript(...);

Arguments

url: stringURL to the linked script.
options: array<string|int, mixed>Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
attribs: array<string|int, mixed>Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

Response

Documentinstance of $this to allow chaining

Adds a script to the page

addScriptDeclaration( content,  type = 'text/javascript') : \Joomla\CMS\Document\Document

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager Example: $wa->addInlineScript(...);

Arguments

content: stringScript
type: stringScripting mime (defaults to 'text/javascript')

Response

Documentinstance of $this to allow chaining

Add option for script

addScriptOptions( key,  options,  merge = true) : \Joomla\CMS\Document\Document

inherited

since	3.5

Arguments

key: stringName in Storage
options: mixedScrip options as array or string
merge: boolWhether merge with existing (true) or replace (false)

Response

Documentinstance of $this to allow chaining

Adds a stylesheet declaration to the page

addStyleDeclaration( content,  type = 'text/css') : \Joomla\CMS\Document\Document

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager Example: $wa->addInlineStyle(...);

Arguments

content: stringStyle declarations
type: stringType of stylesheet (defaults to 'text/css')

Response

Documentinstance of $this to allow chaining

Adds a linked stylesheet to the page

addStyleSheet( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager Example: $wa->registerAndUseStyle(...);

Arguments

url: stringURL to the linked style sheet
options: array<string|int, mixed>Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
attribs: array<string|int, mixed>Array of attributes. Example: array('id' => 'stylesheet', 'data-test' => 1)

Response

Documentinstance of $this to allow chaining

Count the number of child menu items of the current active menu item

countMenuChildren() :

deprecated

since	1.7.0
deprecated	4.4 will be removed in 6.0 Load the active menu item directly and count the children with the php count function `$children = count($app->getMenu()->getActive()->getChildren())` beware getActive could be `null`

Response

intNumber of child menu items

Count the modules in the given position

countModules( positionName,  withContentOnly = false) :

since	1.7.0

Arguments

positionName: stringThe position to use
withContentOnly: boolCount only a modules which actually has a content

Response

intNumber of modules found

Return the base URI of the document.

getBase() :

inherited

since	1.7.0

Response

string

Get the contents of a document include

getBuffer( type = null,  name = null, mixed||string|int attribs = []) : mixed|string

since	1.7.0

Arguments

type: stringThe type of renderer
name: stringThe name of the element to render
attribs: array<string|int, mixed>Associative array of remaining attributes.

Response

mixed|stringThe output of the renderer

Get the CacheControllerFactoryInterface.

getCacheControllerFactory() : \Joomla\CMS\Cache\CacheControllerFactoryInterface

inherited

since	4.2.0

Response

CacheControllerFactoryInterface

Returns the document charset encoding.

getCharset() :

inherited

since	1.7.0

Response

string

Return the description of the document.

getDescription() :

inherited

since	1.7.0

Response

string

Returns the document direction declaration.

getDirection() :

inherited

since	1.7.0

Response

string

Returns the document generator

getGenerator() :

inherited

since	1.7.0

Response

string

Get the HTML document head data

getHeadData() : mixed||string|int

since	1.7.0

Response

array<string|int, mixed>The document head data in array form

Returns the global Document object, only creating it if it doesn't already exist.

getInstance( type = 'html', mixed||string|int attributes = []) :

inherited static deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Use the \Joomla\CMS\Document\FactoryInterface instead Example: Factory::getApplication()->getDocument();

Arguments

type: stringThe document type to instantiate
attributes: array<string|int, mixed>Array of attributes

Response

staticThe document object.

Returns the document language.

getLanguage() :

inherited

since	1.7.0

Response

string

Returns the document base url

getLink() :

inherited

since	1.7.0

Response

string

Return the media version

getMediaVersion() :

inherited

since	3.2

Response

string

Gets a meta tag.

getMetaData( name,  attribute = 'name') :

inherited

since	1.7.0

Arguments

name: stringName of the meta HTML tag
attribute: stringAttribute to use in the meta HTML tag

Response

string

Return the document MIME encoding that is sent to the browser.

getMimeEncoding() :

inherited

since	1.7.0

Response

string

Returns the document modified date

getModifiedDate() : string|\Joomla\CMS\Date\Date

inherited

since	1.7.0

Response

string|Date

Return the preload manager

getPreloadManager() : \Joomla\CMS\Document\PreloadManagerInterface

inherited

since	4.0.0

Response

PreloadManagerInterface

Get script(s) options

getScriptOptions( key = null) : mixed||string|int

inherited

since	3.5

Arguments

key: stringName in Storage

Response

array<string|int, mixed>Options for given $key, or all script options

Return the title of the document.

getTitle() :

inherited

since	1.7.0

Response

string

Returns a toolbar object or null

getToolbar( toolbar = 'toolbar',  create = true) : \Joomla\CMS\Toolbar\Toolbar

since	5.0.0

Arguments

toolbar: string
create: bool

Response

Toolbar|null

Returns the toolbar array

getToolbars() : mixed||string|int

since	5.0.0

Response

array<string|int, mixed>

Returns the document type

getType() :

inherited

since	1.7.0

Response

string

Return WebAsset manager

getWebAssetManager() : \Joomla\CMS\WebAsset\WebAssetManager

inherited

since	4.0.0

Response

WebAssetManager

Returns whether the document is set up to be output as HTML5

isHtml5() :

since	3.0.0

Response

booltrue when HTML5 is used

Load a renderer

loadRenderer( type) : \Joomla\CMS\Document\RendererInterface

inherited

since	1.7.0
throws	`RuntimeException`

Arguments

type: stringThe renderer type

Response

RendererInterface

Merge the HTML document head data

mergeHeadData(mixed||string|int data) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

data: array<string|int, mixed>The document head data in array form

Response

HtmlDocumentinstance of $this to allow chaining

Parses the template and populates the buffer

parse(mixed||string|int params = []) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

params: array<string|int, mixed>Parameters for fetching the template

Response

HtmlDocumentinstance of $this to allow chaining

Generate the Link header for assets configured for preloading

preloadAssets() :

inherited

since	4.0.0

Response

void

Outputs the template to the browser.

render( caching = false, mixed||string|int params = []) :

since	1.7.0

Arguments

caching: boolIf true, cache the output
params: array<string|int, mixed>Associative array of attributes

Response

stringThe rendered data

Reset the HTML document head data

resetHeadData( types = null) : \Joomla\CMS\Document\HtmlDocument

since	3.7.0

Arguments

types: mixedtype or types of the heads elements to reset

Response

HtmlDocumentinstance of $this to allow chaining

Reset a part the HTML document head data

resetHeadDatum( type) :

since	3.7.0

Arguments

type: stringtype of the heads elements to reset

Response

void

Sets the base URI of the document

setBase( base) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

base: stringThe base URI to be set

Response

Documentinstance of $this to allow chaining

Set the contents a document includes

setBuffer( content, mixed||string|int options = []) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

content: stringThe content to be set in the buffer.
options: array<string|int, mixed>Array of optional elements.

Response

HtmlDocumentinstance of $this to allow chaining

Set the cache controller factory to use.

setCacheControllerFactory(\Joomla\CMS\Cache\CacheControllerFactoryInterface cacheControllerFactory = null) :

inherited

since	4.2.0

Arguments

cacheControllerFactory: CacheControllerFactoryInterface|nullThe cache controller factory to use.

Response

void

Sets the document charset

setCharset( type = 'utf-8') : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

type: stringCharset encoding string

Response

Documentinstance of $this to allow chaining

Sets the description of the document

setDescription( description) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

description: stringThe description to set

Response

Documentinstance of $this to allow chaining

Sets the global document direction declaration. Default is left-to-right (ltr).

setDirection( dir = 'ltr') : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

dir: stringThe language direction to be set

Response

Documentinstance of $this to allow chaining

Set the factory instance

setFactory(\Joomla\CMS\Document\FactoryInterface factory) : \Joomla\CMS\Document\Document

inherited

since	4.0.0

Arguments

factory: FactoryInterfaceThe factory instance

Response

Document

Sets the document generator

setGenerator( generator) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

generator: stringThe generator to be set

Response

Documentinstance of $this to allow chaining

Set the HTML document head data

setHeadData(mixed||string|int data) : \Joomla\CMS\Document\HtmlDocument|null

since	1.7.0

Arguments

data: array<string|int, mixed>The document head data in array form

Response

HtmlDocument|nullinstance of $this to allow chaining or null for empty input data

Sets whether the document should be output as HTML5

setHtml5( state) :

since	3.0.0

Arguments

state: boolTrue when HTML5 should be output

Response

void

Sets the global document language declaration. Default is English (en-gb).

setLanguage( lang = 'en-gb') : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

lang: stringThe language to be set

Response

Documentinstance of $this to allow chaining

Sets the line end style to Windows, Mac, Unix or a custom string.

setLineEnd( style) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

style: string"win", "mac", "unix" or custom string.

Response

Documentinstance of $this to allow chaining

Sets the document link

setLink( url) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

url: stringA url

Response

Documentinstance of $this to allow chaining

Set the assets version

setMediaVersion( mediaVersion) : \Joomla\CMS\Document\Document

inherited

since	3.2

Arguments

mediaVersion: stringMedia version to use

Response

Documentinstance of $this to allow chaining

Sets or alters a meta tag.

setMetaData( name,  content,  attribute = 'name') : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

name: stringName of the meta HTML tag
content: mixedValue of the meta HTML tag as array or string
attribute: stringAttribute to use in the meta HTML tag

Response

Documentinstance of $this to allow chaining

Sets the document MIME encoding that is sent to the browser.

setMimeEncoding( type = 'text/html',  sync = true) : \Joomla\CMS\Document\Document

inherited

This usually will be text/html because most browsers cannot yet accept the proper mime settings for XHTML: application/xhtml+xml and to a lesser extent application/xml and text/xml. See the W3C note ({@link https://www.w3.org/TR/xhtml-media-types/}) for more details.

since	1.7.0
link

Arguments

type: stringThe document type to be sent
sync: boolShould the type be synced with HTML?

Response

Documentinstance of $this to allow chaining

Sets the document modified date

setModifiedDate(string|\Joomla\CMS\Date\Date date) : \Joomla\CMS\Document\Document

inherited

since	1.7.0
throws	`InvalidArgumentException`

Arguments

date: string|DateThe date to be set

Response

Documentinstance of $this to allow chaining

Set the preload manager

setPreloadManager(\Joomla\CMS\Document\PreloadManagerInterface preloadManager) : \Joomla\CMS\Document\Document

inherited

since	4.0.0

Arguments

preloadManager: PreloadManagerInterfaceThe preload manager service

Response

Documentinstance of $this to allow chaining

Sets the string used to indent HTML

setTab( string) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

string: stringString used to indent ("\11", "\t", ' ', etc.).

Response

Documentinstance of $this to allow chaining

Sets the title of the document

setTitle( title) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

title: stringThe title to be set

Response

Documentinstance of $this to allow chaining

Adds a new or replace an existing toolbar object

setToolbar( name, \Joomla\CMS\Toolbar\Toolbar toolbar) :

since	5.0.0

Arguments

name: string
toolbar: Toolbar

Response

$this

Set the document type

setType( type) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

type: stringType document is to set to

Response

Documentinstance of $this to allow chaining

Set WebAsset manager

setWebAssetManager(\Joomla\CMS\WebAsset\WebAssetManager webAsset) : \Joomla\CMS\Document\Document

inherited

since	4.0.0

Arguments

webAsset: WebAssetManagerThe WebAsset instance

Response

Document

Document title

inherited

since	1.7.0

Type(s)

string

Document description

inherited

since	1.7.0

Type(s)

string

Document full URL

inherited

since	1.7.0

Type(s)

string

Document base URL

inherited

since	1.7.0

Type(s)

string

Contains the document language setting

inherited

since	1.7.0

Type(s)

string

Contains the document direction setting

inherited

since	1.7.0

Type(s)

string

Document generator

inherited

since	1.7.0

Type(s)

string

Document modified date

inherited

since	1.7.0

Type(s)

string|Date

Tab string

inherited

since	1.7.0

Type(s)

string

Contains the line end string

inherited

since	1.7.0

Type(s)

string

Contains the character encoding string

inherited

since	1.7.0

Type(s)

string

Document mime type

inherited

since	1.7.0

Type(s)

string

Document namespace

inherited

since	1.7.0

Type(s)

string

Document profile

inherited

since	1.7.0

Type(s)

string

Array of linked scripts

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager

Type(s)

array<string|int, mixed>

Array of scripts placed in the header

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager

Type(s)

array<string|int, mixed>

Array of scripts options

inherited

Type(s)

array<string|int, mixed>

Array of linked style sheets

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager

Type(s)

array<string|int, mixed>

Array of included style declarations

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 7.0 Use WebAssetManager

Type(s)

array<string|int, mixed>

Array of meta tags

inherited

since	1.7.0

Type(s)

array<string|int, mixed>

The rendering engine

inherited

since	1.7.0

Type(s)

object

The document type

inherited

since	1.7.0

Type(s)

string

Array of buffered output

inherited static

since	1.7.0

Type(s)

mixed

Document instances container.

inherited static

since	1.7.3

Type(s)

array<string|int, mixed>

Media version added to assets

inherited

since	3.2

Type(s)

string

Factory for creating JDocument API objects

inherited

since	4.0.0

Type(s)

FactoryInterface

Preload manager

inherited

since	4.0.0

Type(s)

PreloadManagerInterface

The supported preload types

inherited

since	4.0.0

Type(s)

array<string|int, mixed>

Web Asset instance

inherited

since	4.0.0

Type(s)

WebAssetManager

CacheControllerFactoryInterface

inherited

since	4.2.0

Type(s)

CacheControllerFactoryInterface

Array of Header <link> tags

since	1.7.0

Type(s)

array<string|int, mixed>

Array of custom tags

since	1.7.0

Type(s)

array<string|int, mixed>

Name of the template

since	1.7.0

Type(s)

string

Base url

since	1.7.0

Type(s)

string

Registry of template parameters

since	1.7.0

Type(s)

Registry

File name

since	1.7.0

Type(s)

array<string|int, mixed>

Script nonce (string if set, null otherwise)

since	4.0.0

Type(s)

string|null

String holding parsed template

since	1.7.0

Type(s)

string

Array of parsed template JDoc tags

since	1.7.0

Type(s)

array<string|int, mixed>

Integer with caching setting

since	1.7.0

Type(s)

int

Set to true when the document should be output as HTML5

since	4.0.0

Type(s)

bool

List of type \Joomla\CMS\Toolbar\Toolbar

since	5.0.0

Type(s)

array<string|int, Toolbar>

since	1.7.0
package	Joomla CMS

HtmlDocument

Methods

__construct

Arguments

Response

_fetchTemplate

Arguments

Response

_getLineEnd

Response

_getTab

Response

_loadTemplate

Arguments

Response

_parseTemplate

Response

_renderTemplate

Response

addCustomTag

Arguments

Response

addFavicon

Arguments

Response

addHeadLink

Arguments

Response

addScript

Arguments

Response

addScriptDeclaration

Arguments

Response

addScriptOptions

Arguments

Response

addStyleDeclaration

Arguments

Response

addStyleSheet

Arguments

Response

countMenuChildren

Response

countModules

Arguments

Response

getBase

Response

getBuffer

Arguments

Response

getCacheControllerFactory

Response

getCharset

Response

getDescription

Response

getDirection

Response

getGenerator

Response

getHeadData

Response

getInstance

Arguments

Response

getLanguage

Response

getLink

Response

getMediaVersion

Response

getMetaData

Arguments

Response

getMimeEncoding

Response

getModifiedDate