--- title: "Phalcon Html" version: "5.13" --- > 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 [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes.zep) - __Namespace__ - `Phalcon\Html` - __Uses__ - `Phalcon\Html\Attributes\RenderInterface` - `Phalcon\Support\Collection` - __Extends__ `Collection` - __Implements__ - `RenderInterface` This class helps to work with HTML Attributes ### Methods ```php public function __toString(): string; ``` Alias of the render method ```php public function render(): string; ``` Render attributes as HTML attributes ```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](/assets/images/interface-blue.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes/AttributesInterface.zep) - __Namespace__ - `Phalcon\Html\Attributes` - __Uses__ - `Phalcon\Html\Attributes` - __Extends__ - __Implements__ * Phalcon\Html\Attributes\AttributesInterface * * Interface Phalcon\Html\Attributes\AttributesInterface */ ### Methods ```php public function getAttributes(): Attributes; ``` Get Attributes ```php public function setAttributes( Attributes $attributes ): AttributesInterface; ``` Set Attributes ## Html\Attributes\RenderInterface ![Interface](/assets/images/interface-blue.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes/RenderInterface.zep) - __Namespace__ - `Phalcon\Html\Attributes` - __Uses__ - __Extends__ - __Implements__ * Phalcon\Html\Attributes\RenderInterface * * Interface Phalcon\Html\Attributes\RenderInterface */ ### Methods ```php public function render(): string; ``` Generate a string represetation ## Html\Breadcrumbs [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Breadcrumbs.zep) - __Namespace__ - `Phalcon\Html` - __Uses__ - `Phalcon\Di\DiInterface` - __Extends__ - __Implements__ 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. @deprecated Will be removed in future version Use \{@see Phalcon\Html\Helper\Breadcrumbs\} instead. ### Properties ```php /** * Keeps all the breadcrumbs * * @var array */ private $elements; /** * Crumb separator * * @var string */ private $separator = / ; /** * The HTML template to use to render the breadcrumbs. * * @var string */ private $template =
%label%
; ``` ### Methods ```php public function add( string $label, string $link = string ): Breadcrumbs; ``` 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"); ``` ```php public function clear(): void; ``` Clears the crumbs ```php $breadcrumbs->clear() ``` ```php public function getSeparator(): string; ``` Crumb separator ```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(); ``` ```php public function render(): string; ``` Renders and outputs breadcrumbs based on previously set template. ```php echo $breadcrumbs->render(); ``` ```php public function setSeparator( string $separator ): Breadcrumbs; ``` ```php public function toArray(): array; ``` Returns the internal breadcrumbs array ## Html\Escaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper.zep) - __Namespace__ - `Phalcon\Html` - __Uses__ - `Phalcon\Html\Escaper\AttributeEscaper` - `Phalcon\Html\Escaper\CssEscaper` - `Phalcon\Html\Escaper\EscaperInterface` - `Phalcon\Html\Escaper\HtmlEscaper` - `Phalcon\Html\Escaper\JsEscaper` - `Phalcon\Html\Escaper\UrlEscaper` - __Extends__ - __Implements__ - `EscaperInterface` 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 ``` @property AttributeEscaper $attributeEscaper @property CssEscaper $cssEscaper @property HtmlEscaper $htmlEscaper @property JsEscaper $jsEscaper @property UrlEscaper $urlEscaper ### Properties ```php /** * @var AttributeEscaper */ protected $attributeEscaper; /** * @var CssEscaper */ protected $cssEscaper; /** * @var HtmlEscaper */ protected $htmlEscaper; /** * @var JsEscaper */ protected $jsEscaper; /** * @var UrlEscaper */ protected $urlEscaper; ``` ### Methods ```php public function __construct(); ``` ```php public function attributes( mixed $input ): string; ``` Escapes a HTML attribute string or array. Delegates to the configured `AttributeEscaper`. ```php public function css( string $input ): string; ``` Escape CSS strings. Delegates to the configured `CssEscaper`. ```php final public function detectEncoding( string $input ): string | null; ``` ```php public function escapeCss( string $input ): string; ``` ```php public function escapeHtml( string $input = null ): string; ``` ```php public function escapeHtmlAttr( string $input = null ): string; ``` ```php public function escapeJs( string $input ): string; ``` ```php public function escapeUrl( string $input ): string; ``` ```php public function getAttributeEscaper(): AttributeEscaper; ``` ```php public function getCssEscaper(): CssEscaper; ``` ```php public function getEncoding(): string; ``` ```php public function getFlags(): int; ``` ```php public function getHtmlEscaper(): HtmlEscaper; ``` ```php public function getJsEscaper(): JsEscaper; ``` ```php public function getUrlEscaper(): UrlEscaper; ``` ```php public function html( string $input = null ): string; ``` Escapes a HTML string. Delegates to the configured `HtmlEscaper`. ```php public function js( string $input ): string; ``` Escape javascript strings. Delegates to the configured `JsEscaper`. ```php final public function normalizeEncoding( string $input ): string; ``` ```php public function setAttributeEscaper( AttributeEscaper $escaper ): Escaper; ``` ```php public function setCssEscaper( CssEscaper $escaper ): Escaper; ``` ```php public function setDoubleEncode( bool $doubleEncode ): Escaper; ``` Sets the double_encode flag. Fans out to all sub-objects. ```php public function setEncoding( string $encoding ): EscaperInterface; ``` Sets the encoding. Fans out to all sub-objects. ```php public function setFlags( int $flags ): EscaperInterface; ``` Sets the htmlspecialchars flags. Fans out to all sub-objects. ```php public function setHtmlEscaper( HtmlEscaper $escaper ): Escaper; ``` ```php public function setHtmlQuoteType( int $flags ): EscaperInterface; ``` ```php public function setJsEscaper( JsEscaper $escaper ): Escaper; ``` ```php public function setUrlEscaper( UrlEscaper $escaper ): Escaper; ``` ```php public function url( string $input ): string; ``` Escapes a URL. Delegates to the configured `UrlEscaper`. ## Html\Escaper\AbstractEscaper ![Abstract](/assets/images/abstract-green.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/AbstractEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ - __Implements__ Shared base for the per-context escaper objects. Holds the encoding, htmlspecialchars flag, and double-encode toggle, plus the encoding detection / normalization utilities used by the CSS and JS escapers. Each concrete context (`HtmlEscaper`, `AttributeEscaper`, `CssEscaper`, `JsEscaper`, `UrlEscaper`) extends this so that callers can configure one context without affecting the others. @property bool $doubleEncode @property string $encoding @property int $flags ### Properties ```php /** * @var bool */ protected $doubleEncode = true; /** * @var string */ protected $encoding = utf-8; /** * ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 * * @var int */ protected $flags = 11; ``` ### Methods ```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()`. ```php public function getDoubleEncode(): bool; ``` ```php public function getEncoding(): string; ``` ```php public function getFlags(): int; ``` ```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. ```php public function setDoubleEncode( bool $doubleEncode ); ``` ```php public function setEncoding( string $encoding ); ``` ```php public function setFlags( int $flags ); ``` ## Html\Escaper\AttributeEscaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/AttributeEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `AbstractEscaper` - __Implements__ 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. ### Methods ```php public function __invoke( mixed $input = null ): string; ``` ```php public function escape( mixed $input = null ): string; ``` ```php protected function escapeValue( string $input ): string; ``` Encodes a single key/value via `htmlspecialchars`. ## Html\Escaper\CssEscaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/CssEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `AbstractEscaper` - __Implements__ Escapes a string for use inside a CSS value by replacing non-alphanumeric characters with their hexadecimal escape sequence. Wraps the C-level `phalcon_escape_css` after normalising the input to UTF-32. ### Methods ```php public function __invoke( string $input ): string; ``` ```php public function escape( string $input ): string; ``` ## Html\Escaper\EscaperInterface ![Interface](/assets/images/interface-blue.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/EscaperInterface.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ - __Implements__ Interface for Phalcon\Html\Escaper ### Methods ```php public function attributes( string $input ): string; ``` Escapes a HTML attribute string ```php public function css( string $input ): string; ``` Escape CSS strings by replacing non-alphanumeric chars by their hexadecimal representation ```php public function getEncoding(): string; ``` Returns the internal encoding used by the escaper ```php public function html( string $input ): string; ``` Escapes a HTML string ```php public function js( string $input ): string; ``` Escape Javascript strings by replacing non-alphanumeric chars by their hexadecimal representation ```php public function setEncoding( string $encoding ): EscaperInterface; ``` Sets the encoding to be used by the escaper ```php public function setFlags( int $flags ): EscaperInterface; ``` Sets the HTML quoting type for htmlspecialchars ```php public function url( string $input ): string; ``` Escapes a URL. Internally uses rawurlencode ## Html\Escaper\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/Exception.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `\Exception` - __Implements__ Exceptions thrown in Phalcon\Html\Escaper will use this class ## Html\Escaper\HtmlEscaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/HtmlEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `AbstractEscaper` - __Implements__ Escapes a string for use as HTML body content via `htmlspecialchars`. ### Methods ```php public function __invoke( string $input = null ): string; ``` ```php public function escape( string $input = null ): string; ``` ## Html\Escaper\JsEscaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/JsEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `AbstractEscaper` - __Implements__ Escapes a string for use inside a JavaScript context by replacing non-alphanumeric characters with their hexadecimal escape sequence. Wraps the C-level `phalcon_escape_js` after normalising the input to UTF-32. ### Methods ```php public function __invoke( string $input ): string; ``` ```php public function escape( string $input ): string; ``` ## Html\Escaper\UrlEscaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/UrlEscaper.zep) - __Namespace__ - `Phalcon\Html\Escaper` - __Uses__ - __Extends__ `AbstractEscaper` - __Implements__ Escapes a string for use as a URL component via `rawurlencode`. The encoding/flags/doubleEncode setters are accepted for symmetry with the other contexts but have no effect on the output. ### Methods ```php public function __invoke( string $input ): string; ``` ```php public function escape( string $input ): string; ``` ## Html\EscaperFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/EscaperFactory.zep) - __Namespace__ - `Phalcon\Html` - __Uses__ - __Extends__ - __Implements__ Class EscaperFactory ### Methods ```php public function newInstance(): Escaper; ``` Create a new instance of the object ## Html\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Exception.zep) - __Namespace__ - `Phalcon\Html` - __Uses__ - __Extends__ `\Exception` - __Implements__ Phalcon\Html\Tag\Exception Exceptions thrown in Phalcon\Html\Tag will use this class ## Html\Helper\AbstractHelper ![Abstract](/assets/images/abstract-green.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractHelper.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Escaper\EscaperInterface` - `Phalcon\Html\Exception` - __Extends__ - __Implements__ @property string $delimiter @property EscaperInterface $escaper @property string $indent @property int $indentLevel ### Properties ```php /** * @var string */ protected $delimiter = ; /** * @var Doctype|null */ protected $doctype; /** * @var EscaperInterface */ protected $escaper; /** * @var string */ protected $indent = ; /** * @var int */ protected $indentLevel = 1; ``` ### Methods ```php public function __construct( EscaperInterface $escaper, Doctype $doctype = null ); ``` AbstractHelper constructor. ```php protected function close( string $tag, bool $raw = bool ): string; ``` Produces a closing tag ```php protected function indent(): string; ``` Replicates the indent x times as per indentLevel ```php protected function injectAttribute( string $key, string $value, array $attributes ): array; ``` Forces a single key into the attribute array, stripping any user-supplied value for that key first. Used by helpers whose first positional argument is itself an attribute (`href` for Anchor, `src` for Img, etc.) to make sure that argument always wins. ```php protected function orderAttributes( array $overrides, array $attributes ): array; ``` Keeps all the attributes sorted - same order all the tome ```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 ```php protected function renderAttributes( array $attributes ): string; ``` Renders all the attributes ```php protected function renderElement( string $tag, array $attributes = [] ): string; ``` Renders an element ```php protected function renderFullElement( string $tag, string $text, array $attributes = [], bool $raw = bool ): string; ``` Renders an element ```php protected function renderTag( string $tag, array $attributes = [], string $close = string ): string; ``` Renders a tag ```php protected function selfClose( string $tag, array $attributes = [] ): string; ``` Produces a self close tag i.e. ## Html\Helper\AbstractList ![Abstract](/assets/images/abstract-green.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractList.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Exception` - __Extends__ `AbstractHelper` - __Implements__ Class AbstractList ### Properties ```php /** * @var array */ protected $attributes; /** * @var string */ protected $elementTag = li; /** * @var array */ protected $store; ``` ### Methods ```php public function __invoke( string $indent = string, string $delimiter = null, array $attributes = [] ): AbstractList; ``` ```php public function __toString(); ``` Generates and returns the HTML for the list. ```php abstract protected function getTag(): string; ``` Returns the tag name. ## Html\Helper\AbstractSeries ![Abstract](/assets/images/abstract-green.svg) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractSeries.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - __Extends__ `AbstractHelper` - __Implements__ @property array $attributes @property array $store ### Properties ```php /** * @var array */ protected $attributes; /** * @var array */ protected $store; ``` ### Methods ```php public function __invoke( string $indent = string, string $delimiter = null ): AbstractSeries; ``` ```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. ```php public function reset(): AbstractSeries; ``` Resets the internal store. ```php abstract protected function getTag(): string; ``` Returns the tag name. ```php protected function pushOrPlace( array $entry, int $position = int ): void; ``` Appends an entry to the store, optionally at a specific integer position. When `position` is negative the entry is pushed onto the next available auto-increment slot. When `position` 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 [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Anchor.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Escaper\EscaperInterface` - `Phalcon\Html\Exception` - __Extends__ `AbstractHelper` - __Implements__ Class Anchor @property bool $forceRaw ### Properties ```php /** * @var bool */ protected $forceRaw = false; ``` ### Methods ```php public function __construct( EscaperInterface $escaper, Doctype $doctype = null, bool $forceRaw = bool ); ``` ```php public function __invoke( string $href, string $text, array $attributes = [], bool $raw = bool ): string; ``` Produce a <a> tag ## Html\Helper\Base [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Base.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Exception` - __Extends__ `AbstractHelper` - __Implements__ Class Base ### Methods ```php public function __invoke( string $href = null, array $attributes = [] ): string; ``` Produce a `` tag. ## Html\Helper\Body [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Body.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Exception` - __Extends__ `AbstractHelper` - __Implements__ Class Body ### Methods ```php public function __invoke( array $attributes = [] ): string; ``` Produce a `` tag. ## Html\Helper\Breadcrumbs [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Breadcrumbs.zep) - __Namespace__ - `Phalcon\Html\Helper` - __Uses__ - `Phalcon\Html\Escaper\EscaperInterface` - `Phalcon\Mvc\Url\UrlInterface` - `Phalcon\Support\Helper\Str\Interpolate` - __Extends__ `AbstractHelper` - __Implements__ 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 `