Phalcon html

Html\Attributes¶

Class Source on GitHub

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¶

Interface Source on GitHub

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¶

Interface Source on GitHub

Rendering interface for HTML attributes

Method Summary¶

Methods¶

render()¶

public function render(): string;

Generate a string representation

Html\Breadcrumbs¶

Class Source on GitHub

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;

toArray()¶

public function toArray(): array;

Returns the internal breadcrumbs array

Html\Escaper¶

Class Source on GitHub

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

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;

escapeCss()¶

public function escapeCss( string $input ): string;

escapeHtml()¶

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

escapeHtmlAttr()¶

public function escapeHtmlAttr( string $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;

getFlags()¶

public function getFlags(): int;

getHtmlEscaper()¶

public function getHtmlEscaper(): HtmlEscaper;

getJsEscaper()¶

public function getJsEscaper(): JsEscaper;

getUrlEscaper()¶

public function getUrlEscaper(): UrlEscaper;

html()¶

public function html( string $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;

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;

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 Source on GitHub

Class EscaperFactory

Method Summary¶

Methods¶

newInstance()¶

public function newInstance(): Escaper;

Create a new instance of the object

Html\Escaper\AbstractEscaper¶

Abstract Source on GitHub

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

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\AttributeEscaper¶

Class Source on GitHub

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¶

Class Source on GitHub

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 Source on GitHub

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 Source on GitHub

Class Exception

Html\Escaper\HtmlEscaper¶

Class Source on GitHub

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

Method Summary¶

Methods¶

__invoke()¶

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

escape()¶

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

Html\Escaper\JsEscaper¶

Class Source on GitHub

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\UrlEscaper¶

Class Source on GitHub

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

Method Summary¶

Methods¶

__invoke()¶

public function __invoke( string $input ): string;

escape()¶

public function escape( string $input ): string;

Html\Exception¶

Class Source on GitHub

Phalcon\Html\Exception

Exceptions thrown in Phalcon\Html will use this class

Html\Exceptions\AttributeNotRenderable¶

Class Source on GitHub

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__construct()¶

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

Html\Exceptions\FriendlyTitleConversionFailed¶

Class Source on GitHub

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct( string $message );

Html\Exceptions\InvalidResultsetValue¶

Class Source on GitHub

Uses InvalidArgumentException

Method Summary¶

Methods¶

__construct()¶

public function __construct();

Html\Exceptions\ServiceNotRegistered¶

Class Source on GitHub

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct( string $name );

Html\Exceptions\UsingRequiresTwoValues¶

Class Source on GitHub

Uses InvalidArgumentException

Method Summary¶

Methods¶

__construct()¶

public function __construct();

Html\Helper\AbstractHelper¶

Abstract Source on GitHub

@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 $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¶

Abstract Source on GitHub

Class AbstractList

Uses Phalcon\Html\Exception

Method Summary¶

Properties¶

Methods¶

__invoke()¶

public function __invoke(
    string $indent = "    ",
    string $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¶

Abstract Source on GitHub

@property array $attributes @property array $store

Method Summary¶

Properties¶

Methods¶

__invoke()¶

public function __invoke(
    string $indent = "    ",
    string $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 Source on GitHub

Class Anchor

@property bool $forceRaw

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

Method Summary¶

Properties¶

Methods¶

__construct()¶

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

__invoke()¶

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

Produce a tag

Html\Helper\Base¶

Class Source on GitHub

Class Base

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__invoke()¶

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

Produce a <base/> tag.

Html\Helper\Body¶

Class Source on GitHub

Class Body

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__invoke()¶

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

Produce a <body> tag.

Html\Helper\Breadcrumbs¶

Class Source on GitHub

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 $url = null
);

AbstractHelper constructor.

__invoke()¶

public function __invoke(
    string $indent = "    ",
    string $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 Source on GitHub

Class Button

@property bool $forceRaw

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

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    EscaperInterface $escaper,
    Doctype $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 Source on GitHub

Class Close

Method Summary¶

Methods¶

__invoke()¶

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

Produce a </...> tag.

Html\Helper\Doctype¶

Class Source on GitHub

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 tag

__toString()¶

public function __toString(): string;

getType()¶

public function getType(): int;

Html\Helper\Element¶

Class Source on GitHub

Class Element

@property bool $forceRaw

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

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    EscaperInterface $escaper,
    Doctype $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 Source on GitHub

Class Form

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__invoke()¶

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

Produce a <form> tag.

Html\Helper\FriendlyTitle¶

Class Source on GitHub

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 Source on GitHub

Class Img

Uses Phalcon\Html\Exception

Method Summary¶

Methods¶

__invoke()¶

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

Produce a tag.

Html\Helper\Input\AbstractChecked¶

Abstract Source on GitHub

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 $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¶

Abstract Source on GitHub

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¶

Abstract Source on GitHub

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 $value = null,
    array $attributes = []
): static;

__toString()¶

public function __toString();

Returns the HTML for the input.

setValue()¶

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

Sets the value of the element

Html\Helper\Input\Checkbox¶

Class Source on GitHub

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

Properties¶

Html\Helper\Input\CheckboxGroup¶

Class Source on GitHub

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¶

Class Source on GitHub

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 $doctype = null,
    string $type = "text"
);

setType()¶

public function setType( string $type ): AbstractInput;

Sets the type of the input.

Html\Helper\Input\Radio¶

Class Source on GitHub

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

Properties¶

Html\Helper\Input\RadioGroup¶

Class Source on GitHub

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 Source on GitHub

Class Select

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

Method Summary¶

Properties¶

Methods¶

add()¶

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

Add an element to the list

addPlaceholder()¶

public function addPlaceholder(
    string $text,
    string $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 $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¶

Class Source on GitHub

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¶

Class Source on GitHub

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 Source on GitHub

Class Textarea

Uses Phalcon\Html\Exception

Method Summary¶

Properties¶

Methods¶

__toString()¶

public function __toString();

Returns the HTML for the input.

Html\Helper\Label¶

Class Source on GitHub

Class Label

@property bool $forceRaw

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

Method Summary¶

Properties¶

Methods¶

__construct()¶

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

__invoke()¶

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

Produce a <label> tag.

Html\Helper\Link¶

Class Source on GitHub

Creates 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 Source on GitHub

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 Source on GitHub

Class Ol

@property bool $forceRaw

Uses Phalcon\Html\Escaper\EscaperInterface

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    EscaperInterface $escaper,
    Doctype $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¶

Class Source on GitHub

Generates a 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 $response = null
);

__invoke()¶

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

Html\Helper\Script¶

Class Source on GitHub

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 Source on GitHub

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¶

Class Source on GitHub