Class HTMLHelper - list of methods

Method to extract a key

• string $key The name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.

• array Contains lowercase key, prefix, file, function.

• 1.6

• 5.0

Class loader method

• string $key The name of helper method to load, (prefix).(class).function prefix and class are optional and can be used to load custom html helpers.
• array $methodArgs The arguments to pass forward to the method being called

• mixed Result of HTMLHelper::call($function, $args)

• 1.5

• \InvalidArgumentException

Registers a function to be called with a specific key

• string $key The name of the key
• callable $function Function or method

• bool True if the function is callable

• 1.6

• 5.0

Removes a key for a method from registry.

• string $key The name of the key

• bool True if a set key is unset

• 1.6

• 5.0

Test if the key is registered.

• string $key The name of the key

• bool True if the key is registered.

• 1.6

Retrieves the service registry.

• \Joomla\CMS\HTML\Registry

• 4.0.0

Function caller method

• callable $function Function or method to call
• array $args Arguments to be passed to function

• mixed Function result or false on error.

• 1.6

• https://www.php.net/manual/en/function.call-user-func-array.php
• \InvalidArgumentException

Write a `<a>` element

• string $url The relative URL to use for the href attribute
• string $text The target attribute to use
• array|string $attribs Attributes to be added to the `<a>` element

• string

• 1.5

Write a `<iframe>` element

• string $url The relative URL to use for the src attribute.
• string $name The target attribute to use.
• array|string $attribs Attributes to be added to the `<iframe>` element
• string $noFrames The message to display if the iframe tag is not supported.

• string

• 1.5

Compute the files to be included

• string $folder Folder name to search in (i.e. images, css, js).
• string $file Path to file.
• bool $relative Flag if the path to the file is relative to the /media folder (and searches in template).
• bool $detectBrowser Flag if the browser should be detected to include specific browser files.
• bool $detectDebug Flag if debug mode is enabled to include uncompressed files if debug is on.

• array files to be included.

• 1.6

• \Joomla\CMS\Environment\Browser

Gets a URL, cleans the Joomla specific params and returns an object

• string $url The relative or absolute URL to use for the src attribute.

• object

• 4.0.0

• { url: 'string', attributes: [ width: integer, height: integer, ] }

Write a `<img>` element

• string $file The relative or absolute URL to use for the src attribute.
• string $alt The alt text.
• array|string $attribs Attributes to be added to the `<img>` element
• bool $relative Flag if the path to the file is relative to the /media folder (and searches in template).
• int $returnPath Defines 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

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

• 1.5

Write a `<link>` element to load a CSS file

• string $file Path to file
• array $options Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')
• array $attribs Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

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

• 1.5

• \Joomla\CMS\Environment\Browser

Write a `<script>` element to load a JavaScript file

• string $file Path to file.
• array $options Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')
• array $attribs Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

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

• 1.5

• \Joomla\CMS\HTML\HTMLHelper::stylesheet()

Set format related options.

• array $options Option key/value pairs.

• void

• 1.5

• \Joomla\CMS\HTML\HTMLHelper::$formatOptions

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

• string $input String in a format accepted by date(), defaults to "now".
• string $format The date format specification string (see {@link PHP_MANUAL#date}).
• mixed $tz Time zone to be used for the date. Special cases: boolean true for user setting, boolean false for server setting.
• bool $gregorian True to use Gregorian calendar.

• string A date translated by the given format and time zone.

• 1.5

• \Joomla\CMS\HTML\strftime

Creates a tooltip with an image as button

• string $tooltip The tip string.
• mixed $title The 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.
• string $image The image for the tip, if no text is provided.
• string $text The text for the tip.
• string $href A URL that will be used to create the link.
• string $alt The alt attribute for img tag.
• string $class CSS class for the tool tip.

• string

• 1.5

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

• string $title The title of the tooltip (or combined '::' separated string).
• string $content The content to tooltip.
• bool $translate If true will pass texts through Text.
• bool $escape If true will pass texts through htmlspecialchars.

• string The tooltip string

• 3.1.2

Displays a calendar control field

• 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
• mixed $attribs Additional 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

• string HTML markup for a calendar field

• 1.5

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

• string $path A path to search.

• array An array with directory elements

• 1.5

• 5.0

Method that searches if file exists in given path and returns the relative path. If a minified version exists it will be preferred.

• string $path The actual path of the file
• string $ext The extension of the file
• bool $debugMode Signifies if debug is enabled

• string The relative path of the file

• 4.0.0

Method that takes a file path and converts it to a relative path

• string $path The actual path of the file

• string The relative path of the file

• 4.0.0

Method that takes two paths and checks if the files exist with different order

• string $first the path of the minified file
• string $second the path of the non minified file

• string

• 4.0.0