Joomla! API

Class constructor.

__construct(array options = []) : mixed

inherited

since	1.7.0

Arguments

options: arrayAssociative array of options

Response

mixed

Fetch the template, and initialise the params

_fetchTemplate(array params = []) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

params: arrayParameters to determine the template

Response

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Returns the lineEnd

_getLineEnd() : string

inherited

since	1.7.0

Response

string

Returns a string containing the unit for indenting HTML

_getTab() : string

inherited

since	1.7.0

Response

string

Load a template file

_loadTemplate(string directory, string filename) : string

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

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Render pre-parsed template

_renderTemplate() : string

since	1.7.0

Response

stringrendered template

Adds a custom HTML string to the head block

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

since	1.7.0

Arguments

html: stringThe HTML to add to the head

Response

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Adds a shortcut icon (favicon)

addFavicon(string href, string type = 'image/vnd.microsoft.icon', string 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

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Adds <link> tags to the head of the document

addHeadLink(string href, string relation, string relType = 'rel', array 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: arrayAssociative array of remaining attributes.

Response

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Adds a linked script to the page

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

inherited deprecated

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

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Adds a script to the page

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

inherited deprecated

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

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Add option for script

addScriptOptions(string key, mixed options, bool 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

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Adds a stylesheet declaration to the page

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

inherited deprecated

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

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Adds a linked stylesheet to the page

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

inherited deprecated

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

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

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

countMenuChildren() : int

since	1.7.0

Response

intNumber of child menu items

Count the modules in the given position

countModules(string positionName, bool withContentOnly = false) : int

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() : string

inherited

since	1.7.0

Response

string

Get the contents of the document buffer

getBuffer() : mixed

inherited

since	1.7.0

Response

mixed

Get the CacheControllerFactoryInterface.

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

inherited

since	4.2.0

Response

\Joomla\CMS\Cache\CacheControllerFactoryInterface

Returns the document charset encoding.

getCharset() : string

inherited

since	1.7.0

Response

string

Return the description of the document.

getDescription() : string

inherited

since	1.7.0

Response

string

Returns the document direction declaration.

getDirection() : string

inherited

since	1.7.0

Response

string

Returns the document generator

getGenerator() : string

inherited

since	1.7.0

Response

string

Get the HTML document head data

getHeadData() : array

since	1.7.0

Response

arrayThe document head data in array form

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

getInstance(string type = 'html', array attributes = []) : static

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: arrayArray of attributes

Response

staticThe document object.

Returns the document language.

getLanguage() : string

inherited

since	1.7.0

Response

string

Returns the document base url

getLink() : string

inherited

since	1.7.0

Response

string

Return the media version

getMediaVersion() : string

inherited

since	3.2

Response

string

Gets a meta tag.

getMetaData(string name, string attribute = 'name') : string

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() : string

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|\Joomla\CMS\Date\Date

Return the preload manager

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

inherited

since	4.0.0

Response

\Joomla\CMS\Document\PreloadManagerInterface

Get script(s) options

getScriptOptions(string key = null) : array

inherited

since	3.5

Arguments

key: stringName in Storage

Response

arrayOptions for given $key, or all script options

Return the title of the document.

getTitle() : string

inherited

since	1.7.0

Response

string

Returns the document type

getType() : string

inherited

since	1.7.0

Response

string

Return WebAsset manager

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

inherited

since	4.0.0

Response

\Joomla\CMS\WebAsset\WebAssetManager

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

isHtml5() : bool

since	3.0.0

Response

booltrue when HTML5 is used

Load a renderer

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

inherited

since	1.7.0
throws	`\RuntimeException`

Arguments

type: stringThe renderer type

Response

\Joomla\CMS\Document\RendererInterface

Merge the HTML document head data

mergeHeadData(array data) : \Joomla\CMS\Document\HtmlDocument

since	1.7.0

Arguments

data: arrayThe document head data in array form

Response

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Parses the document and prepares the buffers

parse(array params = []) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

params: arrayThe array of parameters

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Generate the Link header for assets configured for preloading

preloadAssets() : void

inherited

since	4.0.0

Outputs the document

render(bool cache = false, array params = []) : string

inherited

since	1.7.0

Arguments

cache: boolIf true, cache the output
params: arrayAssociative array of attributes

Response

stringThe rendered data

Reset the HTML document head data

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

since	3.7.0

Arguments

types: mixedtype or types of the heads elements to reset

Response

\Joomla\CMS\Document\HtmlDocumentinstance of $this to allow chaining

Reset a part the HTML document head data

resetHeadDatum(string type) : void

since	3.7.0

Arguments

type: stringtype of the heads elements to reset

Sets the base URI of the document

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

inherited

since	1.7.0

Arguments

base: stringThe base URI to be set

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Set the contents of the document buffer

setBuffer(string content, array options = []) : \Joomla\CMS\Document\Document

inherited

since	1.7.0

Arguments

content: stringThe content to be set in the buffer.
options: arrayArray of optional elements.

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Set the cache controller factory to use.

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

inherited

since	4.2.0

Arguments

cacheControllerFactory: \Joomla\CMS\Cache\CacheControllerFactoryInterfaceThe cache controller factory to use.

Sets the document charset

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

inherited

since	1.7.0

Arguments

type: stringCharset encoding string

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Sets the description of the document

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

inherited

since	1.7.0

Arguments

description: stringThe description to set

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

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

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

inherited

since	1.7.0

Arguments

dir: stringThe language direction to be set

Response

\Joomla\CMS\Document\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: \Joomla\CMS\Document\FactoryInterfaceThe factory instance

Response

\Joomla\CMS\Document\Document

Sets the document generator

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

inherited

since	1.7.0

Arguments

generator: stringThe generator to be set

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Set the HTML document head data

setHeadData(array data) : \Joomla\CMS\Document\HtmlDocument|null

since	1.7.0

Arguments

data: arrayThe document head data in array form

Response

\Joomla\CMS\Document\HtmlDocument|nullinstance of $this to allow chaining or null for empty input data

Sets whether the document should be output as HTML5

setHtml5(bool state) : void

since	3.0.0

Arguments

state: boolTrue when HTML5 should be output

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

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

inherited

since	1.7.0

Arguments

lang: stringThe language to be set

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

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

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

inherited

since	1.7.0

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Sets the document link

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

inherited

since	1.7.0

Arguments

url: stringA url

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Set the assets version

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

inherited

since	3.2

Arguments

mediaVersion: stringMedia version to use

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Sets or alters a meta tag.

setMetaData(string name, mixed content, string 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

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

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

setMimeEncoding(string type = 'text/html', bool 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

\Joomla\CMS\Document\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|\Joomla\CMS\Date\DateThe date to be set

Response

\Joomla\CMS\Document\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: \Joomla\CMS\Document\PreloadManagerInterfaceThe preload manager service

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Sets the string used to indent HTML

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

inherited

since	1.7.0

Arguments

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

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Sets the title of the document

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

inherited

since	1.7.0

Arguments

title: stringThe title to be set

Response

\Joomla\CMS\Document\Documentinstance of $this to allow chaining

Set the document type

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

inherited

since	1.7.0

Arguments

type: stringType document is to set to

Response

\Joomla\CMS\Document\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: \Joomla\CMS\WebAsset\WebAssetManagerThe WebAsset instance

Response

\Joomla\CMS\Document\Document

Array of Header <link> tags

since	1.7.0

Type(s)

array

Array of custom tags

since	1.7.0

Type(s)

array

Name of the template

since	1.7.0

Type(s)

string

Base url

since	1.7.0

Type(s)

string

Array of template parameters

since	1.7.0

Type(s)

array

File name

since	1.7.0

Type(s)

array

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

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

CacheControllerFactoryInterface

inherited

since	4.2.0

Type(s)

\Joomla\CMS\Cache\CacheControllerFactoryInterface

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|\Joomla\CMS\Date\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 6.0 Use WebAssetManager

Type(s)

array

Array of scripts placed in the header

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Use WebAssetManager

Type(s)

array

Array of scripts options

inherited

Type(s)

array

Array of linked style sheets

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Use WebAssetManager

Type(s)

array

Array of included style declarations

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Use WebAssetManager

Type(s)

array

Array of meta tags

inherited

since	1.7.0

Type(s)

array

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

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)

\Joomla\CMS\Document\FactoryInterface

Preload manager

inherited

since	4.0.0

Type(s)

\Joomla\CMS\Document\PreloadManagerInterface

The supported preload types

inherited

since	4.0.0

Type(s)

array

Web Asset instance

inherited

since	4.0.0

Type(s)

\Joomla\CMS\WebAsset\WebAssetManager

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

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

Response