Phalcon Html

Html\Attributes

This class helps to work with HTML Attributes

Uses Phalcon\Html\Attributes\RenderInterface · Phalcon\Html\Escaper\AttributeEscaper · Phalcon\Html\Exceptions\AttributeNotRenderable · Phalcon\Support\Collection

Method Summary

Methods

__toString()

public function __toString(): string;

Alias of the render method

render()

public function render(): string;

Render attributes as HTML attributes

renderAttributes()

protected function renderAttributes( array $attributes ): string;

@todo remove this when we refactor forms. Maybe remove this class? Put it into traits

Html\Attributes\AttributesInterface

Html Attributes Interface

Uses Phalcon\Html\Attributes

Method Summary

Methods

getAttributes()

public function getAttributes(): Attributes;

Get Attributes

setAttributes()

public function setAttributes( Attributes $attributes ): AttributesInterface;

Set Attributes

Html\Attributes\RenderInterface

Rendering interface for HTML attributes

Method Summary

Methods

render()

public function render(): string;

Generate a string representation

Html\Breadcrumbs

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 <dt> tags, while the whole string is enclosed in <dl> tags.

Method Summary

Methods

add()

public function add(
    string $label,
    string $link = ""
): static;

Adds a new crumb.

// 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()

public function clear(): void;

Clears the crumbs

$breadcrumbs->clear()

getSeparator()

public function getSeparator(): string;

Crumb separator

remove()

public function remove( string $link ): void;

Removes crumb by url.

$breadcrumbs->remove("/admin/user/create");

// remove a crumb without an url (last link)
$breadcrumbs->remove();

render()

public function render(): string;

Renders and outputs breadcrumbs based on previously set template.

echo $breadcrumbs->render();

setSeparator()

public function setSeparator( string $separator ): static;

Set the separator

toArray()

public function toArray(): array;

Returns the internal breadcrumbs array

Html\Escaper

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.

$escaper = new \Phalcon\Html\Escaper();

$escaped = $escaper->css("font-family: <Verdana>");

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

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

Method Summary

Properties

Methods

__construct()

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()

public function attributes( mixed $input = null ): string;

Escapes a HTML attribute string or array. Delegates to the configured AttributeEscaper.

css()

public function css( string $input ): string;

Escape CSS strings. Delegates to the configured CssEscaper.

detectEncoding()

final public function detectEncoding( string $input ): string|null;

Detects the character encoding of a string. Delegates to HtmlEscaper.

escapeCss()

public function escapeCss( string $input ): string;

escapeHtml()

public function escapeHtml( string|null $input = null ): string;

escapeHtmlAttr()

public function escapeHtmlAttr( string|null $input = null ): string;

escapeJs()

public function escapeJs( string $input ): string;

escapeUrl()

public function escapeUrl( string $input ): string;

getAttributeEscaper()

public function getAttributeEscaper(): AttributeEscaper;

getCssEscaper()

public function getCssEscaper(): CssEscaper;

getEncoding()

public function getEncoding(): string;

Returns the encoding from the HtmlEscaper.

getFlags()

public function getFlags(): int;

Returns the flags from the HtmlEscaper.

getHtmlEscaper()

public function getHtmlEscaper(): HtmlEscaper;

getJsEscaper()

public function getJsEscaper(): JsEscaper;

getUrlEscaper()

public function getUrlEscaper(): UrlEscaper;

html()

public function html( string|null $input = null ): string;

Escapes a HTML string. Delegates to the configured HtmlEscaper.

js()

public function js( string $input ): string;

Escape javascript strings. Delegates to the configured JsEscaper.

normalizeEncoding()

final public function normalizeEncoding( string $input ): string;

Normalizes a string’s encoding to UTF-32. Delegates to HtmlEscaper.

setAttributeEscaper()

public function setAttributeEscaper( AttributeEscaper $escaper ): static;

setCssEscaper()

public function setCssEscaper( CssEscaper $escaper ): static;

setDoubleEncode()

public function setDoubleEncode( bool $doubleEncode ): static;

Sets the double_encode flag. Fans out to all sub-objects.

setEncoding()

public function setEncoding( string $encoding ): static;

Sets the encoding. Fans out to all sub-objects.

