Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JDocumentHTML

Description
Description | Variables | Methods (details)

DocumentHTML class, provides an easy interface to parse and display an html document

Located in /joomla/document/html/html.php (line 29) 

Class JObject   (Subpackage Base)

Abstract class JDocument
   
   Class JDocumentHTML   (Subpackage Document)
Method Summary
Description | Variables | Methods (details)
Constructor JDocumentHTML __construct ([array $options = array()])
Method void addCustomTag (string $html)
Method void addFavicon (string $href, [string $type = 'image/x-icon'], [string $relation = 'shortcut icon'])
Method void addHeadLink (string $href, string $relation, [string $relType = 'rel'], [ $attribs = array()], array $attributes)
Method integer countModules (string $condition)
Method The getBuffer (string $type, [string $name = null], [array $attribs = array()])
Method array getHeadData ()
Method The render ([ $caching = false], [array $params = array()], boolean $cache)
Method void setBuffer ( $contents, string $type, [string $name = null], string $content)
Method void setHeadData (array $data)
Method string _loadTemplate ( $directory, string $filename, string $template)
Method The _parseTemplate (string $data)
Variables
Description | Variables (details) | Methods (details)

Inherited Variables

Inherited from JDocument

Variable JDocument::$description
 Variable JDocument::$direction
 Variable JDocument::$language
 Variable JDocument::$link
 Variable JDocument::$title
 Variable JDocument::$_generator
Methods
Description | Variables Methods (details)
Constructor __construct (line 54)

Class constructor

  • access: protected
JDocumentHTML __construct ([array $options = array()])
  • array $options: Associative array of options
Redefinition of:
JDocument::__construct()
Class constructor
addCustomTag (line 158)

Adds a custom html string to the head block

  • access: public
void addCustomTag (string $html)
  • string $html: The html to add to the head
addFavicon (line 144)

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.

  • access: public
void addFavicon (string $href, [string $type = 'image/x-icon'], [string $relation = 'shortcut icon'])
  • string $href: The link that is being related.
  • string $type: File type
  • string $relation: Relation of link
addHeadLink (line 125)

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

  • access: public
void addHeadLink (string $href, string $relation, [string $relType = 'rel'], [ $attribs = array()], array $attributes)
  • 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.
  • $attribs
countModules (line 247)

Count the modules based on the given condition

  • return: Number of modules found
  • access: public
integer countModules (string $condition)
  • string $condition: The condition to use
getBuffer (line 172)

Get the contents of a document include

  • return: output of the renderer
  • access: public
The getBuffer (string $type, [string $name = null], [array $attribs = array()])
  • string $type: The type of renderer
  • string $name: The name of the element to render
  • array $attribs: Associative array of remaining attributes.
Redefinition of:
JDocument::getBuffer()
Get the contents of the document buffer
getHeadData (line 75)

Get the document head data

  • return: The document head data in array form
  • access: public
array getHeadData ()
Redefinition of:
JDocument::getHeadData()
Get the document head data
render (line 208)

Outputs the template to the browser.

  • return: rendered data
  • access: public
The render ([ $caching = false], [array $params = array()], boolean $cache)
  • boolean $cache: If true, cache the output
  • array $params: Associative array of attributes
  • $caching
Redefinition of:
JDocument::render()
Outputs the document
setBuffer (line 195)

Set the contents a document include

  • access: public
void setBuffer ( $contents, string $type, [string $name = null], string $content)
  • 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
  • $contents
Redefinition of:
JDocument::setBuffer()
Set the contents of the document buffer
setHeadData (line 97)

Set the document head data

  • access: public
void setHeadData (array $data)
  • array $data: The document head data in array form
Redefinition of:
JDocument::setHeadData()
Set the document head data
_loadTemplate (line 274)

Load a template file

  • return: The contents of the template
string _loadTemplate ( $directory, string $filename, string $template)
  • string $template: The name of the template
  • string $filename: The actual filename
  • $directory
_parseTemplate (line 330)

Parse a document template

  • return: parsed contents of the template
  • access: public
The _parseTemplate (string $data)
  • string $data: The data too parse

Inherited Methods

Inherited From JDocument

JDocument::__construct()
JDocument::addScript()
JDocument::addScriptDeclaration()
JDocument::addStyleDeclaration()
JDocument::addStyleSheet()
JDocument::getBuffer()
JDocument::getCharset()
JDocument::getDescription()
JDocument::getDirection()
JDocument::getGenerator()
JDocument::getHeadData()
JDocument::getInstance()
JDocument::getLanguage()
JDocument::getLink()
JDocument::getMetaData()
JDocument::getModifiedDate()
JDocument::getTitle()
JDocument::getType()
JDocument::loadRenderer()
JDocument::render()
JDocument::setBuffer()
JDocument::setCharset()
JDocument::setDescription()
JDocument::setDirection()
JDocument::setGenerator()
JDocument::setHeadData()
JDocument::setLanguage()
JDocument::setLineEnd()
JDocument::setLink()
JDocument::setMetaData()
JDocument::setMimeEncoding()
JDocument::setModifiedDate()
JDocument::setTab()
JDocument::setTitle()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:07:01 +0000 by phpDocumentor 1.3.1