HTMLHelper

Utility class for all HTML drawing classes

abstract
since

1.5

package

Application

Methods

_

Class loader method

_(string key, array methodArgs) : mixed
static final

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.

methodArgs

arrayThe arguments to pass forward to the method being called

Response

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

addFileToBuffer

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

addFileToBuffer(string path = '', string ext = '', bool debugMode = false) : string
static
since

4.0.0

Arguments

path

stringThe actual path of the file

ext

stringThe extension of the file

debugMode

boolSignifies if debug is enabled

Response

stringThe relative path of the file

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 deprecated
since

1.5

deprecated

5.0 Use the service registry instead

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

checkFileOrder

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

checkFileOrder(string first, string second) : string
static
since

4.0.0

Arguments

first

stringthe path of the minified file

second

stringthe path of the non minified file

Response

string

cleanImageURL

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

cleanImageURL(string url) : object
static
example

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

since

4.0.0

Arguments

url

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

Response

object

convertToRelativePath

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

convertToRelativePath(string path) : string
static
since

4.0.0

Arguments

path

stringThe actual path of the file

Response

stringThe relative path of the file

date

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

date(string input = 'now', string format = null, mixed tz = true, bool 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}).

tz

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

gregorian

boolTrue 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 deprecated
since

1.6

deprecated

5.0 Use the service registry instead

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.

getServiceRegistry

Retrieves the service registry.

getServiceRegistry() : \Joomla\CMS\HTML\Registry
static
since

4.0.0

Response

\Joomla\CMS\HTML\Registry

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, bool relative = false, int 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

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

returnPath

intDefines 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, bool relative, bool detectBrowser, bool detectDebug) : array
static
see Browser
since

1.6

Arguments

folder

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

file

stringPath to file.

relative

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

detectBrowser

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

detectDebug

boolFlag 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) : bool
static
since

1.6

Arguments

key

stringThe name of the key

Response

boolTrue if the key is registered.

register

Registers a function to be called with a specific key

register(string key, callable function) : bool
static deprecated
since

1.6

deprecated

5.0 Use the service registry instead

Arguments

key

stringThe name of the key

function

callableFunction or method

Response

boolTrue 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
see HTMLHelper::stylesheet()
since

1.5

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 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
see Browser
since

1.5

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 = '', bool translate = true, bool 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

boolIf true will pass texts through Text.

escape

boolIf true will pass texts through htmlspecialchars.

Response

stringThe tooltip string

unregister

Removes a key for a method from registry.

unregister(string key) : bool
static deprecated
since

1.6

deprecated

5.0 Use the service registry instead

Arguments

key

stringThe name of the key

Response

boolTrue 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 deprecated
since

1.5

deprecated

5.0

Type(s)

string[]

registry

An array to hold method references

static deprecated
since

1.6

deprecated

5.0

Type(s)

callable[]

serviceRegistry

The service registry for custom and overridden JHtml helpers

static
since

4.0.0

Type(s)

Registry