setFlags()

public function setFlags( int $flags ): static;

Sets the htmlspecialchars flags. Fans out to all sub-objects.

setHtmlEscaper()

public function setHtmlEscaper( HtmlEscaper $escaper ): static;

setHtmlQuoteType()

public function setHtmlQuoteType( int $flags ): static;

Sets the HTML quoting type for htmlspecialchars.

$escaper->setHtmlQuoteType(ENT_XHTML);

setJsEscaper()

public function setJsEscaper( JsEscaper $escaper ): static;

setUrlEscaper()

public function setUrlEscaper( UrlEscaper $escaper ): static;

url()

public function url( string $input ): string;

Escapes a URL. Delegates to the configured UrlEscaper.

Html\EscaperFactory

Class EscaperFactory

Method Summary

Methods

newInstance()

public function newInstance(): Escaper;

Create a new instance of the object

Html\Escaper\AbstractEscaper

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.

Uses Phalcon\Html\Escaper\Traits\EscaperTrait

Html\Escaper\AttributeEscaper

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.

Method Summary

Methods

__invoke()

public function __invoke( mixed $input = null ): string;

escape()

public function escape( mixed $input = null ): string;

escapeValue()

protected function escapeValue( string $input ): string;

Encodes a single key/value via htmlspecialchars.

Html\Escaper\CssEscaper

Escapes a string for use inside a CSS value by replacing non-alphanumeric characters with their hexadecimal escape sequence.

Method Summary

Methods

__invoke()

public function __invoke( string $input ): string;

escape()

public function escape( string $input ): string;

Html\Escaper\EscaperInterface

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.

Method Summary

Methods

attributes()

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()

public function css( string $input ): string;

Escape CSS strings by replacing non-alphanumeric chars by their hexadecimal representation

getEncoding()

public function getEncoding(): string;

Returns the internal encoding used by the escaper

html()

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()

public function js( string $input ): string;

Escape Javascript strings by replacing non-alphanumeric chars by their hexadecimal representation

setEncoding()

public function setEncoding( string $encoding ): EscaperInterface;

Sets the encoding to be used by the escaper

setFlags()

public function setFlags( int $flags ): EscaperInterface;

Sets the HTML quoting type for htmlspecialchars

url()

public function url( string $input ): string;

Escapes a URL. Internally uses rawurlencode

Html\Escaper\Exception

Class Exception

Html\Escaper\HtmlEscaper

Escapes a string for use as HTML body content via htmlspecialchars.

Method Summary

Methods

__invoke()

public function __invoke( string|null $input = null ): string;

escape()

public function escape( string|null $input = null ): string;

Html\Escaper\JsEscaper

Escapes a string for use inside a JavaScript context by replacing non-alphanumeric characters with their hexadecimal escape sequence.

Method Summary

Methods

__invoke()

public function __invoke( string $input ): string;

escape()

public function escape( string $input ): string;

Html\Escaper\Traits\EscaperTrait

Shared encoding/flags state and the encoding detection/normalization utilities used by the per-context escaper objects (HtmlEscaper, AttributeEscaper, CssEscaper, JsEscaper, UrlEscaper).

@property bool $doubleEncode @property string $encoding @property int $flags

Used by Phalcon\Html\Escaper\AbstractEscaper

Method Summary

Properties

Methods

detectEncoding()

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()

public function getDoubleEncode(): bool;

getEncoding()

public function getEncoding(): string;

getFlags()

public function getFlags(): int;

normalizeEncoding()

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()

public function setDoubleEncode( bool $doubleEncode ): static;

setEncoding()

public function setEncoding( string $encoding ): static;

setFlags()

public function setFlags( int $flags ): static;

Html\Escaper\UrlEscaper

Escapes a string for use as a URL component via rawurlencode.

Uses Phalcon\Traits\Php\UrlTrait

Method Summary

Methods

__invoke()

public function __invoke( string $input ): string;

escape()

public function escape( string $input ): string;

Html\Exception

Phalcon\Html\Exception

Exceptions thrown in Phalcon\Html will use this class

Html\Exceptions\AttributeNotRenderable

Uses Phalcon\Html\Exception

Method Summary

Methods

__construct()

