ImageDocument
Extends DocumentImageDocument class, provides an easy interface to output image data
since |
3.0.0 |
---|---|
package |
Joomla CMS |
Methods
__construct
Class constructor
__construct(mixed||string|int options = []) :
since |
3.0.0 |
---|
Arguments
- options
array<string|int, mixed>
Associative array of options
Response
mixed
_getLineEnd
Returns the lineEnd
_getLineEnd() :
since |
1.7.0 |
---|
Response
string
_getTab
Returns a string containing the unit for indenting HTML
_getTab() :
since |
1.7.0 |
---|
Response
string
addScript
Adds a linked script to the page
addScript( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager Example: $wa->registerAndUseScript(...); |
Arguments
- url
string
URL 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
Document
instance of $this to allow chaining
addScriptDeclaration
Adds a script to the page
addScriptDeclaration( content, type = 'text/javascript') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager Example: $wa->addInlineScript(...); |
Arguments
- content
string
Script- type
string
Scripting mime (defaults to 'text/javascript')
Response
Document
instance of $this to allow chaining
addScriptOptions
Add option for script
addScriptOptions( key, options, merge = true) : \Joomla\CMS\Document\Document
since |
3.5 |
---|
Arguments
- key
string
Name in Storage- options
mixed
Scrip options as array or string- merge
bool
Whether merge with existing (true) or replace (false)
Response
Document
instance of $this to allow chaining
addStyleDeclaration
Adds a stylesheet declaration to the page
addStyleDeclaration( content, type = 'text/css') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager Example: $wa->addInlineStyle(...); |
Arguments
- content
string
Style declarations- type
string
Type of stylesheet (defaults to 'text/css')
Response
Document
instance of $this to allow chaining
addStyleSheet
Adds a linked stylesheet to the page
addStyleSheet( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager Example: $wa->registerAndUseStyle(...); |
Arguments
- url
string
URL 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
Document
instance of $this to allow chaining
getBase
Return the base URI of the document.
getBase() :
since |
1.7.0 |
---|
Response
string
getBuffer
Get the contents of the document buffer
getBuffer() :
since |
1.7.0 |
---|
Response
mixed
getCharset
Returns the document charset encoding.
getCharset() :
since |
1.7.0 |
---|
Response
string
getDescription
Return the description of the document.
getDescription() :
since |
1.7.0 |
---|
Response
string
getDirection
Returns the document direction declaration.
getDirection() :
since |
1.7.0 |
---|
Response
string
getGenerator
Returns the document generator
getGenerator() :
since |
1.7.0 |
---|
Response
string
getInstance
Returns the global Document object, only creating it if it doesn't already exist.
getInstance( type = 'html', mixed||string|int attributes = []) :
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
string
The document type to instantiate- attributes
array<string|int, mixed>
Array of attributes
Response
static
The document object.
getLanguage
Returns the document language.
getLanguage() :
since |
1.7.0 |
---|
Response
string
getLink
Returns the document base url
getLink() :
since |
1.7.0 |
---|
Response
string
getMediaVersion
Return the media version
getMediaVersion() :
since |
3.2 |
---|
Response
string
getMetaData
Gets a meta tag.
getMetaData( name, attribute = 'name') :
since |
1.7.0 |
---|
Arguments
- name
string
Name of the meta HTML tag- attribute
string
Attribute to use in the meta HTML tag
Response
string
getMimeEncoding
Return the document MIME encoding that is sent to the browser.
getMimeEncoding() :
since |
1.7.0 |
---|
Response
string
getModifiedDate
Returns the document modified date
getModifiedDate() : string|\Joomla\CMS\Date\Date
getPreloadManager
Return the preload manager
getPreloadManager() : \Joomla\CMS\Document\PreloadManagerInterface
getScriptOptions
Get script(s) options
getScriptOptions( key = null) : mixed||string|int
since |
3.5 |
---|
Arguments
- key
string
Name in Storage
Response
array<string|int, mixed>
Options for given $key, or all script options
getTitle
Return the title of the document.
getTitle() :
since |
1.7.0 |
---|
Response
string
getType
Returns the document type
getType() :
since |
1.7.0 |
---|
Response
string
getWebAssetManager
Return WebAsset manager
getWebAssetManager() : \Joomla\CMS\WebAsset\WebAssetManager
loadRenderer
Load a renderer
loadRenderer( type) : \Joomla\CMS\Document\RendererInterface
since |
1.7.0 |
---|---|
throws |
|
Arguments
- type
string
The renderer type
Response
parse
Parses the document and prepares the buffers
parse(mixed||string|int params = []) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- params
array<string|int, mixed>
The array of parameters
Response
Document
instance of $this to allow chaining
preloadAssets
Generate the Link header for assets configured for preloading
preloadAssets() :
since |
4.0.0 |
---|
Response
void
render
Render the document.
render( cache = false, mixed||string|int params = []) :
since |
3.0.0 |
---|
Arguments
- cache
bool
If true, cache the output- params
array<string|int, mixed>
Associative array of attributes
Response
string
The rendered data
setBase
Sets the base URI of the document
setBase( base) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- base
string
The base URI to be set
Response
Document
instance of $this to allow chaining
setBuffer
Set the contents of the document buffer
setBuffer( content, mixed||string|int options = []) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- content
string
The content to be set in the buffer.- options
array<string|int, mixed>
Array of optional elements.
Response
Document
instance of $this to allow chaining
setCharset
Sets the document charset
setCharset( type = 'utf-8') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- type
string
Charset encoding string
Response
Document
instance of $this to allow chaining
setDescription
Sets the description of the document
setDescription( description) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- description
string
The description to set
Response
Document
instance of $this to allow chaining
setDirection
Sets the global document direction declaration. Default is left-to-right (ltr).
setDirection( dir = 'ltr') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- dir
string
The language direction to be set
Response
Document
instance of $this to allow chaining
setFactory
Set the factory instance
setFactory(\Joomla\CMS\Document\FactoryInterface factory) : \Joomla\CMS\Document\Document
setGenerator
Sets the document generator
setGenerator( generator) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- generator
string
The generator to be set
Response
Document
instance of $this to allow chaining
setLanguage
Sets the global document language declaration. Default is English (en-gb).
setLanguage( lang = 'en-gb') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- lang
string
The language to be set
Response
Document
instance of $this to allow chaining
setLineEnd
Sets the line end style to Windows, Mac, Unix or a custom string.
setLineEnd( style) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- style
string
"win", "mac", "unix" or custom string.
Response
Document
instance of $this to allow chaining
setLink
Sets the document link
setLink( url) : \Joomla\CMS\Document\Document
setMediaVersion
Set the assets version
setMediaVersion( mediaVersion) : \Joomla\CMS\Document\Document
since |
3.2 |
---|
Arguments
- mediaVersion
string
Media version to use
Response
Document
instance of $this to allow chaining
setMetaData
Sets or alters a meta tag.
setMetaData( name, content, attribute = 'name') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- name
string
Name of the meta HTML tag- content
mixed
Value of the meta HTML tag as array or string- attribute
string
Attribute to use in the meta HTML tag
Response
Document
instance of $this to allow chaining
setMimeEncoding
Sets the document MIME encoding that is sent to the browser.
setMimeEncoding( type = 'text/html', sync = true) : \Joomla\CMS\Document\Document
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
string
The document type to be sent- sync
bool
Should the type be synced with HTML?
Response
Document
instance of $this to allow chaining
setModifiedDate
Sets the document modified date
setModifiedDate(string|\Joomla\CMS\Date\Date date) : \Joomla\CMS\Document\Document
setPreloadManager
Set the preload manager
setPreloadManager(\Joomla\CMS\Document\PreloadManagerInterface preloadManager) : \Joomla\CMS\Document\Document
since |
4.0.0 |
---|
Arguments
- preloadManager
PreloadManagerInterface
The preload manager service
Response
Document
instance of $this to allow chaining
setTab
Sets the string used to indent HTML
setTab( string) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- string
string
String used to indent ("\11", "\t", ' ', etc.).
Response
Document
instance of $this to allow chaining
setTitle
Sets the title of the document
setTitle( title) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- title
string
The title to be set
Response
Document
instance of $this to allow chaining
setType
Set the document type
setType( type) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- type
string
Type document is to set to
Response
Document
instance of $this to allow chaining
setWebAssetManager
Set WebAsset manager
setWebAssetManager(\Joomla\CMS\WebAsset\WebAssetManager webAsset) : \Joomla\CMS\Document\Document
Properties
title
Document title
since |
1.7.0 |
---|
Type(s)
string
description
Document description
since |
1.7.0 |
---|
Type(s)
string
link
Document full URL
since |
1.7.0 |
---|
Type(s)
string
base
Document base URL
since |
1.7.0 |
---|
Type(s)
string
language
Contains the document language setting
since |
1.7.0 |
---|
Type(s)
string
direction
Contains the document direction setting
since |
1.7.0 |
---|
Type(s)
string
_generator
Document generator
since |
1.7.0 |
---|
Type(s)
string
_tab
Tab string
since |
1.7.0 |
---|
Type(s)
string
_lineEnd
Contains the line end string
since |
1.7.0 |
---|
Type(s)
string
_charset
Contains the character encoding string
since |
1.7.0 |
---|
Type(s)
string
_mime
Document mime type
since |
1.7.0 |
---|
Type(s)
string
_namespace
Document namespace
since |
1.7.0 |
---|
Type(s)
string
_profile
Document profile
since |
1.7.0 |
---|
Type(s)
string
_scripts
Array of linked scripts
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager |
Type(s)
array<string|int, mixed>
_script
Array of scripts placed in the header
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager |
Type(s)
array<string|int, mixed>
scriptOptions
Array of scripts options
Type(s)
array<string|int, mixed>
_styleSheets
Array of linked style sheets
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager |
Type(s)
array<string|int, mixed>
_style
Array of included style declarations
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use WebAssetManager |
Type(s)
array<string|int, mixed>
_metaTags
Array of meta tags
since |
1.7.0 |
---|
Type(s)
array<string|int, mixed>
_engine
The rendering engine
since |
1.7.0 |
---|
Type(s)
object
_type
The document type
since |
1.7.0 |
---|
Type(s)
string
_buffer
Array of buffered output
since |
1.7.0 |
---|
Type(s)
mixed
instances
Document instances container.
since |
1.7.3 |
---|
Type(s)
array<string|int, mixed>
mediaVersion
Media version added to assets
since |
3.2 |
---|
Type(s)
string
preloadTypes
The supported preload types
since |
4.0.0 |
---|
Type(s)
array<string|int, mixed>