Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres publiques statiques | Champs de données | Attributs publics statiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe Document
+ Graphe d'héritage de Document:

Fonctions membres publiques

 __construct ($options=array())
 
 setFactory (FactoryInterface $factory)
 
 setType ($type)
 
 getType ()
 
 getBuffer ()
 
 setBuffer ($content, $options=array())
 
 getMetaData ($name, $attribute='name')
 
 setMetaData ($name, $content, $attribute='name')
 
 addScript ($url, $options=array(), $attribs=array())
 
 addScriptDeclaration ($content, $type='text/javascript')
 
 addScriptOptions ($key, $options, $merge=true)
 
 getScriptOptions ($key=null)
 
 addStyleSheet ($url, $options=array(), $attribs=array())
 
 addStyleDeclaration ($content, $type='text/css')
 
 setCharset ($type='utf-8')
 
 getCharset ()
 
 setLanguage ($lang='en-gb')
 
 getLanguage ()
 
 setDirection ($dir='ltr')
 
 getDirection ()
 
 setTitle ($title)
 
 getTitle ()
 
 setMediaVersion ($mediaVersion)
 
 getMediaVersion ()
 
 setPreloadManager (PreloadManagerInterface $preloadManager)
 
 getPreloadManager ()
 
 setWebAssetManager (WebAssetManager $webAsset)
 
 getWebAssetManager ()
 
 setBase ($base)
 
 getBase ()
 
 setDescription ($description)
 
 getDescription ()
 
 setLink ($url)
 
 getLink ()
 
 setGenerator ($generator)
 
 getGenerator ()
 
 setModifiedDate ($date)
 
 getModifiedDate ()
 
 setMimeEncoding ($type='text/html', $sync=true)
 
 getMimeEncoding ()
 
 setLineEnd ($style)
 
 _getLineEnd ()
 
 setTab ($string)
 
 _getTab ()
 
 loadRenderer ($type)
 
 parse ($params=array())
 
 render ($cache=false, $params=array())
 

Fonctions membres publiques statiques

static getInstance ($type='html', $attributes=array())
 

Champs de données

 $title = ''
 
 $description = ''
 
 $link = ''
 
 $base = ''
 
 $language = 'en-gb'
 
 $direction = 'ltr'
 
 $_generator = 'Joomla! - Open Source Content Management'
 
 $_mdate = ''
 
 $_tab = "\11"
 
 $_lineEnd = "\12"
 
 $_charset = 'utf-8'
 
 $_mime = ''
 
 $_namespace = ''
 
 $_profile = ''
 
 $_scripts = array()
 
 $_script = array()
 
 $_styleSheets = array()
 
 $_style = array()
 
 $_metaTags = array()
 
 $_engine = null
 
 $_type = null
 

Attributs publics statiques

static $_buffer = null
 

Fonctions membres protégées

 preloadAssets ()
 

Attributs protégés

 $scriptOptions = array()
 
 $mediaVersion = null
 
 $factory
 
 $preloadManager = null
 
 $preloadTypes = ['preload', 'dns-prefetch', 'preconnect', 'prefetch', 'prerender']
 
 $webAssetManager = null
 

Attributs protégés statiques

static $instances = array()
 

Description détaillée

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

Depuis
1.7.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Class constructor.

Paramètres
array$optionsAssociative array of options
Depuis
1.7.0

Références $options, Document\$webAssetManager, Factory\getContainer(), Document\setBase(), Document\setCharset(), Document\setDirection(), Document\setFactory(), Document\setLanguage(), Document\setLineEnd(), Document\setLink(), Document\setMediaVersion(), Document\setPreloadManager(), Document\setTab(), et Document\setWebAssetManager().

Documentation des fonctions membres

◆ _getLineEnd()

_getLineEnd ( )

Returns the lineEnd

Renvoie
string
Depuis
1.7.0

Références Document\$_lineEnd.

◆ _getTab()

_getTab ( )

Returns a string containing the unit for indenting HTML

Renvoie
string
Depuis
1.7.0

Références Document\$_tab.

◆ addScript()

addScript (   $url,
  $options = array(),
  $attribs = array() 
)

Adds a linked script to the page

Paramètres
string$urlURL to the linked script.
array$optionsArray of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
array$attribsArray of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0
Obsolète:
5.0 Use WebAssetManager

Références $attribs, $options, $this, et $url.

◆ addScriptDeclaration()

addScriptDeclaration (   $content,
  $type = 'text/javascript' 
)

Adds a script to the page

Paramètres
string$contentScript
string$typeScripting mime (defaults to 'text/javascript')
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0
Obsolète:
5.0 Use WebAssetManager

Références $content, $this, et $type.

Référencé par HtmlDocument\mergeHeadData().

