Joomla! API

Download
Launch

HTMLHelper

Utility class for all HTML drawing classes

abstract
since

1.5

Methods

_

Class loader method

_(string $key) : mixed
static

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

since

1.5
throws

\InvalidArgumentException

Arguments

$key

stringThe name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.

Response

mixedResult of HTMLHelper::call($function, $args)

addIncludePath

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

addIncludePath(string $path = '') : array
static
since

1.5

Arguments

$path

stringA path to search.

Response

arrayAn array with directory elements

calendar

Displays a calendar control field

calendar(string $value, string $name, string $id, string $format = '%Y-%m-%d', mixed $attribs = array()) : string
static
since

1.5

Arguments

$value

stringThe date value

$name

stringThe name of the text field

$id

stringThe id of the text field

$format

stringThe date format

$attribs

mixedAdditional HTML attributes The array can have the following keys: readonly Sets the readonly parameter for the input tag disabled Sets the disabled parameter for the input tag autofocus Sets the autofocus parameter for the input tag autocomplete Sets the autocomplete parameter for the input tag filter Sets the filter for the input tag

Response

stringHTML markup for a calendar field

call

Function caller method

call(callable $function, array $args) : mixed
static
link

https://www.php.net/manual/en/function.call-user-func-array.php
since

1.6
throws

\InvalidArgumentException

Arguments

$function

callableFunction or method to call

$args

arrayArguments to be passed to function

Response

mixedFunction result or false on error.

date

Returns formatted date according to a given format and time zone.

date(string $input = 'now', string $format = null, mixed $tz = true, boolean $gregorian = false) : string
static
see \Joomla\CMS\HTML\strftime
since

1.5

Arguments

$input

stringString in a format accepted by date(), defaults to "now".

$format

