Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe HtmlDocument
+ Graphe d'héritage de HtmlDocument:

Fonctions membres publiques

 __construct ($options=array())
 
 getHeadData ()
 
 resetHeadData ($types=null)
 
 setHeadData ($data)
 
 mergeHeadData ($data)
 
 addHeadLink ($href, $relation, $relType='rel', $attribs=array())
 
 addFavicon ($href, $type='image/vnd.microsoft.icon', $relation='shortcut icon')
 
 addCustomTag ($html)
 
 isHtml5 ()
 
 setHtml5 ($state)
 
 getBuffer ($type=null, $name=null, $attribs=array())
 
 setBuffer ($content, $options=array())
 
 parse ($params=array())
 
 render ($caching=false, $params=array())
 
 countModules ($condition)
 
 countMenuChildren ()
 
- Fonctions membres publiques hérités de Document
 __construct ($options=array())
 
 setType ($type)
 
 getType ()
 
 getBuffer ()
 
 setBuffer ($content, $options=array())
 
 getMetaData ($name, $attribute='name')
 
 setMetaData ($name, $content, $attribute='name')
 
 addScript ($url, $options=array(), $attribs=array())
 
 addScriptVersion ($url, $options=array(), $attribs=array())
 
 addScriptDeclaration ($content, $type='text/javascript')
 
 addScriptOptions ($key, $options, $merge=true)
 
 getScriptOptions ($key=null)
 
 addStyleSheet ($url, $options=array(), $attribs=array())
 
 addStyleSheetVersion ($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 ()
 
 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())
 

Champs de données

 $_links = array()
 
 $_custom = array()
 
 $template = null
 
 $baseurl = null
 
 $params = null
 
 $_file = null
 
- Champs de données hérités de Document
 $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
 

Fonctions membres protégées

 _loadTemplate ($directory, $filename)
 
 _fetchTemplate ($params=array())
 
 _parseTemplate ()
 
 _renderTemplate ()
 

Attributs protégés

 $_template = ''
 
 $_template_tags = array()
 
 $_caching = null
 
- Attributs protégés hérités de Document
 $scriptOptions = array()
 
 $mediaVersion = null
 

Fonctions membres privées

 resetHeadDatum ($type)
 

Attributs privés

 $_html5 = null
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Document
static getInstance ($type='html', $attributes=array())
 
- Attributs publics statiques hérités de Document
static $_buffer = null
 
- Attributs protégés statiques hérités de Document
static $instances = array()
 

Description détaillée

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

Depuis
11.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Class constructor

Paramètres
array$optionsAssociative array of options
Depuis
11.1

Références $options.

Documentation des fonctions membres

◆ _fetchTemplate()

_fetchTemplate (   $params = array())
protected

Fetch the template, and initialise the params

Paramètres
array$paramsParameters to determine the template
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

Références $file, $filter, $lang, $params, $template, Uri\base(), JPATH_BASE, et null.

◆ _loadTemplate()

_loadTemplate (   $directory,
  $filename 
)
protected

Load a template file

Paramètres
string$directoryThe name of the template
string$filenameThe actual filename
Renvoie
string The contents of the template
Depuis
11.1

Références $icon, $path, Uri\base(), et JPATH_BASE.

◆ _parseTemplate()

_parseTemplate ( )
protected

Parse a document template

Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

Références $attribs, $i, $name, $type, et null.

◆ _renderTemplate()

_renderTemplate ( )
protected

Render pre-parsed template

Renvoie
string rendered template
Depuis
11.1

◆ addCustomTag()

addCustomTag (   $html)

Adds a custom HTML string to the head block

Paramètres
string$htmlThe HTML to add to the head
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

Références $html.

◆ addFavicon()

addFavicon (   $href,
  $type = 'image/vnd.microsoft.icon',
  $relation = 'shortcut icon' 
)

Adds a shortcut icon (favicon)

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.

Paramètres
string$hrefThe link that is being related.
string$typeFile type
string$relationRelation of link
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

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

◆ addHeadLink()

addHeadLink (   $href,
  $relation,
  $relType = 'rel',
  $attribs = array() 
)

Adds <link> tags to the head of the document

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

Paramètres
string$hrefThe link that is being related.
string$relationRelation of link.
string$relTypeRelation type attribute. Either rel or rev (default: 'rel').
array$attribsAssociative array of remaining attributes.
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

Références $attribs, et $href.

◆ countMenuChildren()

countMenuChildren ( )

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

Renvoie
integer Number of child menu items
Depuis
11.1

Références $active, $app, $db, $menu, et $query.

◆ countModules()

countModules (   $condition)

Count the modules based on the given condition

Paramètres
string$conditionThe condition to use
Renvoie
integer Number of modules found
Depuis
11.1

Références $condition, $i, $n, $name, Log\add(), ModuleHelper\getModules(), null, et Log\WARNING.

◆ getBuffer()

getBuffer (   $type = null,
  $name = null,
  $attribs = array() 
)

Get the contents of a document include

Paramètres
string$typeThe type of renderer
string$nameThe name of the element to render
array$attribsAssociative array of remaining attributes.
Renvoie
mixed|string The output of the renderer
Depuis
11.1

Références $attribs, $data, $hash, $name, $options, $renderer, $title, $type, Cache\getWorkarounds(), null, et Cache\setWorkarounds().

◆ getHeadData()

getHeadData ( )

Get the HTML document head data

Renvoie
array The document head data in array form
Depuis
11.1

Références $data, $description, $link, et $title.

◆ isHtml5()

isHtml5 ( )

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

Renvoie
boolean true when HTML5 is used
Depuis
12.1

◆ mergeHeadData()

mergeHeadData (   $data)

Merge the HTML document head data

Paramètres
array$dataThe document head data in array form
Renvoie
HtmlDocument|null instance of $this to allow chaining or null for empty input data
Depuis
11.1

Références $data, $type, description, title, et true.

◆ parse()

parse (   $params = array())

Parses the template and populates the buffer

Paramètres
array$paramsParameters for fetching the template
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
11.1

Références $params.

◆ render()

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

Outputs the template to the browser.

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

Références $data, et $params.

◆ resetHeadData()

resetHeadData (   $types = null)

Reset the HTML document head data

Paramètres
mixed$typestype or types of the heads elements to reset
Renvoie
HtmlDocument instance of $this to allow chaining
Depuis
3.7.0

Références $type, description, et title.

◆ resetHeadDatum()

resetHeadDatum (   $type)
private

Reset a part the HTML document head data

Paramètres
string$typetype of the heads elements to reset
Renvoie
void
Depuis
3.7.0

Références $type.

◆ setBuffer()

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

Set the contents a document includes

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

Références $content, $options, et null.

◆ setHeadData()

setHeadData (   $data)

Set the HTML document head data

Paramètres
array$dataThe document head data in array form
Renvoie
HtmlDocument|null instance of $this to allow chaining or null for empty input data
Depuis
11.1

Références $data, $key, description, et title.

◆ setHtml5()

setHtml5 (   $state)

Sets whether the document should be output as HTML5

Paramètres
bool$stateTrue when HTML5 should be output
Renvoie
void
Depuis
12.1

Références $state.

Documentation des champs

◆ $_caching

$_caching = null
protected

◆ $_custom

$_custom = array()

◆ $_file

$_file = null

◆ $_html5

$_html5 = null
private

◆ $_links

$_links = array()

◆ $_template

$_template = ''
protected

◆ $_template_tags

$_template_tags = array()
protected

◆ $baseurl

$baseurl = null

◆ $params

$params = null

◆ $template

$template = null

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