◆ addScriptOptions()

addScriptOptions (   $key,
  $options,
  $merge = true 
)

Add option for script

Paramètres
string$keyName in Storage
mixed$optionsScrip options as array or string
bool$mergeWhether merge with existing (true) or replace (false)
Renvoie
Document instance of $this to allow chaining
Depuis
3.5

Références $key, $options, et $this.

Référencé par HtmlDocument\mergeHeadData().

◆ addStyleDeclaration()

addStyleDeclaration (   $content,
  $type = 'text/css' 
)

Adds a stylesheet declaration to the page

Paramètres
string$contentStyle declarations
string$typeType of stylesheet (defaults to 'text/css')
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0
Obsolète:
5.0 Use WebAssetManager

Références $content, $this, et $type.

Référencé par HtmlDocument\mergeHeadData().

◆ addStyleSheet()

addStyleSheet (   $url,
  $options = array(),
  $attribs = array() 
)

Adds a linked stylesheet to the page

Paramètres
string$urlURL to the linked style sheet
array$optionsArray of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
array$attribsArray of attributes. Example: array('id' => 'stylesheet', 'data-test' => 1)
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0
Obsolète:
5.0 Use WebAssetManager

Références $attribs, $options, $this, et $url.

◆ getBase()

getBase ( )

Return the base URI of the document.

Renvoie
string
Depuis
1.7.0

Références Document\$base.

◆ getBuffer()

getBuffer ( )

Get the contents of the document buffer

Renvoie
mixed
Depuis
1.7.0

Référencé par HtmlDocument\_renderTemplate(), RawDocument\render(), ImageDocument\render(), et XmlDocument\render().

◆ getCharset()

getCharset ( )

Returns the document charset encoding.

Renvoie
string
Depuis
1.7.0

Références Document\$_charset.

◆ getDescription()

getDescription ( )

Return the description of the document.

Renvoie
string
Depuis
1.7.0

Références Document\$description.

Référencé par Document\getMetaData().

◆ getDirection()

getDirection ( )

Returns the document direction declaration.

Renvoie
string
Depuis
1.7.0

Références Document\$direction.

◆ getGenerator()

getGenerator ( )

Returns the document generator

Renvoie
string
Depuis
1.7.0

Références Document\$_generator.

Référencé par Document\getMetaData(), et FeedDocument\render().

◆ getInstance()

static getInstance (   $type = 'html',
  $attributes = array() 
)
static

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

Paramètres
string$typeThe document type to instantiate
array$attributesArray of attributes
Renvoie
static The document object.
Depuis
1.7.0
Obsolète:
5.0 Use the instead

Références $attributes, $type, class, et Joomla\DI\getContainer().

◆ getLanguage()

getLanguage ( )

Returns the document language.

Renvoie
string
Depuis
1.7.0

Références Document\$language.

◆ getLink()

getLink ( )

Returns the document base url

Renvoie
string
Depuis
1.7.0

Références Document\$link.

◆ getMediaVersion()

getMediaVersion ( )

Return the media version

Renvoie
string
Depuis
3.2

Références Document\$mediaVersion.

◆ getMetaData()

getMetaData (   $name,
  $attribute = 'name' 
)

Gets a meta tag.

Paramètres
string$nameName of the meta HTML tag
string$attributeAttribute to use in the meta HTML tag
Renvoie
string
Depuis
1.7.0

Références $name, $result, elseif, Document\getDescription(), et Document\getGenerator().

◆ getMimeEncoding()

getMimeEncoding ( )

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

Renvoie
string
Depuis
1.7.0

Références Document\$_mime.

◆ getModifiedDate()

getModifiedDate ( )

Returns the document modified date

Renvoie
string|Date
Depuis
1.7.0

Références Document\$_mdate.

Référencé par JsonapiDocument\render(), et Document\render().

◆ getPreloadManager()

getPreloadManager ( )

Return the preload manager

Renvoie
PreloadManagerInterface
Depuis
4.0.0

Références Document\$preloadManager.

Référencé par Document\preloadAssets().

◆ getScriptOptions()

getScriptOptions (   $key = null)

Get script(s) options

Paramètres
string$keyName in Storage
Renvoie
array Options for given $key, or all script options
Depuis
3.5

Références $key, et Document\$scriptOptions.

◆ getTitle()

getTitle ( )

Return the title of the document.

Renvoie
string
Depuis
1.7.0

Références Document\$title.

◆ getType()

getType ( )

Returns the document type

Renvoie
string
Depuis
1.7.0

Références Document\$_type.

◆ getWebAssetManager()

getWebAssetManager ( )

Return WebAsset manager

Renvoie
WebAssetManager
Depuis
4.0.0