public function __construct(
    string $key,
    string $type
);

Html\Exceptions\FriendlyTitleConversionFailed

Uses Phalcon\Html\Exception

Method Summary

Methods

__construct()

public function __construct( string $message );

Html\Exceptions\InvalidResultsetValue

Uses InvalidArgumentException

Method Summary

Methods

__construct()

public function __construct();

Html\Exceptions\ServiceNotRegistered

Uses Phalcon\Html\Exception

Method Summary

Methods

__construct()

public function __construct( string $name );

Html\Exceptions\UsingRequiresTwoValues

Uses InvalidArgumentException

Method Summary

Methods

__construct()

public function __construct();

Html\Helper\AbstractHelper

@property string $delimiter @property EscaperInterface $escaper @property string $indent @property int $indentLevel

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null
);

AbstractHelper constructor.

close()

protected function close(
    string $tag,
    bool $raw = false
): string;

Produces a closing tag

indent()

protected function indent(): string;

Replicates the indent x times as per indentLevel

injectAttribute()

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.

orderAttributes()

protected function orderAttributes(
    array $overrides,
    array $attributes
): array;

Keeps all the attributes sorted - same order all the time

renderArrayElements()

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()

protected function renderAttributes( array $attributes ): string;

Renders all the attributes

renderElement()

protected function renderElement(
    string $tag,
    array $attributes = []
): string;

Renders an element

renderFullElement()

protected function renderFullElement(
    string $tag,
    string $text,
    array $attributes = [],
    bool $raw = false
): string;

Renders an element

renderTag()

protected function renderTag(
    string $tag,
    array $attributes = [],
    string $close = ""
): string;

Renders a tag

selfClose()

protected function selfClose(
    string $tag,
    array $attributes = []
): string;

Produces a self close tag i.e.

Html\Helper\AbstractList

Class AbstractList

Uses Phalcon\Html\Exception

Method Summary

Properties

Methods

__invoke()

public function __invoke(
    string $indent = "    ",
    string|null $delimiter = null,
    array $attributes = []
): static;

__toString()

public function __toString();

Generates and returns the HTML for the list.

getTag()

abstract protected function getTag(): string;

Returns the tag name.

Html\Helper\AbstractSeries

@property array $attributes @property array $store

Method Summary

Properties

Methods

__invoke()

public function __invoke(
    string $indent = "    ",
    string|null $delimiter = null
): static;

__toString()

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()

public function reset(): static;

Resets the internal store.

getTag()

abstract protected function getTag(): string;

Returns the tag name.

pushOrPlace()

protected function pushOrPlace(
    array $entry,
    int $position = -1
): 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

Class Anchor

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    bool $forceRaw = false
);

__invoke()

public function __invoke(
    string $href,
    string $text,
    array $attributes = [],
    bool $raw = false
): string;

Produce a <a> tag

Html\Helper\Base

Class Base

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke(
    string|null $href = null,
    array $attributes = []
): string;

Produce a <base/> tag.

Html\Helper\Body

Class Body

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke( array $attributes = [] ): string;

Produce a <body> tag.

Html\Helper\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 <li> tags, while the whole string is enclosed in <nav> and <ol> tags.

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Mvc\Url\UrlInterface · Phalcon\Support\Helper\Str\Interpolate

Method Summary

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    UrlInterface|null $url = null
);

AbstractHelper constructor.

__invoke()

public function __invoke(
    string $indent = "    ",
    string|null $delimiter = null
): static;

Sets the indent and delimiter and returns the object back.

add()

public function add(
    string $text,
    string $link = "",
    string $icon = "",
    array $attributes = []
): static;

Adds a new crumb.

// Adding a crumb with a link
$breadcrumbs->add("Home", "/");

// Adding a crumb with added attributes
$breadcrumbs->add("Home", "/", ["class" => "main"]);

// Adding a crumb without a link (normally the last one)
$breadcrumbs->add("Users");

clear()

public function clear(): void;

Clears the crumbs.

$breadcrumbs->clear()

clearAttributes()

public function clearAttributes(): static;

Clear the attributes of the parent element.

getAttributes()

public function getAttributes(): array;

Get the attributes of the parent element.

getPrefix()

