Html Helper class for easy use of HTML widgets.
HtmlHelper encloses all methods needed while working with HTML pages.
\Cake\View\Helper\UrlHelper
\Cake\View\View
The View instance this helper is attached to
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this class
array
A helper lookup table used to lazy load helper objects.
array
Names of script & css files that have been included once
array
Options for the currently opened script block buffer if any.
\Cake\View\StringTemplate
StringTemplate instance.
array
List of helpers used by this helper
Returns an array that can be used to describe the internal state of this object.
Internal function to build a nested list (UL/OL) out of an associative array.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Begin a script block that captures output until HtmlHelper::scriptEnd() is called. This capturing block will capture all output between the methods and create a scriptBlock from it.
__call(string $method, array $params)
Provide non fatal errors on missing method calls.
string
$method Method to invoke
array
$params Array of params for the method.
mixed|void
__construct(\Cake\View\View $view, array $config)
Default Constructor
\Cake\View\View
$view The View this helper is being attached to.
array
$config optional Configuration settings for the helper.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Lazy loads helpers.
string
$name Name of the property being accessed.
\Cake\View\Helper|null|void
Helper instance if helper with provided name exists
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string
$okCode Code to be executed after user chose 'OK'
string
$cancelCode Code to be executed after user chose 'Cancel'
string
"onclick" JS code
_nestedListItem(array $items, array $options, array $itemOptions)
Internal function to build a nested list (UL/OL) out of an associative array.
array
$items Set of elements to list.
array
$options Additional HTML attributes of the list (ol/ul) tag.
array
$itemOptions Options and additional HTML attributes of the list item (LI) tag.
string
The nested list element
_renderCells(array $line, bool $useCount)
Renders cells for a row of a table.
This is a helper method for tableCells(). Overload this method as you need to change the behavior of the cell rendering.
array
$line Line data to render.
bool
$useCount optional Renders the count into the row. Default is false.
string[]
addClass(array $options, string $class, string $key)
Adds the given class to the element options
array
$options Array options/attributes to add a class to
string
$class The class name being added.
string
$key optional the key to use for class. Defaults to 'class'
.
array
Array of options with $key set.
charset(?string $charset)
Returns a charset META-tag.
string|null
$charset optional The character set to be used in the meta tag. If empty, The App.encoding value will be used. Example: "utf-8".
string
A meta tag containing the specified character set.
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
css(mixed $path, array $options)
Creates a link element for CSS stylesheets.
Include one CSS file:
echo $this->Html->css('styles.css');
Include multiple CSS files:
echo $this->Html->css(['one.css', 'two.css']);
Add the stylesheet to view block "css":
$this->Html->css('styles.css', ['block' => true]);
Add the stylesheet to a custom block:
$this->Html->css('styles.css', ['block' => 'layoutCss']);
block
Set to true to append output to view block "css" or provide custom block name.once
Whether or not the css file should be checked for uniqueness. If true css files will only be included once, use false to allow the same css to be included more than once per request.plugin
False value will prevent parsing path as a pluginrel
Defaults to 'stylesheet'. If equal to 'import' the stylesheet will be imported.fullBase
If true the URL will get a full address for the css file.string|string[]
$path The name of a CSS style sheet or an array containing names of CSS stylesheets. If $path
is prefixed with '/', the path will be relative to the webroot of your application. Otherwise, the path will be relative to your CSS path, usually webroot/css.
array
$options optional Array of options and HTML arguments.
string|null
CSS <link />
or <style />
tag, depending on the type of link.
div(?string $class, ?string $text, array $options)
Returns a formatted DIV tag for HTML FORMs.
escape
Whether or not the contents should be html_entity escaped.string|null
$class optional CSS class name of the div element.
string|null
$text optional String content that will appear inside the div element. If null, only a start tag will be printed
array
$options optional Additional HTML attributes of the DIV tag
string
The formatted DIV element
formatTemplate(string $name, array $data)
Formats a template string with $data
string
$name The template name.
array
$data The data to insert.
string
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getTemplates(?string $template)
Gets templates to use or a specific template.
string|null
$template optional String for reading a specific template, null for all.
string|array
getView()
Get the view instance this helper is bound to.
\Cake\View\View
The bound view instance.
image(mixed $path, array $options)
Creates a formatted IMG element.
This method will set an empty alt attribute if one is not supplied.
Create a regular image:
echo $this->Html->image('cake_icon.png', ['alt' => 'CakePHP']);
Create an image link:
echo $this->Html->image('cake_icon.png', ['alt' => 'CakePHP', 'url' => 'https://cakephp.org']);
url
If provided an image link will be generated and the link will point at $options['url']
.fullBase
If true the src attribute will get a full address for the image file.plugin
False value will prevent parsing path as a pluginstring|array
$path Path to the image file, relative to the webroot/img/ directory.
array
$options optional Array of HTML attributes. See above for special options.
string
completed img tag
implementedEvents()
Event listeners.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this helper.
link(mixed $title, mixed $url, array $options)
Creates an HTML link.
If $url starts with "http://" this is treated as an external link. Else, it is treated as a path to controller/action and parsed with the UrlHelper::build() method.
If the $url is empty, $title is used instead.
escape
Set to false to disable escaping of title and attributes.escapeTitle
Set to false to disable escaping of title. Takes precedence over value of escape
)confirm
JavaScript confirmation message.string|array
$title The content to be wrapped by <a>
tags. Can be an array if $url is null. If $url is null, $title will be used as both the URL and title.
string|array|null
$url optional Cake-relative URL or array of URL parameters, or external URL (starts with http://)
array
$options optional Array of options and HTML attributes.
string
An <a />
element.
linkFromPath(string $title, string $path, array $params, array $options)
Creates an HTML link from route path string.
escape
Set to false to disable escaping of title and attributes.escapeTitle
Set to false to disable escaping of title. Takes precedence over value of escape
)confirm
JavaScript confirmation message.string
$title The content to be wrapped by <a>
tags.
string
$path Cake-relative route path.
array
$params optional An array specifying any additional parameters. Can be also any special parameters supported by Router::url()
.
array
$options optional Array of options and HTML attributes.
string
An <a />
element.
media(mixed $path, array $options)
Returns an audio/video element
Using an audio file:
echo $this->Html->media('audio.mp3', ['fullBase' => true]);
Outputs:
<video src="http://www.somehost.com/files/audio.mp3">Fallback text</video>
Using a video file:
echo $this->Html->media('video.mp4', ['text' => 'Fallback text']);
Outputs:
<video src="/files/video.mp4">Fallback text</video>
Using multiple video files:
echo $this->Html->media( ['video.mp4', ['src' => 'video.ogv', 'type' => "video/ogg; codecs='theora, vorbis'"]], ['tag' => 'video', 'autoplay'] );
Outputs:
<video autoplay="autoplay"> <source src="/files/video.mp4" type="video/mp4"/> <source src="/files/video.ogv" type="video/ogv; codecs='theora, vorbis'"/> </video>
tag
Type of media element to generate, either "audio" or "video". If tag is not provided it's guessed based on file's mime type.text
Text to include inside the audio/video tagpathPrefix
Path prefix to use for relative URLs, defaults to 'files/'fullBase
If provided the src attribute will get a full address including domain namestring|array
$path Path to the video file, relative to the webroot/{$options['pathPrefix']} directory. Or an array where each item itself can be a path string or an associate array containing keys src
and type
array
$options optional Array of HTML attributes, and special options above.
string
Generated media element
meta(mixed $type, mixed $content, array $options)
Creates a link to an external resource and handles basic meta tags
Create a meta tag that is output inline:
$this->Html->meta('icon', 'favicon.ico');
Append the meta tag to custom view block "meta":
$this->Html->meta('description', 'A great page', ['block' => true]);
Append the meta tag to custom view block:
$this->Html->meta('description', 'A great page', ['block' => 'metaTags']);
Create a custom meta tag:
$this->Html->meta(['property' => 'og:site_name', 'content' => 'CakePHP']);
block
- Set to true to append output to view block "meta" or provide custom block name.string|array
$type The title of the external resource, Or an array of attributes for a custom meta tag.
string|array|null
$content optional The address of the external resource or string for content attribute
array
$options optional Other attributes for the generated tag. If the type attribute is html, rss, atom, or icon, the mime-type is returned.
string|null
A completed <link />
element, or null if the element was sent to a block.
nestedList(array $list, array $options, array $itemOptions)
Build a nested list (UL/OL) out of an associative array.
Options for $options:
tag
- Type of list tag to use (ol/ul)Options for $itemOptions:
even
- Class to use for even rows.odd
- Class to use for odd rows.array
$list Set of elements to list
array
$options optional Options and additional HTML attributes of the list (ol/ul) tag.
array
$itemOptions optional Options and additional HTML attributes of the list item (LI) tag.
string
The nested list
para(?string $class, ?string $text, array $options)
Returns a formatted P tag.
escape
Whether or not the contents should be html_entity escaped.string|null
$class CSS class name of the p element.
string|null
$text String content that will appear inside the p element.
array
$options optional Additional HTML attributes of the P tag
string
The formatted P element
script(mixed $url, array $options)
Returns one or many <script>
tags depending on the number of scripts given.
If the filename is prefixed with "/", the path will be relative to the base path of your application. Otherwise, the path will be relative to your JavaScript path, usually webroot/js.
Include one script file:
echo $this->Html->script('styles.js');
Include multiple script files:
echo $this->Html->script(['one.js', 'two.js']);
Add the script file to a custom block:
$this->Html->script('styles.js', ['block' => 'bodyScript']);
block
Set to true to append output to view block "script" or provide custom block name.once
Whether or not the script should be checked for uniqueness. If true scripts will only be included once, use false to allow the same script to be included more than once per request.plugin
False value will prevent parsing path as a pluginfullBase
If true the url will get a full address for the script file.string|string[]
$url String or array of javascript files to include
array
$options optional Array of options, and html attributes see above.
string|null
String of <script />
tags or null if block is specified in options or if $once is true and the file has been included before.
scriptBlock(string $script, array $options)
Wrap $script in a script tag.
block
Set to true to append output to view block "script" or provide custom block name.string
$script The script to wrap
array
$options optional The options to use. Options not listed above will be treated as HTML attributes.
string|null
String or null depending on the value of $options['block']
scriptEnd()
End a Buffered section of JavaScript capturing.
Generates a script tag inline or appends to specified view block depending on the settings used when the scriptBlock was started
string|null
Depending on the settings of scriptStart() either a script tag or null
scriptStart(array $options)
Begin a script block that captures output until HtmlHelper::scriptEnd() is called. This capturing block will capture all output between the methods and create a scriptBlock from it.
block
Set to true to append output to view block "script" or provide custom block name.array
$options optional Options for the code block.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
setTemplates(array $templates)
Sets templates to use.
string[]
$templates Templates to be added.
$this
style(array $data, bool $oneLine)
Builds CSS style data from an array of CSS properties
echo $this->Html->style(['margin' => '10px', 'padding' => '10px'], true); // creates 'margin:10px;padding:10px;'
array
$data Style data array, keys will be used as property names, values as property values.
bool
$oneLine optional Whether or not the style block should be displayed on one line.
string
CSS styling data
tableCell(string $content, array $options)
Renders a single table cell (A TD with attributes).
string
$content The content of the cell.
array
$options optional HTML attributes.
string
tableCells(mixed $data, mixed $oddTrOptions, mixed $evenTrOptions, bool $useCount, bool $continueOddEven)
Returns a formatted string of table rows (TR's with TD's in them).
array|string
$data Array of table data
array|bool|null
$oddTrOptions optional HTML options for odd TR elements if true useCount is used
array|bool|null
$evenTrOptions optional HTML options for even TR elements
bool
$useCount optional adds class "column-$i"
bool
$continueOddEven optional If false, will use a non-static $count variable, so that the odd/even count is reset to zero just for that call.
string
Formatted HTML
tableHeaders(array $names, ?array $trOptions, ?array $thOptions)
Returns a row of formatted and named TABLE headers.
array
$names Array of tablenames. Each tablename can be string, or array with name and an array with a set of attributes to its specific tag
array|null
$trOptions optional HTML options for TR elements.
array|null
$thOptions optional HTML options for TH elements.
string
Completed table headers
tableRow(string $content, array $options)
Renders a single table row (A TR with attributes).
string
$content The content of the row.
array
$options optional HTML attributes.
string
tag(string $name, ?string $text, array $options)
Returns a formatted block tag, i.e DIV, SPAN, P.
escape
Whether or not the contents should be html_entity escaped.string
$name Tag name.
string|null
$text optional String content that will appear inside the div element. If null, only a start tag will be printed
array
$options optional Additional HTML attributes of the DIV tag, see above.
string
The formatted tag element
templater()
Returns the templater instance.
\Cake\View\StringTemplate
\Cake\View\Helper\UrlHelper
The View instance this helper is attached to
\Cake\View\View
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this class
array
A helper lookup table used to lazy load helper objects.
array
Names of script & css files that have been included once
array
Options for the currently opened script block buffer if any.
array
StringTemplate instance.
\Cake\View\StringTemplate
List of helpers used by this helper
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.View.Helper.HtmlHelper.html