Références Document\$webAssetManager.

Référencé par HtmlDocument\getHeadData(), HtmlDocument\mergeHeadData(), et HtmlDocument\setHeadData().

◆ loadRenderer()

loadRenderer (   $type)

Load a renderer

Paramètres
string$typeThe renderer type
Renvoie
RendererInterface
Depuis
1.7.0
Exceptions

Références $this, et $type.

Référencé par HtmlDocument\countModules(), et FeedDocument\render().

◆ parse()

parse (   $params = array())

Parses the document and prepares the buffers

Paramètres
array$paramsThe array of parameters
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this.

Référencé par HtmlDocument\render().

◆ preloadAssets()

preloadAssets ( )
protected

Generate the Link header for assets configured for preloading

Renvoie
void
Depuis
4.0.0

Références Document\$link, elseif, Fig\Link\getLinks(), et Document\getPreloadManager().

Référencé par Document\render().

◆ render()

render (   $cache = false,
  $params = array() 
)

Outputs the document

Paramètres
boolean$cacheIf true, cache the output
array$paramsAssociative array of attributes
Renvoie
string The rendered data
Depuis
1.7.0

Références Document\$_charset, Document\$_mime, $app, Document\getModifiedDate(), et Document\preloadAssets().

◆ setBase()

setBase (   $base)

Sets the base URI of the document

Paramètres
string$baseThe base URI to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références Document\$base, et $this.

Référencé par Document\__construct().

◆ setBuffer()

setBuffer (   $content,
  $options = array() 
)

Set the contents of the document buffer

Paramètres
string$contentThe content to be set in the buffer.
array$optionsArray of optional elements.
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $content, et $this.

◆ setCharset()

setCharset (   $type = 'utf-8')

Sets the document charset

Paramètres
string$typeCharset encoding string
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this, et $type.

Référencé par Document\__construct().

◆ setDescription()

setDescription (   $description)

Sets the description of the document

Paramètres
string$descriptionThe description to set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références Document\$description, $this, et description.

Référencé par Document\setMetaData().

◆ setDirection()

setDirection (   $dir = 'ltr')

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

Paramètres
string$dirThe language direction to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $dir, et $this.

Référencé par Document\__construct().

◆ setFactory()

setFactory ( FactoryInterface  $factory)

Set the factory instance

Paramètres
FactoryInterface$factoryThe factory instance
Renvoie
Document
Depuis
4.0.0

Références Document\$factory, et $this.

Référencé par Document\__construct().

◆ setGenerator()

setGenerator (   $generator)

Sets the document generator

Paramètres
string$generatorThe generator to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this.

Référencé par Document\setMetaData().

◆ setLanguage()

setLanguage (   $lang = 'en-gb')

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

Paramètres
string$langThe language to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $lang, $this, et language.

Référencé par Document\__construct().

◆ setLineEnd()

setLineEnd (   $style)

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

Paramètres
string$style"win", "mac", "unix" or custom string.
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $style, et $this.

Référencé par Document\__construct().

◆ setLink()

setLink (   $url)

Sets the document link

Paramètres
string$urlA url
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this, et $url.

Référencé par Document\__construct().

◆ setMediaVersion()

setMediaVersion (   $mediaVersion)

Set the assets version

Paramètres
string$mediaVersionMedia version to use
Renvoie
Document instance of $this to allow chaining
Depuis
3.2

Références Document\$mediaVersion, et $this.

Référencé par Document\__construct().

◆ setMetaData()

setMetaData (   $name,
  $content,
  $attribute = 'name' 
)

Sets or alters a meta tag.

Paramètres
string$nameName of the meta HTML tag
mixed$contentValue of the meta HTML tag as array or string
string$attributeAttribute to use in the meta HTML tag
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $content, $name, $this, elseif, Document\setDescription(), et Document\setGenerator().

Référencé par HtmlDocument\mergeHeadData(), et Document\setMimeEncoding().

◆ setMimeEncoding()

