Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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)
 mergeHeadData ($data)
 addHeadLink ($href, $relation, $relType= 'rel', $attribs=array())
 addFavicon ($href, $type= 'image/vnd.microsoft.icon', $relation= 'shortcut icon')
 addCustomTag ($html)
 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 inherited from JDocument
 setType ($type)
 getType ()
 getBuffer ()
 getMetaData ($name, $httpEquiv=false)
 setMetaData ($name, $content, $http_equiv=false, $sync=true)
 addScript ($url, $type="text/javascript", $defer=false, $async=false)
 addScriptDeclaration ($content, $type= 'text/javascript')
 addStyleSheet ($url, $type= 'text/css', $media=null, $attribs=array())
 addStyleDeclaration ($content, $type= 'text/css')
 setCharset ($type= 'utf-8')
 getCharset ()
 setLanguage ($lang="en-gb")
 getLanguage ()
 setDirection ($dir="ltr")
 getDirection ()
 setTitle ($title)
 getTitle ()
 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)
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Attributs publics

 $_links = array()
 $_custom = array()
 $template = null
 $baseurl = null
 $params = null
 $_file = null
- Attributs publics inherited from JDocument
 $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

Additional Inherited Members

- Fonctions membres publiques statiques inherited from JDocument
static getInstance ($type= 'html', $attributes=array())
- Attributs publics statiques inherited from JDocument
static $_buffer = null
- Attributs protégés statiques inherited from JDocument
static $instances = array()

Documentation des constructeurs et destructeur

JDocumentHTML::__construct (   $options = array())

Class constructor

Paramètres:
array$optionsAssociative array of options
Depuis:
11.1

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

Références $options.


Documentation des fonctions membres

JDocumentHTML::_fetchTemplate (   $params = array())
protected

Fetch the template, and initialise the params

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

Références $file, $lang, $params, $template, JURI\base(), JFilterInput\getInstance(), JFactory\getLanguage(), JPATH_BASE, et null.

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::_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 $path, JURI\base(), et JPATH_BASE.

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::_parseTemplate ( )
protected

Parse a document template

Renvoie:
The parsed contents of the template
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

Références $attribs, $i, $name, $type, null, et JUtility\parseAttributes().

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::_renderTemplate ( )
protected

Render pre-parsed template

Renvoie:
string rendered template
Depuis:
11.1
JDocumentHTML::addCustomTag (   $html)

Adds a custom HTML string to the head block

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

Références $html.

JDocumentHTML::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:
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

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

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:
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

Références $attribs.

JDocumentHTML::countMenuChildren ( )

Count the number of child menu items

Renvoie:
integer Number of child menu items
Depuis:
11.1

Références $active, $app, $menu, $query, JFactory\getApplication(), et JFactory\getDbo().

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::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 $i, $n, $name, JModuleHelper\getModules(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::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:
The output of the renderer
Depuis:
11.1

Références $attribs, $data, $name, $options, $type, JFactory\getCache(), JCache\getWorkarounds(), null, et JCache\setWorkarounds().

+ Voici le graphe d'appel pour cette fonction :

JDocumentHTML::getHeadData ( )

Get the HTML document head data

Renvoie:
array The document head data in array form
Depuis:
11.1

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

JDocumentHTML::mergeHeadData (   $data)

Merge the HTML document head data

Paramètres:
array$dataThe document head data in array form
Renvoie:
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

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

JDocumentHTML::parse (   $params = array())

Parses the template and populates the buffer

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

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

Références $params.

JDocumentHTML::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:
The rendered data
Depuis:
11.1

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

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

JDocumentHTML::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:
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

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

Références $options, et null.

JDocumentHTML::setHeadData (   $data)

Set the HTML document head data

Paramètres:
array$dataThe document head data in array form
Renvoie:
JDocumentHTML instance of $this to allow chaining
Depuis:
11.1

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


Documentation des données membres

JDocumentHTML::$_caching = null
protected
JDocumentHTML::$_custom = array()
JDocumentHTML::$_file = null
JDocumentHTML::$_links = array()
JDocumentHTML::$_template = ''
protected
JDocumentHTML::$_template_tags = array()
protected
JDocumentHTML::$baseurl = null
JDocumentHTML::$params = null
JDocumentHTML::$template = null

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