public function getPrefix(): string;

Returns the link prefix.

getSeparator()

public function getSeparator(): string;

Returns the separator.

getTemplate()

public function getTemplate(): array;

Return the current template.

remove()

public function remove( int $index ): void;

Removes crumb by url.

// Remove the second element
$breadcrumbs->remove(2);

render()

public function render(): string;

Renders and outputs breadcrumbs based on previously set template.

echo $breadcrumbs->render();

setAttributes()

public function setAttributes( array $attributes ): static;

Set the attributes for the parent element.

setPrefix()

public function setPrefix( string $prefix ): static;

Set the link prefix prepended to every non-empty link during rendering. When a Url service was injected, calling this method replaces it.

setSeparator()

public function setSeparator( string $separator ): static;

Set the separator.

setTemplate()

public function setTemplate(
    string $main,
    string $line,
    string $last
): static;

Set the HTML template.

toArray()

public function toArray(): array;

Returns the internal breadcrumbs array.

Html\Helper\Button

Class Button

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    bool $forceRaw = false
);

__invoke()

public function __invoke(
    string $text,
    array $attributes = [],
    bool $raw = false
): string;

Produce a <button> tag.

Html\Helper\Close

Class Close

Method Summary

Methods

__invoke()

public function __invoke(
    string $tag,
    bool $raw = false
): string;

Produce a </...> tag.

Html\Helper\Doctype

Creates Doctype tags

Method Summary

Constants

Methods

__construct()

public function __construct();

__invoke()

public function __invoke(
    int $type = self::HTML5,
    string $delimiter = "\n"
): static;

Produce a <doctype> tag

__toString()

public function __toString(): string;

getType()

public function getType(): int;

Html\Helper\Element

Class Element

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    bool $forceRaw = false
);

__invoke()

public function __invoke(
    string $tag,
    string $text,
    array $attributes = [],
    bool $raw = false
): string;

Produce a tag.

Html\Helper\Form

Class Form

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke( array $attributes = [] ): string;

Produce a <form> tag.

Html\Helper\FriendlyTitle

Converts text to a URL-friendly slug.

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception · Phalcon\Html\Exceptions\FriendlyTitleConversionFailed · Phalcon\Support\Helper\Str\Friendly

Method Summary

Properties

Methods

__construct()

public function __construct( EscaperInterface $escaper );

__invoke()

public function __invoke(
    string $text,
    string $separator = "-",
    bool $lowercase = true,
    mixed $replace = null
): string;

Html\Helper\Img

Class Img

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke(
    string $src,
    array $attributes = []
): string;

Produce a <img> tag.

Html\Helper\Input\AbstractChecked

Shared base for inputs that can be checked: <input type="checkbox"> and <input type="radio">. Holds the optional surrounding <label> markup, the unchecked companion hidden input, and the rule that decides whether the rendered tag carries checked="checked".

The match between checked and value is loose (==) by default so that mixed int/string form input round-trips correctly (e.g. value=0 against checked="0"). Strict (===) matching is available via strict(true).

@property array $label @property bool $strict

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Helper\Doctype

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null
);

__toString()

public function __toString();

Returns the HTML for the input, optionally surrounded by the label fragment configured via label() and preceded by the hidden companion input emitted when an unchecked attribute is supplied.

label()

public function label( array $attributes = [] ): static;

Attaches a wrapping <label> to the element. The supplied attributes are merged with a default for pointing at the input’s id. A text pseudo-attribute, if present, becomes the label text and is stripped from the rendered attributes.

strict()

public function strict( bool $flag = true ): static;

Toggles strict (===) comparison between the checked attribute and the value attribute when deciding whether to render the input as checked. Defaults to loose (==), which matches typical form-input round-tripping where types may differ between the source data and the value rendered into the markup.

processChecked()

protected function processChecked(): void;

Decides whether the rendered tag carries checked="checked". Two paths qualify as checked: an unconditional opt-in via ["checked" => "checked"] (case-insensitive) or ["checked" => true], and a value-match path where the supplied checked attribute equals the input’s value (== by default, === under strict(true)).

processUnchecked()

protected function processUnchecked(): string;

Returns the markup for the optional hidden companion input that lets a checkbox/radio submit a value when unchecked.