setMimeEncoding (   $type = 'text/html',
  $sync = true 
)

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

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 (https://www.w3.org/TR/xhtml-media-types/) for more details.

Paramètres
string$typeThe document type to be sent
boolean$syncShould the type be synced with HTML?
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

https://www.w3.org/TR/xhtml-media-types/

Références $this, $type, et Document\setMetaData().

Référencé par HtmlDocument\__construct(), et FeedDocument\render().

◆ setModifiedDate()

setModifiedDate (   $date)

Sets the document modified date

Paramètres
string | Date$dateThe date to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0
Exceptions

Références $date, et $this.

◆ setPreloadManager()

setPreloadManager ( PreloadManagerInterface  $preloadManager)

Set the preload manager

Paramètres
PreloadManagerInterface$preloadManagerThe preload manager service
Renvoie
Document instance of $this to allow chaining
Depuis
4.0.0

Références Document\$preloadManager, et $this.

Référencé par Document\__construct().

◆ setTab()

setTab (   $string)

Sets the string used to indent HTML

Paramètres
string$stringString used to indent ("\11", "\t", ' ', etc.).
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this.

Référencé par Document\__construct().

◆ setTitle()

setTitle (   $title)

Sets the title of the document

Paramètres
string$titleThe title to be set
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this, et Document\$title.

◆ setType()

setType (   $type)

Set the document type

Paramètres
string$typeType document is to set to
Renvoie
Document instance of $this to allow chaining
Depuis
1.7.0

Références $this, et $type.

◆ setWebAssetManager()

setWebAssetManager ( WebAssetManager  $webAsset)

Set WebAsset manager

Paramètres
WebAssetManager$webAssetThe WebAsset instance
Renvoie
Document
Depuis
4.0.0

Références $this.

Référencé par Document\__construct().

Documentation des champs

◆ $_buffer

$_buffer = null
static

◆ $_charset

$_charset = 'utf-8'

Référencé par Document\getCharset(), JsonapiDocument\render(), et Document\render().

◆ $_engine

$_engine = null

◆ $_generator

$_generator = 'Joomla! - Open Source Content Management'

Référencé par Document\getGenerator().

◆ $_lineEnd

$_lineEnd = "\12"

Référencé par Document\_getLineEnd().

◆ $_mdate

$_mdate = ''

Référencé par Document\getModifiedDate().

◆ $_metaTags

$_metaTags = array()

Référencé par HtmlDocument\getHeadData(), et HtmlDocument\setHeadData().

◆ $_mime

$_mime = ''

Référencé par DocumentRenderer\getContentType(), Document\getMimeEncoding(), JsonapiDocument\render(), et Document\render().

◆ $_namespace

$_namespace = ''

◆ $_profile

$_profile = ''

◆ $_script

$_script = array()

Référencé par HtmlDocument\getHeadData(), et HtmlDocument\setHeadData().

◆ $_scripts

$_scripts = array()

Référencé par HtmlDocument\getHeadData(), HtmlDocument\mergeHeadData(), et HtmlDocument\setHeadData().

◆ $_style

$_style = array()

Référencé par HtmlDocument\getHeadData(), et HtmlDocument\setHeadData().

◆ $_styleSheets

$_styleSheets = array()

Référencé par HtmlDocument\getHeadData(), HtmlDocument\mergeHeadData(), et HtmlDocument\setHeadData().

◆ $_tab

$_tab = "\11"

Référencé par Document\_getTab().

◆ $_type

$_type = null

Référencé par Document\getType().

◆ $base

$base = ''

Référencé par DocumentRenderer\_relToAbs(), Document\getBase(), et Document\setBase().

◆ $description

$description = ''

Référencé par Document\getDescription(), HtmlDocument\getHeadData(), Document\setDescription(), et HtmlDocument\setHeadData().

◆ $direction

$direction = 'ltr'

Référencé par Document\getDirection().

◆ $factory

$factory
protected

Référencé par Document\setFactory().

◆ $instances

$instances = array()
staticprotected

◆ $language

$language = 'en-gb'

Référencé par Document\getLanguage().

◆ $link

$link = ''

Référencé par FeedDocument\addItem(), HtmlDocument\getHeadData(), Document\getLink(), PreloadManager\link(), HtmlDocument\mergeHeadData(), Document\preloadAssets(), et HtmlDocument\setHeadData().

◆ $mediaVersion

$mediaVersion = null
protected

Référencé par Document\getMediaVersion(), StylesRenderer\renderElement(), ScriptsRenderer\renderElement(), et Document\setMediaVersion().

◆ $preloadManager

$preloadManager = null
protected

Référencé par Document\getPreloadManager(), et Document\setPreloadManager().

◆ $preloadTypes

$preloadTypes = ['preload', 'dns-prefetch', 'preconnect', 'prefetch', 'prerender']
protected

◆ $scriptOptions

$scriptOptions = array()
protected

Référencé par HtmlDocument\getHeadData(), Document\getScriptOptions(), et HtmlDocument\mergeHeadData().

◆ $title

$title = ''

Référencé par HtmlDocument\getHeadData(), Document\getTitle(), ModuleRenderer\render(), RssRenderer\render(), AtomRenderer\render(), HtmlDocument\setHeadData(), et Document\setTitle().

◆ $webAssetManager

$webAssetManager = null
protected

Référencé par Document\__construct(), et Document\getWebAssetManager().

La documentation de cette classe a été générée à partir du fichier suivant :