---
title: "Phalcon Html"
version: "5.23"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Html
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Html\Attributes
Class
This class helps to work with HTML Attributes
@extends Collection<mixed>
- [`Phalcon\Support\Collection`](/5.23/api/phalcon_support/#supportcollection)
- **`Phalcon\Html\Attributes`** - implements [`Phalcon\Html\Attributes\RenderInterface`](#htmlattributesrenderinterface)
`Phalcon\Html\Attributes\RenderInterface` · `Phalcon\Html\Escaper\AttributeEscaper` · `Phalcon\Html\Exceptions\AttributeNotRenderable` · `Phalcon\Support\Collection`
### Method Summary
- `public __toString(): string` — Alias of the render method
- `public render(): string` — Render attributes as HTML attributes
- `protected renderAttributes(array $attributes): string` — @todo remove this when we refactor forms. Maybe remove this class? Put it into traits
### Methods
__toString()
```php
public function __toString(): string;
```
Alias of the render method
render()
```php
public function render(): string;
```
Render attributes as HTML attributes
renderAttributes()
```php
protected function renderAttributes( array $attributes ): string;
```
@todo remove this when we refactor forms. Maybe remove this class? Put it into traits
## Html\Attributes\AttributesInterface
Interface
Html Attributes Interface
- **`Phalcon\Html\Attributes\AttributesInterface`**
`Phalcon\Html\Attributes`
### Method Summary
- `public getAttributes(): Attributes` — Get Attributes
- `public setAttributes(Attributes $attributes): AttributesInterface` — Set Attributes
### Methods
getAttributes()
```php
public function getAttributes(): Attributes;
```
Get Attributes
setAttributes()
```php
public function setAttributes( Attributes $attributes ): AttributesInterface;
```
Set Attributes
## Html\Attributes\RenderInterface
Interface
Rendering interface for HTML attributes
- **`Phalcon\Html\Attributes\RenderInterface`**
### Method Summary
- `public render(): string` — Generate a string representation
### Methods
render()
```php
public function render(): string;
```
Generate a string representation
## Html\Breadcrumbs
Class
Phalcon\Html\Breadcrumbs
This component offers an easy way to create breadcrumbs for your application.
The resulting HTML when calling `render()` will have each breadcrumb enclosed
in `
` tags, while the whole string is enclosed in `
` tags.
- **`Phalcon\Html\Breadcrumbs`**
`Phalcon\Contracts\Html\HtmlTypes`
### Method Summary
- `public add(string $label, string $link = ""): static` — Adds a new crumb.
- `public clear(): void` — Clears the crumbs
- `public getSeparator(): string` — Returns the separator
- `public remove(string $link): void` — Removes crumb by url.
- `public render(): string` — Renders and outputs breadcrumbs based on previously set template.
- `public setSeparator(string $separator): static` — Set the separator
- `public toArray(): array` — Returns the internal breadcrumbs array
### Methods
add()
```php
public function add(
string $label,
string $link = ""
): static;
```
Adds a new crumb.
```php
// Adding a crumb with a link
$breadcrumbs->add("Home", "/");
// Adding a crumb without a link (normally the last one)
$breadcrumbs->add("Users");
```
Crumbs are stored keyed by their link, so adding two crumbs that share
the same link - including two link-less crumbs, which share the empty
string key - keeps only the last one.
clear()
```php
public function clear(): void;
```
Clears the crumbs
```php
$breadcrumbs->clear()
```
getSeparator()
```php
public function getSeparator(): string;
```
Returns the separator
remove()
```php
public function remove( string $link ): void;
```
Removes crumb by url.
```php
$breadcrumbs->remove("/admin/user/create");
// remove a crumb without an url (last link)
$breadcrumbs->remove();
```
render()
```php
public function render(): string;
```
Renders and outputs breadcrumbs based on previously set template.
```php
echo $breadcrumbs->render();
```
setSeparator()
```php
public function setSeparator( string $separator ): static;
```
Set the separator
toArray()
```php
public function toArray(): array;
```
Returns the internal breadcrumbs array
## Html\Escaper
Class
Phalcon\Html\Escaper
Escapes different kinds of text securing them. By using this component you
may prevent XSS attacks.
The class is a façade over five per-context escapers (`HtmlEscaper`,
`AttributeEscaper`, `CssEscaper`, `JsEscaper`, `UrlEscaper`). Each can be
retrieved via the matching `getXxxEscaper()` accessor and substituted via
the matching `setXxxEscaper()` setter. The legacy `setEncoding`,
`setFlags`, and `setDoubleEncode` continue to fan out to all sub-objects
so existing code keeps working.
This component only works with UTF-8. The PREG extension needs to be compiled
with UTF-8 support.
```php
$escaper = new \Phalcon\Html\Escaper();
$escaped = $escaper->css("font-family: ");
echo $escaped; // font\2D family\3A \20 \3C Verdana\3E
```
- **`Phalcon\Html\Escaper`** - implements [`Phalcon\Html\Escaper\EscaperInterface`](#htmlescaperescaperinterface)
`Phalcon\Contracts\Html\HtmlTypes` · `Phalcon\Html\Escaper\AttributeEscaper` · `Phalcon\Html\Escaper\CssEscaper` · `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Html\Escaper\HtmlEscaper` · `Phalcon\Html\Escaper\JsEscaper` · `Phalcon\Html\Escaper\UrlEscaper`
### Method Summary
- `public __construct(string $encoding = "utf-8", int $flags = 11, bool $doubleEncode = true)` — Constructor. Accepts the legacy scalar params for backward compatibility
- `public attributes(mixed $input = null): string` — Escapes a HTML attribute string or array. Delegates to `AttributeEscaper`.
- `public css(string $input): string` — Escape CSS strings. Delegates to `CssEscaper`.
- `public detectEncoding(string $input): string|null` — Detects the character encoding of a string. Delegates to `HtmlEscaper`.
- `public escapeCss(string $input): string`
- `public escapeHtml(string|null $input = null): string`
- `public escapeHtmlAttr(string|null $input = null): string`
- `public escapeJs(string $input): string`
- `public escapeUrl(string $input): string`
- `public getAttributeEscaper(): AttributeEscaper`
- `public getCssEscaper(): CssEscaper`
- `public getEncoding(): string` — Returns the encoding from the HtmlEscaper.
- `public getFlags(): int` — Returns the flags from the HtmlEscaper.
- `public getHtmlEscaper(): HtmlEscaper`
- `public getJsEscaper(): JsEscaper`
- `public getUrlEscaper(): UrlEscaper`
- `public html(string|null $input = null): string` — Escapes a HTML string. Delegates to `HtmlEscaper`.
- `public js(string $input): string` — Escape javascript strings. Delegates to `JsEscaper`.
- `public normalizeEncoding(string $input): string` — Normalizes a string's encoding to UTF-32. Delegates to `HtmlEscaper`.
- `public setAttributeEscaper(AttributeEscaper $escaper): static`
- `public setCssEscaper(CssEscaper $escaper): static`
- `public setDoubleEncode(bool $doubleEncode): static` — Sets the double\_encode flag. Fans out to all sub-escapers.
- `public setEncoding(string $encoding): static` — Sets the encoding. Fans out to all sub-escapers.
- `public setFlags(int $flags): static` — Sets the htmlspecialchars flags. Fans out to all sub-escapers.
- `public setHtmlEscaper(HtmlEscaper $escaper): static`
- `public setHtmlQuoteType(int $flags): static` — Sets the HTML quoting type for htmlspecialchars.
- `public setJsEscaper(JsEscaper $escaper): static`
- `public setUrlEscaper(UrlEscaper $escaper): static`
- `public url(string $input): string` — Escapes a URL. Delegates to `UrlEscaper`.
### Properties
- `protected AttributeEscaper $attributeEscaper`
- `protected CssEscaper $cssEscaper`
- `protected HtmlEscaper $htmlEscaper`
- `protected JsEscaper $jsEscaper`
- `protected UrlEscaper $urlEscaper`
### Methods
__construct()
```php
public function __construct(
string $encoding = "utf-8",
int $flags = 11,
bool $doubleEncode = true
);
```
Constructor. Accepts the legacy scalar params for backward compatibility
and fans them out to every sub-escaper so existing code keeps working.
attributes()
```php
public function attributes( mixed $input = null ): string;
```
Escapes a HTML attribute string or array. Delegates to `AttributeEscaper`.
css()
```php
public function css( string $input ): string;
```
Escape CSS strings. Delegates to `CssEscaper`.
detectEncoding()
```php
final public function detectEncoding( string $input ): string|null;
```
Detects the character encoding of a string. Delegates to `HtmlEscaper`.
escapeCss()
```php
public function escapeCss( string $input ): string;
```
escapeHtml()
```php
public function escapeHtml( string|null $input = null ): string;
```
escapeHtmlAttr()
```php
public function escapeHtmlAttr( string|null $input = null ): string;
```
escapeJs()
```php
public function escapeJs( string $input ): string;
```
escapeUrl()
```php
public function escapeUrl( string $input ): string;
```
getAttributeEscaper()
```php
public function getAttributeEscaper(): AttributeEscaper;
```
getCssEscaper()
```php
public function getCssEscaper(): CssEscaper;
```
getEncoding()
```php
public function getEncoding(): string;
```
Returns the encoding from the HtmlEscaper.
getFlags()
```php
public function getFlags(): int;
```
Returns the flags from the HtmlEscaper.
getHtmlEscaper()
```php
public function getHtmlEscaper(): HtmlEscaper;
```
getJsEscaper()
```php
public function getJsEscaper(): JsEscaper;
```
getUrlEscaper()
```php
public function getUrlEscaper(): UrlEscaper;
```
html()
```php
public function html( string|null $input = null ): string;
```
Escapes a HTML string. Delegates to `HtmlEscaper`.
js()
```php
public function js( string $input ): string;
```
Escape javascript strings. Delegates to `JsEscaper`.
normalizeEncoding()
```php
final public function normalizeEncoding( string $input ): string;
```
Normalizes a string's encoding to UTF-32. Delegates to `HtmlEscaper`.
setAttributeEscaper()
```php
public function setAttributeEscaper( AttributeEscaper $escaper ): static;
```
setCssEscaper()
```php
public function setCssEscaper( CssEscaper $escaper ): static;
```
setDoubleEncode()
```php
public function setDoubleEncode( bool $doubleEncode ): static;
```
Sets the double_encode flag. Fans out to all sub-escapers.
setEncoding()
```php
public function setEncoding( string $encoding ): static;
```
Sets the encoding. Fans out to all sub-escapers.
setFlags()
```php
public function setFlags( int $flags ): static;
```
Sets the htmlspecialchars flags. Fans out to all sub-escapers.
setHtmlEscaper()
```php
public function setHtmlEscaper( HtmlEscaper $escaper ): static;
```
setHtmlQuoteType()
```php
public function setHtmlQuoteType( int $flags ): static;
```
Sets the HTML quoting type for htmlspecialchars.
setJsEscaper()
```php
public function setJsEscaper( JsEscaper $escaper ): static;
```
setUrlEscaper()
```php
public function setUrlEscaper( UrlEscaper $escaper ): static;
```
url()
```php
public function url( string $input ): string;
```
Escapes a URL. Delegates to `UrlEscaper`.
## Html\EscaperFactory
Class
Class EscaperFactory
- **`Phalcon\Html\EscaperFactory`**
### Method Summary
- `public newInstance(): Escaper` — Create a new instance of the object
### Methods
newInstance()
```php
public function newInstance(): Escaper;
```
Create a new instance of the object
## Html\Escaper\AbstractEscaper
Abstract
Shared base for the per-context escaper objects.
@todo Remove in v7. Kept only for backwards compatibility; compose
Phalcon\Html\Escaper\Traits\EscaperTrait directly instead of extending this.
- **`Phalcon\Html\Escaper\AbstractEscaper`**
- [`Phalcon\Html\Escaper\AttributeEscaper`](#htmlescaperattributeescaper)
- [`Phalcon\Html\Escaper\CssEscaper`](#htmlescapercssescaper)
- [`Phalcon\Html\Escaper\HtmlEscaper`](#htmlescaperhtmlescaper)
- [`Phalcon\Html\Escaper\JsEscaper`](#htmlescaperjsescaper)
- [`Phalcon\Html\Escaper\UrlEscaper`](#htmlescaperurlescaper)
`Phalcon\Html\Escaper\Traits\EscaperTrait`
## Html\Escaper\AttributeEscaper
Class
Escapes either a single attribute value (string) or an associative array
of attribute pairs. Boolean `true` becomes a bare key (e.g. `disabled`);
`false` and `null` skip the entry; arrays are joined with a space.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\AttributeEscaper`**
`Phalcon\Contracts\Html\HtmlTypes`
### Method Summary
- `public __invoke(mixed $input = null): string`
- `public escape(mixed $input = null): string`
- `protected escapeValue(string $input): string` — Encodes a single key/value via `htmlspecialchars`.
### Methods
__invoke()
```php
public function __invoke( mixed $input = null ): string;
```
escape()
```php
public function escape( mixed $input = null ): string;
```
escapeValue()
```php
protected function escapeValue( string $input ): string;
```
Encodes a single key/value via `htmlspecialchars`.
## Html\Escaper\CssEscaper
Class
Escapes a string for use inside a CSS value by replacing non-alphanumeric
characters with their hexadecimal escape sequence.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\CssEscaper`**
### Method Summary
- `public __invoke(string $input): string`
- `public escape(string $input): string`
### Methods
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
public function escape( string $input ): string;
```
## Html\Escaper\EscaperInterface
Interface
Interface for Phalcon\Html\Escaper.
This declares the stable context-escaping surface. The concrete
\{@see \Phalcon\Html\Escaper\} facade also exposes members that are not part
of this contract - `setDoubleEncode()`, `getFlags()`, and the per-context
sub-escaper getters/setters (`getHtmlEscaper()`, `setAttributeEscaper()`,
and the rest). Type against the concrete class to reach those.
- **`Phalcon\Html\Escaper\EscaperInterface`**
### Method Summary
- `public attributes(string $input): string` — Escapes a HTML attribute string.
- `public css(string $input): string` — Escape CSS strings by replacing non-alphanumeric chars by their
- `public getEncoding(): string` — Returns the internal encoding used by the escaper
- `public html(string $input): string` — Escapes a HTML string.
- `public js(string $input): string` — Escape Javascript strings by replacing non-alphanumeric chars by their
- `public setEncoding(string $encoding): EscaperInterface` — Sets the encoding to be used by the escaper
- `public setFlags(int $flags): EscaperInterface` — Sets the HTML quoting type for htmlspecialchars
- `public url(string $input): string` — Escapes a URL. Internally uses rawurlencode
### Methods
attributes()
```php
public function attributes( string $input ): string;
```
Escapes a HTML attribute string.
The concrete \{@see \Phalcon\Html\Escaper\} also accepts an array of
attribute pairs and tolerates `null`: an array is rendered as escaped
`key="value"` pairs, `null` and `false` values are skipped, and `true`
renders as a bare key. Callers typed against this interface pass a
string. The widened signature lands in the next major.
css()
```php
public function css( string $input ): string;
```
Escape CSS strings by replacing non-alphanumeric chars by their
hexadecimal representation
getEncoding()
```php
public function getEncoding(): string;
```
Returns the internal encoding used by the escaper
html()
```php
public function html( string $input ): string;
```
Escapes a HTML string.
The concrete \{@see \Phalcon\Html\Escaper\} tolerates `null`, returning an
empty string for it. The nullable signature lands in the next major.
js()
```php
public function js( string $input ): string;
```
Escape Javascript strings by replacing non-alphanumeric chars by their
hexadecimal representation
setEncoding()
```php
public function setEncoding( string $encoding ): EscaperInterface;
```
Sets the encoding to be used by the escaper
setFlags()
```php
public function setFlags( int $flags ): EscaperInterface;
```
Sets the HTML quoting type for htmlspecialchars
url()
```php
public function url( string $input ): string;
```
Escapes a URL. Internally uses rawurlencode
## Html\Escaper\Exception
Class
Class Exception
- `\Exception`
- **`Phalcon\Html\Escaper\Exception`**
## Html\Escaper\HtmlEscaper
Class
Escapes a string for use as HTML body content via `htmlspecialchars`.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\HtmlEscaper`**
### Method Summary
- `public __invoke(string|null $input = null): string`
- `public escape(string|null $input = null): string`
### Methods
__invoke()
```php
public function __invoke( string|null $input = null ): string;
```
escape()
```php
public function escape( string|null $input = null ): string;
```
## Html\Escaper\JsEscaper
Class
Escapes a string for use inside a JavaScript context by replacing
non-alphanumeric characters with their hexadecimal escape sequence.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\JsEscaper`**
### Method Summary
- `public __invoke(string $input): string`
- `public escape(string $input): string`
### Methods
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
public function escape( string $input ): string;
```
## Html\Escaper\Traits\EscaperTrait
Trait
Shared encoding/flags state and the encoding detection/normalization
utilities used by the per-context escaper objects (`HtmlEscaper`,
`AttributeEscaper`, `CssEscaper`, `JsEscaper`, `UrlEscaper`).
- **`Phalcon\Html\Escaper\Traits\EscaperTrait`**
[`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
### Method Summary
- `public detectEncoding(string $input): string|null` — Detects the character encoding of a string. Special-handling for
- `public getDoubleEncode(): bool`
- `public getEncoding(): string`
- `public getFlags(): int`
- `public normalizeEncoding(string $input): string` — Normalizes a string's encoding to UTF-32, used by the CSS and JS
- `public setDoubleEncode(bool $doubleEncode): static`
- `public setEncoding(string $encoding): static`
- `public setFlags(int $flags): static`
### Properties
- `protected bool $doubleEncode = true`
- `protected string $encoding = "utf-8"`
- `protected int $flags = 11` — ENT\_QUOTES | ENT\_SUBSTITUTE | ENT\_HTML401
### Methods
detectEncoding()
```php
final public function detectEncoding( string $input ): string|null;
```
Detects the character encoding of a string. Special-handling for
chr(172) and chr(128) to chr(159) which fail to be detected by
`mb_detect_encoding()`.
getDoubleEncode()
```php
public function getDoubleEncode(): bool;
```
getEncoding()
```php
public function getEncoding(): string;
```
getFlags()
```php
public function getFlags(): int;
```
normalizeEncoding()
```php
final public function normalizeEncoding( string $input ): string;
```
Normalizes a string's encoding to UTF-32, used by the CSS and JS
escapers before invoking the C-level escape routines.
setDoubleEncode()
```php
public function setDoubleEncode( bool $doubleEncode ): static;
```
setEncoding()
```php
public function setEncoding( string $encoding ): static;
```
setFlags()
```php
public function setFlags( int $flags ): static;
```
## Html\Escaper\UrlEscaper
Class
Escapes a string for use as a URL component via `rawurlencode`.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\UrlEscaper`**
`Phalcon\Traits\Php\UrlTrait`
### Method Summary
- `public __invoke(string $input): string`
- `public escape(string $input): string`
### Methods
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
public function escape( string $input ): string;
```
## Html\Exception
Class
Class Exception
- `\Exception`
- **`Phalcon\Html\Exception`**
- [`Phalcon\Html\Exceptions\AttributeNotRenderable`](#htmlexceptionsattributenotrenderable)
- [`Phalcon\Html\Exceptions\FriendlyTitleConversionFailed`](#htmlexceptionsfriendlytitleconversionfailed)
- [`Phalcon\Html\Exceptions\ServiceNotRegistered`](#htmlexceptionsservicenotregistered)
## Html\Exceptions\AttributeNotRenderable
Class
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\AttributeNotRenderable`**
`Phalcon\Html\Exception`
### Method Summary
- `public __construct(string $key, string $type)`
### Methods
__construct()
```php
public function __construct(
string $key,
string $type
);
```
## Html\Exceptions\FriendlyTitleConversionFailed
Class
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\FriendlyTitleConversionFailed`**
`Phalcon\Html\Exception`
### Method Summary
- `public __construct(string $message)`
### Methods
__construct()
```php
public function __construct( string $message );
```
## Html\Exceptions\InvalidResultsetValue
Class
- `\InvalidArgumentException`
- **`Phalcon\Html\Exceptions\InvalidResultsetValue`**
`InvalidArgumentException`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Html\Exceptions\ServiceNotRegistered
Class
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\ServiceNotRegistered`**
`Phalcon\Html\Exception`
### Method Summary
- `public __construct(string $name)`
### Methods
__construct()
```php
public function __construct( string $name );
```
## Html\Exceptions\UsingRequiresTwoValues
Class
- `\InvalidArgumentException`
- **`Phalcon\Html\Exceptions\UsingRequiresTwoValues`**
`InvalidArgumentException`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Html\Helper\AbstractHelper
Abstract
- **`Phalcon\Html\Helper\AbstractHelper`**
- [`Phalcon\Html\Helper\AbstractList`](#htmlhelperabstractlist)
- [`Phalcon\Html\Helper\AbstractSeries`](#htmlhelperabstractseries)
- [`Phalcon\Html\Helper\Anchor`](#htmlhelperanchor)
- [`Phalcon\Html\Helper\Base`](#htmlhelperbase)
- [`Phalcon\Html\Helper\Body`](#htmlhelperbody)
- [`Phalcon\Html\Helper\Breadcrumbs`](#htmlhelperbreadcrumbs)
- [`Phalcon\Html\Helper\Button`](#htmlhelperbutton)
- [`Phalcon\Html\Helper\Close`](#htmlhelperclose)
- [`Phalcon\Html\Helper\Element`](#htmlhelperelement)
- [`Phalcon\Html\Helper\Form`](#htmlhelperform)
- [`Phalcon\Html\Helper\FriendlyTitle`](#htmlhelperfriendlytitle)
- [`Phalcon\Html\Helper\Img`](#htmlhelperimg)
- [`Phalcon\Html\Helper\Input\AbstractGroup`](#htmlhelperinputabstractgroup)
- [`Phalcon\Html\Helper\Input\AbstractInput`](#htmlhelperinputabstractinput)
- [`Phalcon\Html\Helper\Label`](#htmlhelperlabel)
- [`Phalcon\Html\Helper\Preload`](#htmlhelperpreload)
- [`Phalcon\Html\Helper\Tag`](#htmlhelpertag)
- [`Phalcon\Html\Helper\Title`](#htmlhelpertitle)
- [`Phalcon\Html\Helper\VoidTag`](#htmlhelpervoidtag)
`Phalcon\Contracts\Html\HtmlTypes` · `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Html\Exception`
### Method Summary
- `public __construct(EscaperInterface $escaper, Doctype|null $doctype = null)` — AbstractHelper constructor.
- `protected close(string $tag, bool $raw = false): string` — Produces a closing tag
- `protected escapeName(string $name): string` — Removes the characters that end a tag or attribute name (white space,
- `protected indent(): string` — Replicates the indent x times as per indentLevel
- `protected injectAttribute(string $key, string $value, array $attributes): array` — Forces `$key => $value` to the front of the attributes array,
- `protected orderAttributes(array $overrides, array $attributes): array` — Keeps all the attributes sorted - same order all the time
- `protected renderArrayElements(array $elements, string $delimiter): string` — Traverses an array and calls the method defined in the first element
- `protected renderAttributes(array $attributes): string` — Renders all the attributes
- `protected renderElement(string $tag, array $attributes = []): string` — Renders an element
- `protected renderFullElement(string $tag, string $text, array $attributes = [], bool $raw = false): string` — Renders an element
- `protected renderTag(string $tag, array $attributes = [], string $close = ""): string` — Renders a tag
- `protected selfClose(string $tag, array $attributes = []): string` — Produces a self close tag i.e.
### Properties
- `protected string $delimiter = ""`
- `protected Doctype|null $doctype = null`
- `protected EscaperInterface $escaper`
- `protected string $indent = " "`
- `protected int $indentLevel = 1`
### Methods
__construct()
```php
public function __construct(
EscaperInterface $escaper,
Doctype|null $doctype = null
);
```
AbstractHelper constructor.
close()
```php
protected function close(
string $tag,
bool $raw = false
): string;
```
Produces a closing tag
escapeName()
```php
protected function escapeName( string $name ): string;
```
Removes the characters that end a tag or attribute name (white space,
"/", "=") and escapes the rest, so a crafted name cannot break out of
its position.
indent()
```php
protected function indent(): string;
```
Replicates the indent x times as per indentLevel
injectAttribute()
```php
protected function injectAttribute(
string $key,
string $value,
array $attributes
): array;
```
Forces `$key => $value` to the front of the attributes array,
removing any existing entry for that key. This guarantees the
attribute is always present and appears first in the rendered output.
orderAttributes()
```php
protected function orderAttributes(
array $overrides,
array $attributes
): array;
```
Keeps all the attributes sorted - same order all the time
renderArrayElements()
```php
protected function renderArrayElements(
array $elements,
string $delimiter
): string;
```
Traverses an array and calls the method defined in the first element
with attributes as the second, returning the resulting string
renderAttributes()
```php
protected function renderAttributes( array $attributes ): string;
```
Renders all the attributes
renderElement()
```php
protected function renderElement(
string $tag,
array $attributes = []
): string;
```
Renders an element
renderFullElement()
```php
protected function renderFullElement(
string $tag,
string $text,
array $attributes = [],
bool $raw = false
): string;
```
Renders an element
renderTag()
```php
protected function renderTag(
string $tag,
array $attributes = [],
string $close = ""
): string;
```
Renders a tag
selfClose()
```php
protected function selfClose(
string $tag,
array $attributes = []
): string;
```
Produces a self close tag i.e.
## Html\Helper\AbstractList
Abstract
Class AbstractList
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\AbstractList`**
- [`Phalcon\Html\Helper\Input\Select`](#htmlhelperinputselect)
- [`Phalcon\Html\Helper\Ol`](#htmlhelperol)
`Phalcon\Contracts\Html\HtmlTypes`
### Method Summary
- `public __invoke(string $indent = " ", string|null $delimiter = null, array $attributes = []): static`
- `public __toString()` — Generates and returns the HTML for the list.
- `protected getTag(): string` — Returns the tag name.
### Properties
- `protected array $attributes = []`
- `protected string $elementTag = "li"`
- `protected array $store = []`
### Methods
__invoke()
```php
public function __invoke(
string $indent = " ",
string|null $delimiter = null,
array $attributes = []
): static;
```
__toString()
```php
public function __toString();
```
Generates and returns the HTML for the list.
getTag()
```php
abstract protected function getTag(): string;
```
Returns the tag name.
## Html\Helper\AbstractSeries
Abstract
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\AbstractSeries`**
- [`Phalcon\Html\Helper\Meta`](#htmlhelpermeta)
- [`Phalcon\Html\Helper\Script`](#htmlhelperscript)
- [`Phalcon\Html\Helper\Style`](#htmlhelperstyle)
`Phalcon\Contracts\Html\HtmlTypes`
### Method Summary
- `public __invoke(string $indent = " ", string|null $delimiter = null): static`
- `public __toString()` — Generates and returns the HTML for the list. Entries are sorted by
- `public reset(): static` — Resets the internal store.
- `protected getTag(): string` — Returns the tag name.
- `protected pushOrPlace(array $entry, int $position = -1): void` — Appends an entry to the store, optionally at a specific integer
### Properties
- `protected array $attributes = []`
- `protected array $store = []`
### Methods
__invoke()
```php
public function __invoke(
string $indent = " ",
string|null $delimiter = null
): static;
```
__toString()
```php
public function __toString();
```
Generates and returns the HTML for the list. Entries are sorted by
their integer key first, so an asset registered with a lower position
renders before one registered with a higher position regardless of
registration order.
reset()
```php
public function reset(): static;
```
Resets the internal store.
getTag()
```php
abstract protected function getTag(): string;
```
Returns the tag name.
pushOrPlace()
```php
protected function pushOrPlace(
array $entry,
int $position = -1
): void;
```
Appends an entry to the store, optionally at a specific integer
position. When `$pos` is negative the entry is pushed onto the next
available auto-increment slot. When `$pos` is non-negative the entry
is placed at that key, advancing past any already-occupied slots so
existing entries are not overwritten. The store is ksort()ed in
`__toString`, so positions act as a sort key, not a strict address.
## Html\Helper\Anchor
Class
Class Anchor
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\Anchor`**
`Phalcon\Contracts\Html\HtmlTypes` · `Phalcon\Html\Escaper\EscaperInterface`
### Method Summary
- `public __construct(EscaperInterface $escaper, Doctype|null $doctype = null, bool $forceRaw = false)`
- `public __invoke(string $href, string $text, array $attributes = [], bool $raw = false): string` — Produce a `` tag
### Properties
- `protected bool $forceRaw = false`
### Methods