Html\Helper\Input\AbstractGroup

Shared base for rendering a group of same-named inputs (checkbox or radio) from an options array.

Each option in the $options array may be either:

• a scalar string label: [‘value’ => ‘Label text’]
• a rich definition: [‘value’ => [‘label’ => ‘Label text’, ‘disabled’ => true, …]]

The $checked parameter is resolved by the concrete subclass:

• CheckboxGroup compares against an array of selected values
• RadioGroup compares against a single scalar value

Uses Phalcon\Html\Helper\AbstractHelper

Method Summary

Properties

Methods

__invoke()

public function __invoke(
    string $name,
    array $options,
    mixed $checked = null,
    array $attributes = []
): static;

__toString()

public function __toString(): string;

Renders the group of inputs as a string.

isChecked()

abstract protected function isChecked( string $value ): bool;

Determines whether the given value is considered checked.

renderItem()

protected function renderItem(
    string $value,
    mixed $definition
): string;

Renders a single input + optional label pair.

Html\Helper\Input\AbstractInput

Class AbstractInput

@property array $attributes @property string $type @property string $value

Uses Phalcon\Html\Helper\AbstractHelper · Phalcon\Html\Helper\Doctype

Method Summary

Properties

Methods

__invoke()

public function __invoke(
    string $name,
    string|null $value = null,
    array $attributes = []
): static;

__toString()

public function __toString();

Returns the HTML for the input.

setValue()

public function setValue( string|null $value = null ): static;

Sets the value of the element

Html\Helper\Input\Checkbox

Renders an <input type="checkbox">. Behavior (label wrapping, unchecked companion, loose-by-default checked match) lives in AbstractChecked.

Properties

Html\Helper\Input\CheckboxGroup

Renders a group of <input type="checkbox"> elements from an options array.

The $checked parameter should be an array of selected values, or a single scalar value (treated as a one-element array).

Method Summary

Properties

Methods

isChecked()

protected function isChecked( string $value ): bool;

Returns true when $value appears in the checked list.

Html\Helper\Input\Generic

Generic input helper. The HTML5 type attribute is supplied via the constructor, which means the TagFactory can register a single class for all type-string-only inputs (color, date, email, hidden, number, …) and differentiate them through the recipe map. The type can also be changed after construction via setType().

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Helper\Doctype

Method Summary

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    string $type = "text"
);

setType()

public function setType( string $type ): AbstractInput;

Sets the type of the input.

Html\Helper\Input\Radio

Renders an <input type="radio">. Behavior (label wrapping, unchecked companion, loose-by-default checked match) lives in AbstractChecked.

Properties

Html\Helper\Input\RadioGroup

Renders a group of <input type="radio"> elements from an options array.

The $checked parameter should be a single scalar value matching the selected option’s value attribute.

Method Summary

Properties

Methods

isChecked()

protected function isChecked( string $value ): bool;

Returns true when $value loosely equals the checked scalar.

Html\Helper\Input\Select

Class Select

Uses Phalcon\Contracts\Html\Helper\Input\SelectData · Phalcon\Html\Helper\AbstractList

Method Summary

Properties

Methods

add()

public function add(
    string $text,
    string|null $value = null,
    array $attributes = [],
    bool $raw = false
): static;

Add an element to the list

addPlaceholder()

public function addPlaceholder(
    string $text,
    string|null $value = null,
    array $attributes = [],
    bool $raw = false
): static;

Add a placeholder to the element

fromData()

public function fromData( SelectData $data ): static;

Populates the select from a data provider.

Flat entries: key = option value, value = label string. Optgroup entries: key = group label, value = [value => label] array.

optGroup()

public function optGroup(
    string|null $label = null,
    array $attributes = []
): static;

Creates an option group

placeholder()

public function placeholder( string $text ): static;

Adds a non-selectable placeholder option as the first entry. Renders as <option value="" disabled selected>$text</option>, matching the common HTML idiom for “Choose…”-style prompts.

selected()

public function selected( string $selected ): static;

strict()

public function strict( bool $flag = true ): static;

Toggles strict (===) comparison between an option’s value and the previously stored selected value. Defaults to loose (==), matching the round-tripping fix in AbstractChecked so mixed int/string form data marks the right option as selected.

