[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/document/html/ -> html.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: html.php 14401 2010-01-26 14:10:00Z louis $
File Size: 394 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JDocumentHTML:: (13 methods):
  __construct()
  getHeadData()
  setHeadData()
  addHeadLink()
  addFavicon()
  addCustomTag()
  getBuffer()
  setBuffer()
  render()
  countModules()
  countMenuChildren()
  _loadTemplate()
  _parseTemplate()


Class: JDocumentHTML  - X-Ref

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

__construct($options = array()   X-Ref
Class constructor

param: array    $options Associative array of options

getHeadData()   X-Ref
Get the html document head data

return: array    The document head data in array form

setHeadData($data)   X-Ref
Set the html document head data

param: array    $data    The document head data in array form

addHeadLink($href, $relation, $relType = 'rel', $attribs = array()   X-Ref
Adds <link> tags to the head of the document

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

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

addFavicon($href, $type = 'image/x-icon', $relation = 'shortcut icon')   X-Ref
Adds a shortcut icon (favicon)

<p>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.</p>

param: string  $href        The link that is being related.
param: string  $type        File type
param: string  $relation    Relation of link

addCustomTag( $html )   X-Ref
Adds a custom html string to the head block

param: string The html to add to the head
return: void

getBuffer($type = null, $name = null, $attribs = array()   X-Ref
Get the contents of a document include

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

setBuffer($contents, $type, $name = null)   X-Ref
Set the contents a document include

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

render( $caching = false, $params = array()   X-Ref
Outputs the template to the browser.

param: boolean     $cache        If true, cache the output
param: array        $params        Associative array of attributes
return: The rendered data

countModules($condition)   X-Ref
Count the modules based on the given condition

param: string     $condition    The condition to use
return: integer  Number of modules found

countMenuChildren()   X-Ref
Count the number of child menu items

return: integer Number of child menu items

_loadTemplate($directory, $filename)   X-Ref
Load a template file

param: string     $template    The name of the template
param: string     $filename    The actual filename
return: string The contents of the template

_parseTemplate($data)   X-Ref
Parse a document template

param: string     $data        The data too parse
return: The parsed contents of the template



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1