Référence de la classe JDocumentHTML

Graphe d'héritage de JDocumentHTML:

Graphe de collaboration de JDocumentHTML:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• getHeadData ()
• setHeadData ($data)
• addHeadLink ($href, $relation, $relType= 'rel', $attribs=array())
• addFavicon ($href, $type= 'image/x-icon', $relation= 'shortcut icon')
• addCustomTag ($html)
• getBuffer ($type=null, $name=null, $attribs=array())
• setBuffer ($contents, $type, $name=null)
• render ($caching=false, $params=array())
• countModules ($condition)
• countMenuChildren ()
• _loadTemplate ($directory, $filename)
• _parseTemplate ($data)

Attributs publics

• $_links = array()
• $_custom = array()

---

Documentation des constructeurs et destructeur

JDocumentHTML::__construct

(

$

options = array()

)

Class constructor

protected

Paramètres:

array

$options

Associative array of options

Réimplémentée à partir de JDocument.

---

Documentation des fonctions membres

JDocumentHTML::_loadTemplate	(	$	directory,
		$	filename
	)

Load a template file

Paramètres:

string	$template	The name of the template
string	$filename	The actual filename

Renvoie:

string The contents of the template

Références $acl, $Itemid, $k, $mainframe, $name, $option, $path, $task, JURI::base(), et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :

JDocumentHTML::_parseTemplate

(

$

data

)

Parse a document template

public

Paramètres:

string

$data

The data too parse

Renvoie:

The parsed contents of the template

Références $count, $data, $i, $name, $type, et JUtility::parseAttributes().

Voici le graphe d'appel pour cette fonction :

JDocumentHTML::addCustomTag

(

$

html

)

Adds a custom html string to the head block

Paramètres:

string

The html to add to the head public

Renvoie:

void

JDocumentHTML::addFavicon	(	$	href,
		$	type = 'image/x-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	$href	The link that is being related.
string	$type	File type
string	$relation	Relation of link public

Références $type.

JDocumentHTML::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">

public

Paramètres:

string	$href	The link that is being related.
string	$relation	Relation of link.
string	$relType	Relation type attribute. Either rel or rev (default: 'rel').
array	$attributes	Associative array of remaining attributes.

Renvoie:

void

Références JArrayHelper::toString().

Voici le graphe d'appel pour cette fonction :

JDocumentHTML::countMenuChildren

(

)

Count the number of child menu items

public

Renvoie:

integer Number of child menu items

Références $menu, $where, JFactory::getDBO(), et JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JDocumentHTML::countModules

(

$

condition

)

Count the modules based on the given condition

public

Paramètres:

string

$condition

The condition to use

Renvoie:

integer Number of modules found

Références $i, $name, et JModuleHelper::getModules().

Voici le graphe d'appel pour cette fonction :

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

Get the contents of a document include

public

Paramètres:

string	$type	The type of renderer
string	$name	The name of the element to render
array	$attribs	Associative array of remaining attributes.

Renvoie:

The output of the renderer

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

JDocumentHTML::getHeadData

(

)

Get the html document head data

public

Renvoie:

array The document head data in array form

Réimplémentée à partir de JDocument.

Références $data.

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

Outputs the template to the browser.

public

Paramètres:

boolean	$cache	If true, cache the output
array	$params	Associative array of attributes

Renvoie:

The rendered data

Réimplémentée à partir de JDocument.

Références $content, $data, $file, $lang, $params, JURI::base(), JFilterInput::clean(), JFactory::getLanguage(), et params.

Voici le graphe d'appel pour cette fonction :

JDocumentHTML::setBuffer	(	$	contents,
		$	type,
		$	name = null
	)

Set the contents a document include

public

Paramètres:

string	$type	The type of renderer
string	$name	oke The name of the element to render
string	$content	The content to be set in the buffer

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

JDocumentHTML::setHeadData

(

$

data

)

Set the html document head data

public

Paramètres:

array

$data

The document head data in array form

Réimplémentée à partir de JDocument.

Références $data.

---

Documentation des données membres

JDocumentHTML::$_custom = array()

JDocumentHTML::$_links = array()

---

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

• libraries/joomla/document/html/html.php