getTag()

protected function getTag(): string;

optGroupEnd()

protected function optGroupEnd(): string;

optGroupStart()

protected function optGroupStart(
    string $label,
    array $attributes
): string;

Html\Helper\Input\Select\ArrayData

Wraps a plain PHP array as a SELECT data provider.

Keys are option values; string values are labels; array values define optgroups.

Uses Phalcon\Contracts\Html\Helper\Input\SelectData

Method Summary

Properties

Methods

__construct()

public function __construct(
    array $data = [],
    array $attributes = []
);

getAttributes()

public function getAttributes(): array;

getOptions()

public function getOptions(): array;

Html\Helper\Input\Select\ResultsetData

Uses InvalidArgumentException · Phalcon\Contracts\Html\Helper\Input\SelectData · Phalcon\Html\Exceptions\InvalidResultsetValue · Phalcon\Html\Exceptions\UsingRequiresTwoValues · Phalcon\Mvc\Model\ResultsetInterface

Method Summary

Properties

Methods

__construct()

public function __construct(
    ResultsetInterface $resultset,
    array $using,
    array $attributesMap = []
);

getAttributes()

public function getAttributes(): array;

Returns per-option attribute maps, keyed by option value.

getOptions()

public function getOptions(): array;

readField()

protected function readField(
    mixed $option,
    string $field
);

Reads a property from the row, supporting both objects (via readAttribute when present) and plain arrays.

resolve()

protected function resolve(): void;

Walks the resultset once, building both the option map and the per-option resolved attribute map. Closures in attributesMap receive the current row; static values are passed through. false or null values skip the attribute entirely.

Html\Helper\Input\Textarea

Class Textarea

Uses Phalcon\Html\Exception

Method Summary

Properties

Methods

__toString()

public function __toString();

Returns the HTML for the input.

Html\Helper\Label

Class Label

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Exception

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    bool $forceRaw = false
);

__invoke()

public function __invoke(
    string $label,
    array $attributes = [],
    bool $raw = false
): string;

Produce a <label> tag.

Html\Helper\Link

Creates <link> tags

Method Summary

Methods

add()

public function add(
    string $url,
    array $attributes = [],
    int $position = -1
): static;

Add an element to the list

getAttributes()

protected function getAttributes(
    string $url,
    array $attributes
): array;

Returns the necessary attributes

getTag()

protected function getTag(): string;

Html\Helper\Meta

Class Meta

Uses Phalcon\Html\Exception

Method Summary

Methods

add()

public function add(
    array $attributes = [],
    int $position = -1
): static;

Add an element to the list

addHttp()

public function addHttp(
    string $httpEquiv,
    string $content,
    int $position = -1
): static;

addName()

public function addName(
    string $name,
    string $content,
    int $position = -1
): static;

addProperty()

public function addProperty(
    string $name,
    string $content,
    int $position = -1
): static;

getTag()

protected function getTag(): string;

Html\Helper\Ol

Class Ol

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    Doctype|null $doctype = null,
    bool $forceRaw = false
);

add()

public function add(
    string $text,
    array $attributes = [],
    bool $raw = false
): static;

Add an element to the list

getTag()

protected function getTag(): string;

Html\Helper\Preload

Generates a <link rel=“preload”> tag for resource hinting. If a ResponseInterface is provided, also sets the HTTP Link header.

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Link\Link · Phalcon\Html\Link\Serializer\Header · Phalcon\Http\ResponseInterface

Method Summary

Properties

Methods

__construct()

public function __construct(
    EscaperInterface $escaper,
    ResponseInterface|null $response = null
);

__invoke()

public function __invoke(
    string $href,
    string $type = "style",
    array $attributes = []
): string;

Html\Helper\Script

Class Script

Uses Phalcon\Html\Exception

Method Summary

Methods

add()

public function add(
    string $url,
    array $attributes = [],
    int $position = -1
): static;

Add an element to the list

beginInternal()

public function beginInternal(): void;

Begins capturing inline script content via output buffering. Pair with endInternal() to close the buffer and append the captured markup as a <script>...</script> block in the asset stack.

endInternal()

