Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JHTML

Description
Description | Methods (details)

Utility class for all HTML drawing classes

  • since: 1.5

Located in /joomla/html/html.php (line 23) 

Class JHTML   (Subpackage HTML)
Method Summary
Description | Methods (details)
Method array addIncludePath ([string $path = ''])
Method void calendar (string $value, string $name, string $id, [string $format = '%Y-%m-%d'], [array $attribs = null])
Method string date (string $date, [string $format = null], [ $offset = NULL])
Method void iframe (string $url, string $name, [array $attribs = null], [string $noFrames = ''])
Method void image (string $url, string $alt, [array $attribs = null])
Method void link (string $url, string $text, [array $attribs = null])
Method void script (string $filename, [boolean $path = 'media/system/js/'], [ $mootools = true])
Method void stylesheet (string $filename, [ $path = 'media/system/css/'], [ $attribs = array()])
Method string tooltip (string $tooltip, [string $title = ''], [string $image = 'tooltip.png'], [string $text = ''], [string $href = ''], [boolean $link = 1])
Method void _ (string $type)
Methods
Description | Methods (details)
addIncludePath (line 307)

Add a directory where JHTML should search for helpers. You may either pass a string or an array of directories.

  • return: An array with directory elements
  • since: 1.5
  • access: public
array addIncludePath ([string $path = ''])
  • string $path: A path to search.
calendar (line 278)

Displays a calendar control field

void calendar (string $value, string $name, string $id, [string $format = '%Y-%m-%d'], [array $attribs = null])
  • string $value: The date value
  • string $name: The name of the text field
  • string $id: The id of the text field
  • string $format: The date format
  • array $attribs: Additional html attributes
date (line 208)

Returns formated date according to current local and adds time offset

  • return: formated date
  • since: 1.5
  • see: strftime
  • access: public
string date (string $date, [string $format = null], [ $offset = NULL])
  • string $date: date in an US English date format
  • string $format: format optional format for strftime
  • $offset
iframe (line 146)

Write a <iframe></iframe> element

  • since: 1.5
  • access: public
void iframe (string $url, string $name, [array $attribs = null], [string $noFrames = ''])
  • string $url: The relative URL to use for the src attribute
  • string $name: The target attribute to use
  • array $attribs: An associative array of attributes to add
  • string $noFrames: The message to display if the iframe tag is not supported
image (line 123)

Write a <img></amg> element

  • since: 1.5
  • access: public
void image (string $url, string $alt, [array $attribs = null])
  • string $url: The relative or absoluete URL to use for the src attribute
  • string $alt: The target attribute to use
  • array $attribs: An associative array of attributes to add
link (line 105)

Write a <a></a> element

  • since: 1.5
  • access: public
void link (string $url, string $text, [array $attribs = null])
  • string $url: The relative URL to use for the href attribute
  • string $text: The target attribute to use
  • array $attribs: An associative array of attributes to add
script (line 164)

Write a <script></script> element

  • since: 1.5
  • access: public
void script (string $filename, [boolean $path = 'media/system/js/'], [ $mootools = true])
  • string $filename: The name of the script file * @param string The relative or absolute path of the script file
  • boolean $path: If true, the mootools library will be loaded
  • $mootools
stylesheet (line 187)

Write a <link rel="stylesheet" style="text/css" /> element

  • since: 1.5
  • access: public
void stylesheet (string $filename, [ $path = 'media/system/css/'], [ $attribs = array()])
  • string $filename: The relative URL to use for the href attribute
  • $path
  • $attribs
tooltip (line 240)

Creates a tooltip with an image as button

  • since: 1.5
  • access: public
string tooltip (string $tooltip, [string $title = ''], [string $image = 'tooltip.png'], [string $text = ''], [string $href = ''], [boolean $link = 1])
  • string $tooltip: The tip string
  • string $title: The title of the tooltip
  • string $image: The image for the tip, if no text is provided
  • string $text: The text for the tip
  • string $href: An URL that will be used to create the link
  • boolean $link: depreciated
_ (line 35)

Class loader method

Additional arguments may be supplied and are passed to the sub-class. Additional include paths are also able to be specified for third-party use

void _ (string $type)
  • string $type: The name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.
Documentation generated on Fri, 01 May 2009 14:05:54 +0100 by phpDocumentor 1.3.1