stringThe date format specification string (see {@link PHP_MANUAL#date}).

$tz

mixedTime zone to be used for the date. Special cases: boolean true for user setting, boolean false for server setting.

$gregorian

booleanTrue to use Gregorian calendar.

Response

stringA date translated by the given format and time zone.

extract

Method to extract a key

extract(string $key) : array
static
since

1.6

Arguments

$key

stringThe name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.

Response

arrayContains lowercase key, prefix, file, function.

getJSObject

Internal method to get a JavaScript object notation string from an array

getJSObject(array $array = array()) : string
static deprecated
since

3.0
deprecated

4.0 Use json_encode() or Joomla\Registry\Registry::toString('json') instead

Arguments

$array

arrayThe array to convert to JavaScript object notation

Response

stringJavaScript object notation representation of the array

getMd5Version

Include version with MD5SUM file in path.

getMd5Version(string $path) : string
static deprecated
since

3.7.0
deprecated

4.0 Usage of MD5SUM files is deprecated, use version instead.

Arguments

$path

stringFolder name to search into (images, css, js, ...).

Response

stringQuery string to add.

iframe

Write a <iframe> element

iframe(string $url, string $name, array|string $attribs = null, string $noFrames = '') : string
static
since

1.5

Arguments

$url

stringThe relative URL to use for the src attribute.

$name

stringThe target attribute to use.

$attribs

array|stringAttributes to be added to the <iframe> element

$noFrames

stringThe message to display if the iframe tag is not supported.

Response

string

image

Write a <img> element

image(string $file, string $alt, array|string $attribs = null, boolean $relative = false, integer $returnPath) : string|null
static
since

1.5

Arguments

$file

stringThe relative or absolute URL to use for the src attribute.

$alt

stringThe alt text.

$attribs

array|stringAttributes to be added to the <img> element

$relative

booleanFlag if the path to the file is relative to the /media folder (and searches in template).

$returnPath

integerDefines the return value for the method: -1: Returns a <img> tag without looking for relative files 0: Returns a <img> tag while searching for relative files 1: Returns the file path to the image while searching for relative files

Response

string|nullHTML markup for the image, relative path to the image, or null if path is to be returned but image is not found

includeRelativeFiles

Compute the files to be included

includeRelativeFiles(string $folder, string $file, boolean $relative, boolean $detectBrowser, boolean $detectDebug) : array
static
see \Joomla\CMS\HTML\JBrowser
since

1.6

Arguments

$folder

stringFolder name to search in (i.e. images, css, js).

$file

stringPath to file.

$relative

booleanFlag if the path to the file is relative to the /media folder (and searches in template).

$detectBrowser

booleanFlag if the browser should be detected to include specific browser files.

$detectDebug

booleanFlag if debug mode is enabled to include uncompressed files if debug is on.

Response

arrayfiles to be included.

isRegistered

Test if the key is registered.

isRegistered(string $key) : boolean
static
since

1.6

Arguments

$key

stringThe name of the key

Response

booleanTrue if the key is registered.

link

Write a <a> element

link(string $url, string $text, array|string $attribs = null) : string
static
since

1.5

Arguments

$url

stringThe relative URL to use for the href attribute

$text

stringThe target attribute to use

$attribs

array|stringAttributes to be added to the <a> element

Response

string

register

Registers a function to be called with a specific key

register(string $key, string $function) : boolean
static
since

1.6

Arguments

$key

stringThe name of the key

$function

stringFunction or method

Response

booleanTrue if the function is callable

script

Write a <script> element to load a JavaScript file

script(string $file, array $options = array(), array $attribs = array()) : array|string|null
static deprecated
see \Joomla\CMS\HTML\HTMLHelper::stylesheet()
since

1.5
deprecated

4.0 The (file, framework, relative, pathOnly, detectBrowser, detectDebug) method signature is deprecated, use (file, options, attributes) instead.

Arguments

$file

stringPath to file.

$options

arrayArray of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')

$attribs

arrayArray of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

Response

array|string|nullNothing if $returnPath is false, null, path or array of path if specific JavaScript browser files were detected

setFormatOptions

Set format related options.

setFormatOptions(array $options) : void
static

Updates the formatOptions array with all valid values in the passed array.

see \Joomla\CMS\HTML\HTMLHelper::$formatOptions
since

1.5

Arguments

$options

arrayOption key/value pairs.

stylesheet

Write a <link> element to load a CSS file

stylesheet(string $file, array $options = array(), array $attribs = array()) : array|string|null
static deprecated
see \Joomla\CMS\Environment\Browser
since

1.5
deprecated

4.0 The (file, attribs, relative, pathOnly, detectBrowser, detectDebug) method signature is deprecated, use (file, options, attributes) instead.

Arguments

$file

stringPath to file

$options

arrayArray of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')

$attribs

arrayArray of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

Response

array|string|nullnothing if $returnPath is false, null, path or array of path if specific CSS browser files were detected

tooltip

Creates a tooltip with an image as button

tooltip(string $tooltip, mixed $title = '', string $image = 'tooltip.png', string $text = '', string $href = '', string $alt = 'Tooltip', string $class = 'hasTooltip') : string
static
since

1.5

Arguments

$tooltip

stringThe tip string.

$title

mixedThe title of the tooltip or an associative array with keys contained in {'title','image','text','href','alt'} and values corresponding to parameters of the same name.

$image

stringThe image for the tip, if no text is provided.

$text

stringThe text for the tip.

$href

stringA URL that will be used to create the link.

$alt

stringThe alt attribute for img tag.

$class

stringCSS class for the tool tip.

Response

string

tooltipText

Converts a double colon separated string or 2 separate strings to a string ready for bootstrap tooltips

tooltipText(string $title = '', string $content = '', boolean $translate = true, boolean $escape = true) : string
static
since

3.1.2

Arguments

$title

stringThe title of the tooltip (or combined '::' separated string).

$content

stringThe content to tooltip.

$translate

booleanIf true will pass texts through JText.

$escape

booleanIf true will pass texts through htmlspecialchars.

Response

stringThe tooltip string

unregister

Removes a key for a method from registry.

unregister(string $key) : boolean
static
since

1.6

Arguments

$key

stringThe name of the key

Response

booleanTrue if a set key is unset

Properties

formatOptions

Option values related to the generation of HTML output. Recognized options are: fmtDepth, integer. The current indent depth.

static

fmtEol, string. The end of line string, default is linefeed. fmtIndent, string. The string to use for indentation, default is tab.

since

1.5

Type(s)

array

includePaths

An array to hold included paths

static
since

1.5

Type(s)

array<mixed,string>

registry

An array to hold method references

static
since

1.6

Type(s)

array<mixed,callable>
  • \ Joomla
  • \ CMS
  • \ HTML
  • \ HTMLHelper