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

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

Adds a FeedItem to the feed.

addItem(\Joomla\CMS\Document\Feed\FeedItem item) : \Joomla\CMS\Document\FeedDocument

since	1.7.0

Arguments

item: FeedItemThe feeditem to add to the feed.

Response

FeedDocumentinstance 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 6.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 6.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 6.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 6.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

Return the base URI of the document.

getBase() :

inherited

since	1.7.0

Response

string

Get the contents of the document buffer

getBuffer() :

inherited

since	1.7.0

Response

mixed

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

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

Load a renderer

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

inherited

since	1.7.0
throws	`RuntimeException`

Arguments

type: stringThe renderer type

Response

RendererInterface

Parses the document and prepares the buffers

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

inherited

since	1.7.0

Arguments

params: array<string|int, mixed>The array of parameters

Response

Documentinstance of $this to allow chaining

Generate the Link header for assets configured for preloading

preloadAssets() :

inherited

since	4.0.0

Response

void

Render the document

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

since	1.7.0
throws	`Exception`
todo	Make this cacheable

Arguments

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

Response

stringThe rendered data

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 of the document buffer

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

inherited

since	1.7.0

Arguments

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

Response

Documentinstance of $this to allow chaining

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

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

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 6.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 6.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 6.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 6.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

Syndication URL feed element

optional

since	1.7.0

Type(s)

string

Image feed element

optional

since	1.7.0

Type(s)

FeedImage

Copyright feed element

optional

since	1.7.0

Type(s)

string

Published date feed element

optional

since	1.7.0

Type(s)

string

Lastbuild date feed element

since	1.7.0

Type(s)

Date

Editor feed element

optional

since	1.7.0

Type(s)

string

Docs feed element

since	1.7.0

Type(s)

string

Editor email feed element

optional

since	1.7.0

Type(s)

string

Webmaster email feed element

optional

since	1.7.0

Type(s)

string

Category feed element

optional

since	1.7.0

Type(s)

string

TTL feed attribute

optional

since	1.7.0

Type(s)

string

Rating feed element

optional

since	1.7.0

Type(s)

string

Skiphours feed element

optional

since	1.7.0

Type(s)

string

Skipdays feed element

optional

since	1.7.0

Type(s)

string

The feed items collection

since	1.7.0

Type(s)

array<string|int, FeedItem>

since	1.7.0
package	Joomla CMS

FeedDocument

Methods

__construct

Arguments

Response

_getLineEnd

Response

_getTab

Response

addItem

Arguments

Response

addScript

Arguments

Response

addScriptDeclaration

Arguments

Response

addScriptOptions

Arguments

Response

addStyleDeclaration

Arguments

Response

addStyleSheet

Arguments

Response

getBase

Response

getBuffer

Response

getCharset

Response

getDescription

Response

getDirection

Response

getGenerator

Response

getInstance

Arguments

Response

getLanguage

Response

getLink

Response

getMediaVersion

Response

getMetaData

Arguments

Response

getMimeEncoding

Response

getModifiedDate

Response

getPreloadManager

Response

getScriptOptions

Arguments

Response

getTitle

Response

getType

Response

getWebAssetManager

Response

loadRenderer

Arguments

Response

parse

Arguments

Response

preloadAssets

Response

render

Arguments

Response

setBase

Arguments

Response