public function endInternal(
    array $attributes = [],
    int $position = -1
): static;

Closes an inline-script buffer opened by beginInternal() and adds the captured content as a <script>...</script> entry. Any attributes supplied are placed on the wrapping tag. The script body is treated as raw HTML (it is JavaScript, not user-supplied text).

getAttributes()

protected function getAttributes(
    string $url,
    array $attributes
): array;

Returns the necessary attributes

getTag()

protected function getTag(): string;

Html\Helper\Style

Class Style

Uses Phalcon\Html\Exception

Method Summary

Methods

add()

public function add(
    string $url,
    array $attributes = [],
    int $position = -1
): static;

Add an element to the list

setStyle()

public function setStyle( bool $flag ): static;

Sets if this is a style or link tag

getAttributes()

protected function getAttributes(
    string $url,
    array $attributes
): array;

Returns the necessary attributes

getTag()

protected function getTag(): string;

Html\Helper\Tag

Generic open-tag escape hatch. Renders just <name attr="..."> for any tag name without a dedicated helper. For an open + content + close tag use Element instead. For self-closing void tags (img, br, hr, etc.) use VoidTag.

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke(
    string $name,
    array $attributes = []
): string;

Html\Helper\Title

Class Title

@property array $append @property string $delimiter @property string $indent @property array $prepend @property string $title @property string $separator

Uses Phalcon\Html\Exception

Method Summary

Properties

Methods

__invoke()

public function __invoke(
    string $indent = "    ",
    string|null $delimiter = null
): static;

Sets the separator and returns the object back

__toString()

public function __toString();

Returns the title tags

append()

public function append(
    string $text,
    bool $raw = false
): static;

Appends text to current document title

get()

public function get(): string;

Returns the title

prepend()

public function prepend(
    string $text,
    bool $raw = false
): static;

Prepends text to current document title

set()

public function set(
    string $text,
    bool $raw = false
): static;

Sets the title

setSeparator()

public function setSeparator(
    string $separator,
    bool $raw = false
): static;

Sets the separator

Html\Helper\Ul

Class Ul

Method Summary

Methods

getTag()

protected function getTag(): string;

Html\Helper\VoidTag

Generic void-tag escape hatch. Renders a self-closing tag for any name without a dedicated helper. The trailing / is emitted only for XHTML doctypes, matching the Input/AbstractInput::__toString convention.

Uses Phalcon\Html\Exception

Method Summary

Methods

__invoke()

public function __invoke(
    string $name,
    array $attributes = []
): string;

Html\Link\AbstractLink

@property Collection $attributes @property string $href @property Collection $rels @property bool $templated

Uses Phalcon\Support\Collection

Method Summary

Properties

Methods

__construct()

public function __construct(
    string $rel = "",
    string $href = "",
    array $attributes = []
);

Link constructor.

doGetAttributes()

protected function doGetAttributes(): array;

Returns a list of attributes that describe the target URI.

doGetHref()

protected function doGetHref(): string;

Returns the target of the link.

The target link must be one of:

• An absolute URI, as defined by RFC 5988.
• A relative URI, as defined by RFC 5988. The base of the relative link is assumed to be known based on context by the client.
• A URI template as defined by RFC 6570.

If a URI template is returned, isTemplated() MUST return True.

doGetRels()

protected function doGetRels(): array;

Returns the relationship type(s) of the link.

This method returns 0 or more relationship types for a link, expressed as an array of strings.

doIsTemplated()

protected function doIsTemplated(): bool;

Returns whether this is a templated link.

doWithAttribute()

protected function doWithAttribute(
    string $key,
    mixed $value
): static;

doWithHref()

protected function doWithHref( string $href ): static;

doWithRel()

protected function doWithRel( string $key ): static;

doWithoutAttribute()

protected function doWithoutAttribute( string $key ): static;

doWithoutRel()

protected function doWithoutRel( string $key ): static;

hrefIsTemplated()

protected function hrefIsTemplated( string $href ): bool;

Determines if a href is a templated link or not.

@see https://tools.ietf.org/html/rfc6570

Html\Link\AbstractLinkProvider

@property array $links

Uses Phalcon\Html\Link\Interfaces\LinkInterface

Method Summary