- **`Phalcon\Html\Breadcrumbs`**
### Method Summary
public
static
add(string $label,string $link = "")
Adds a new crumb.
public
void
clear()
Clears the crumbs
public
string
getSeparator()
Crumb separator
public
void
remove( string $link )
Removes crumb by url.
public
string
render()
Renders and outputs breadcrumbs based on previously set template.
public
static
setSeparator( string $separator )
Set the separator
public
array
toArray()
Returns the internal breadcrumbs array
Public · 7
add()
```php
public function add(
string $label,
string $link = ""
): static;
```
Adds a new crumb.
```php
// Adding a crumb with a link
$breadcrumbs->add("Home", "/");
// Adding a crumb without a link (normally the last one)
$breadcrumbs->add("Users");
```
Crumbs are stored keyed by their link, so adding two crumbs that share
the same link - including two link-less crumbs, which share the empty
string key - keeps only the last one.
clear()
```php
public function clear(): void;
```
Clears the crumbs
```php
$breadcrumbs->clear()
```
getSeparator()
```php
public function getSeparator(): string;
```
Crumb separator
remove()
```php
public function remove( string $link ): void;
```
Removes crumb by url.
```php
$breadcrumbs->remove("/admin/user/create");
// remove a crumb without an url (last link)
$breadcrumbs->remove();
```
render()
```php
public function render(): string;
```
Renders and outputs breadcrumbs based on previously set template.
```php
echo $breadcrumbs->render();
```
setSeparator()
```php
public function setSeparator( string $separator ): static;
```
Set the separator
toArray()
```php
public function toArray(): array;
```
Returns the internal breadcrumbs array
## Html\Escaper
Class
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.
```php
$escaper = new \Phalcon\Html\Escaper();
$escaped = $escaper->css("font-family:
- **`Phalcon\Html\Escaper`** - implements [`Phalcon\Html\Escaper\EscaperInterface`](#htmlescaperescaperinterface)
__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
public
__construct(string $encoding = "utf-8",int $flags = 11,bool $doubleEncode = true)
Constructor. Accepts the legacy scalar params for backward compatibility
public
string
attributes( mixed $input = null )
Escapes a HTML attribute string or array. Delegates to the configured
public
string
css( string $input )
Escape CSS strings. Delegates to the configured CssEscaper.
public
string|null
detectEncoding( string $input )
Detects the character encoding of a string. Delegates to HtmlEscaper.
public
string
escapeCss( string $input )
public
string
escapeHtml( string|null $input = null )
public
string
escapeHtmlAttr( string|null $input = null )
public
string
escapeJs( string $input )
public
string
escapeUrl( string $input )
public
AttributeEscaper
getAttributeEscaper()
public
CssEscaper
getCssEscaper()
public
string
getEncoding()
Returns the encoding from the HtmlEscaper.
public
int
getFlags()
Returns the flags from the HtmlEscaper.
public
HtmlEscaper
getHtmlEscaper()
public
JsEscaper
getJsEscaper()
public
UrlEscaper
getUrlEscaper()
public
string
html( string|null $input = null )
Escapes a HTML string. Delegates to the configured HtmlEscaper.
public
string
js( string $input )
Escape javascript strings. Delegates to the configured JsEscaper.
public
string
normalizeEncoding( string $input )
Normalizes a string's encoding to UTF-32. Delegates to HtmlEscaper.
public
static
setAttributeEscaper( AttributeEscaper $escaper )
public
static
setCssEscaper( CssEscaper $escaper )
public
static
setDoubleEncode( bool $doubleEncode )
Sets the double_encode flag. Fans out to all sub-objects.
public
static
setEncoding( string $encoding )
Sets the encoding. Fans out to all sub-objects.
public
static
setFlags( int $flags )
Sets the htmlspecialchars flags. Fans out to all sub-objects.
public
static
setHtmlEscaper( HtmlEscaper $escaper )
public
static
setHtmlQuoteType( int $flags )
Sets the HTML quoting type for htmlspecialchars.
public
static
setJsEscaper( JsEscaper $escaper )
public
static
setUrlEscaper( UrlEscaper $escaper )
public
string
url( string $input )
Escapes a URL. Delegates to the configured UrlEscaper.
protected
AttributeEscaper
$attributeEscaper
protected
CssEscaper
$cssEscaper
protected
HtmlEscaper
$htmlEscaper
protected
JsEscaper
$jsEscaper
protected
UrlEscaper
$urlEscaper
Public · 29
__construct()
```php
public function __construct(
string $encoding = "utf-8",
int $flags = 11,
bool $doubleEncode = true
);
```
Constructor. Accepts the legacy scalar params for backward compatibility
and fans them out to every sub-escaper so existing code keeps working.
attributes()
```php
public function attributes( mixed $input = null ): string;
```
Escapes a HTML attribute string or array. Delegates to the configured
`AttributeEscaper`.
css()
```php
public function css( string $input ): string;
```
Escape CSS strings. Delegates to the configured `CssEscaper`.
detectEncoding()
```php
final public function detectEncoding( string $input ): string|null;
```
Detects the character encoding of a string. Delegates to `HtmlEscaper`.
escapeCss()
```php
public function escapeCss( string $input ): string;
```
escapeHtml()
```php
public function escapeHtml( string|null $input = null ): string;
```
escapeHtmlAttr()
```php
public function escapeHtmlAttr( string|null $input = null ): string;
```
escapeJs()
```php
public function escapeJs( string $input ): string;
```
escapeUrl()
```php
public function escapeUrl( string $input ): string;
```
getAttributeEscaper()
```php
public function getAttributeEscaper(): AttributeEscaper;
```
getCssEscaper()
```php
public function getCssEscaper(): CssEscaper;
```
getEncoding()
```php
public function getEncoding(): string;
```
Returns the encoding from the HtmlEscaper.
getFlags()
```php
public function getFlags(): int;
```
Returns the flags from the HtmlEscaper.
getHtmlEscaper()
```php
public function getHtmlEscaper(): HtmlEscaper;
```
getJsEscaper()
```php
public function getJsEscaper(): JsEscaper;
```
getUrlEscaper()
```php
public function getUrlEscaper(): UrlEscaper;
```
html()
```php
public function html( string|null $input = null ): string;
```
Escapes a HTML string. Delegates to the configured `HtmlEscaper`.
js()
```php
public function js( string $input ): string;
```
Escape javascript strings. Delegates to the configured `JsEscaper`.
normalizeEncoding()
```php
final public function normalizeEncoding( string $input ): string;
```
Normalizes a string's encoding to UTF-32. Delegates to `HtmlEscaper`.
setAttributeEscaper()
```php
public function setAttributeEscaper( AttributeEscaper $escaper ): static;
```
setCssEscaper()
```php
public function setCssEscaper( CssEscaper $escaper ): static;
```
setDoubleEncode()
```php
public function setDoubleEncode( bool $doubleEncode ): static;
```
Sets the double_encode flag. Fans out to all sub-objects.
setEncoding()
```php
public function setEncoding( string $encoding ): static;
```
Sets the encoding. Fans out to all sub-objects.
setFlags()
```php
public function setFlags( int $flags ): static;
```
Sets the htmlspecialchars flags. Fans out to all sub-objects.
setHtmlEscaper()
```php
public function setHtmlEscaper( HtmlEscaper $escaper ): static;
```
setHtmlQuoteType()
```php
public function setHtmlQuoteType( int $flags ): static;
```
Sets the HTML quoting type for htmlspecialchars.
```php
$escaper->setHtmlQuoteType(ENT_XHTML);
```
setJsEscaper()
```php
public function setJsEscaper( JsEscaper $escaper ): static;
```
setUrlEscaper()
```php
public function setUrlEscaper( UrlEscaper $escaper ): static;
```
url()
```php
public function url( string $input ): string;
```
Escapes a URL. Delegates to the configured `UrlEscaper`.
## Html\EscaperFactory
Class
Source on GitHub
Class EscaperFactory
- **`Phalcon\Html\EscaperFactory`**
### Method Summary
### Methods
Public · 1
newInstance()
```php
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.
@todo Remove in v7. Kept only for backwards compatibility; compose
Phalcon\Html\Escaper\Traits\EscaperTrait directly instead of extending this.
- **`Phalcon\Html\Escaper\AbstractEscaper`**
- [`Phalcon\Html\Escaper\AttributeEscaper`](#htmlescaperattributeescaper)
- [`Phalcon\Html\Escaper\CssEscaper`](#htmlescapercssescaper)
- [`Phalcon\Html\Escaper\HtmlEscaper`](#htmlescaperhtmlescaper)
- [`Phalcon\Html\Escaper\JsEscaper`](#htmlescaperjsescaper)
- [`Phalcon\Html\Escaper\UrlEscaper`](#htmlescaperurlescaper)
__Uses__ `Phalcon\Html\Escaper\Traits\EscaperTrait`
## 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.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\AttributeEscaper`**
### Method Summary
public
string
__invoke( mixed $input = null )
public
string
escape( mixed $input = null )
protected
string
escapeValue( string $input )
Encodes a single key/value via htmlspecialchars.
Public · 2
__invoke()
```php
public function __invoke( mixed $input = null ): string;
```
escape()
```php
public function escape( mixed $input = null ): string;
```
Protected · 1
escapeValue()
```php
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.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\CssEscaper`**
### Method Summary
### Methods
Public · 2
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
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.
- **`Phalcon\Html\Escaper\EscaperInterface`**
### Method Summary
public
string
attributes( string $input )
Escapes a HTML attribute string.
public
string
css( string $input )
Escape CSS strings by replacing non-alphanumeric chars by their
public
string
getEncoding()
Returns the internal encoding used by the escaper
public
string
html( string $input )
Escapes a HTML string.
public
string
js( string $input )
Escape Javascript strings by replacing non-alphanumeric chars by their
public
EscaperInterface
setEncoding( string $encoding )
Sets the encoding to be used by the escaper
public
EscaperInterface
setFlags( int $flags )
Sets the HTML quoting type for htmlspecialchars
public
string
url( string $input )
Escapes a URL. Internally uses rawurlencode
Public · 8
attributes()
```php
public function attributes( string $input ): string;
```
Escapes a HTML attribute string.
The concrete \{@see \Phalcon\Html\Escaper\} also accepts an array of
attribute pairs and tolerates `null`: an array is rendered as escaped
`key="value"` pairs, `null` and `false` values are skipped, and `true`
renders as a bare key. Callers typed against this interface pass a
string. The widened signature lands in the next major.
css()
```php
public function css( string $input ): string;
```
Escape CSS strings by replacing non-alphanumeric chars by their
hexadecimal representation
getEncoding()
```php
public function getEncoding(): string;
```
Returns the internal encoding used by the escaper
html()
```php
public function html( string $input ): string;
```
Escapes a HTML string.
The concrete \{@see \Phalcon\Html\Escaper\} tolerates `null`, returning an
empty string for it. The nullable signature lands in the next major.
js()
```php
public function js( string $input ): string;
```
Escape Javascript strings by replacing non-alphanumeric chars by their
hexadecimal representation
setEncoding()
```php
public function setEncoding( string $encoding ): EscaperInterface;
```
Sets the encoding to be used by the escaper
setFlags()
```php
public function setFlags( int $flags ): EscaperInterface;
```
Sets the HTML quoting type for htmlspecialchars
url()
```php
public function url( string $input ): string;
```
Escapes a URL. Internally uses rawurlencode
## Html\Escaper\Exception
Class
Source on GitHub
Class Exception
- `\Exception`
- **`Phalcon\Html\Escaper\Exception`**
## Html\Escaper\HtmlEscaper
Class
Source on GitHub
Escapes a string for use as HTML body content via `htmlspecialchars`.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\HtmlEscaper`**
### Method Summary
public
string
__invoke( string|null $input = null )
public
string
escape( string|null $input = null )
Public · 2
__invoke()
```php
public function __invoke( string|null $input = null ): string;
```
escape()
```php
public function escape( string|null $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.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\JsEscaper`**
### Method Summary
### Methods
Public · 2
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
public function escape( string $input ): string;
```
## Html\Escaper\Traits\EscaperTrait
Trait
Source on GitHub
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
- **`Phalcon\Html\Escaper\Traits\EscaperTrait`**
__Used by__ [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
### Method Summary
public
string|null
detectEncoding( string $input )
Detects the character encoding of a string. Special-handling for
public
bool
getDoubleEncode()
public
string
getEncoding()
public
int
getFlags()
public
string
normalizeEncoding( string $input )
Normalizes a string's encoding to UTF-32, used by the CSS and JS
public
static
setDoubleEncode( bool $doubleEncode )
public
static
setEncoding( string $encoding )
public
static
setFlags( int $flags )
protected
bool
$doubleEncode = true
protected
string
$encoding = "utf-8"
protected
int
$flags = 11
ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
Public · 8
detectEncoding()
```php
final public function detectEncoding( string $input ): string|null;
```
Detects the character encoding of a string. Special-handling for
chr(172) and chr(128) to chr(159) which fail to be detected by
`mb_detect_encoding()`.
getDoubleEncode()
```php
public function getDoubleEncode(): bool;
```
getEncoding()
```php
public function getEncoding(): string;
```
getFlags()
```php
public function getFlags(): int;
```
normalizeEncoding()
```php
final public function normalizeEncoding( string $input ): string;
```
Normalizes a string's encoding to UTF-32, used by the CSS and JS
escapers before invoking the C-level escape routines.
setDoubleEncode()
```php
public function setDoubleEncode( bool $doubleEncode ): static;
```
setEncoding()
```php
public function setEncoding( string $encoding ): static;
```
setFlags()
```php
public function setFlags( int $flags ): static;
```
## Html\Escaper\UrlEscaper
Class
Source on GitHub
Escapes a string for use as a URL component via `rawurlencode`.
- [`Phalcon\Html\Escaper\AbstractEscaper`](#htmlescaperabstractescaper)
- **`Phalcon\Html\Escaper\UrlEscaper`**
__Uses__ `Phalcon\Traits\Php\UrlTrait`
### Method Summary
### Methods
Public · 2
__invoke()
```php
public function __invoke( string $input ): string;
```
escape()
```php
public function escape( string $input ): string;
```
## Html\Exception
Class
Source on GitHub
Phalcon\Html\Exception
Exceptions thrown in Phalcon\Html will use this class
- `\Exception`
- **`Phalcon\Html\Exception`**
- [`Phalcon\Html\Exceptions\AttributeNotRenderable`](#htmlexceptionsattributenotrenderable)
- [`Phalcon\Html\Exceptions\FriendlyTitleConversionFailed`](#htmlexceptionsfriendlytitleconversionfailed)
- [`Phalcon\Html\Exceptions\ServiceNotRegistered`](#htmlexceptionsservicenotregistered)
## Html\Exceptions\AttributeNotRenderable
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\AttributeNotRenderable`**
__Uses__ `Phalcon\Html\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $key,
string $type
);
```
## Html\Exceptions\FriendlyTitleConversionFailed
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\FriendlyTitleConversionFailed`**
__Uses__ `Phalcon\Html\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $message );
```
## Html\Exceptions\InvalidResultsetValue
Class
Source on GitHub
- `\InvalidArgumentException`
- **`Phalcon\Html\Exceptions\InvalidResultsetValue`**
__Uses__ `InvalidArgumentException`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Html\Exceptions\ServiceNotRegistered
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Html\Exception`](#htmlexception)
- **`Phalcon\Html\Exceptions\ServiceNotRegistered`**
__Uses__ `Phalcon\Html\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $name );
```
## Html\Exceptions\UsingRequiresTwoValues
Class
Source on GitHub
- `\InvalidArgumentException`
- **`Phalcon\Html\Exceptions\UsingRequiresTwoValues`**
__Uses__ `InvalidArgumentException`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Html\Helper\AbstractHelper
Abstract
Source on GitHub
@property string $delimiter
@property EscaperInterface $escaper
@property string $indent
@property int $indentLevel
- **`Phalcon\Html\Helper\AbstractHelper`**
- [`Phalcon\Html\Helper\AbstractList`](#htmlhelperabstractlist)
- [`Phalcon\Html\Helper\AbstractSeries`](#htmlhelperabstractseries)
- [`Phalcon\Html\Helper\Anchor`](#htmlhelperanchor)
- [`Phalcon\Html\Helper\Base`](#htmlhelperbase)
- [`Phalcon\Html\Helper\Body`](#htmlhelperbody)
- [`Phalcon\Html\Helper\Breadcrumbs`](#htmlhelperbreadcrumbs)
- [`Phalcon\Html\Helper\Button`](#htmlhelperbutton)
- [`Phalcon\Html\Helper\Close`](#htmlhelperclose)
- [`Phalcon\Html\Helper\Element`](#htmlhelperelement)
- [`Phalcon\Html\Helper\Form`](#htmlhelperform)
- [`Phalcon\Html\Helper\FriendlyTitle`](#htmlhelperfriendlytitle)
- [`Phalcon\Html\Helper\Img`](#htmlhelperimg)
- [`Phalcon\Html\Helper\Input\AbstractGroup`](#htmlhelperinputabstractgroup)
- [`Phalcon\Html\Helper\Input\AbstractInput`](#htmlhelperinputabstractinput)
- [`Phalcon\Html\Helper\Label`](#htmlhelperlabel)
- [`Phalcon\Html\Helper\Preload`](#htmlhelperpreload)
- [`Phalcon\Html\Helper\Tag`](#htmlhelpertag)
- [`Phalcon\Html\Helper\Title`](#htmlhelpertitle)
- [`Phalcon\Html\Helper\VoidTag`](#htmlhelpervoidtag)
__Uses__ `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Html\Exception`
### Method Summary
public
__construct(EscaperInterface $escaper,Doctype|null $doctype = null)
AbstractHelper constructor.
protected
string
close(string $tag,bool $raw = false)
Produces a closing tag
protected
string
indent()
Replicates the indent x times as per indentLevel
protected
array
injectAttribute(string $key,string $value,array $attributes)
Forces a single key into the attribute array, stripping any user-supplied
protected
array
orderAttributes(array $overrides,array $attributes)
Keeps all the attributes sorted - same order all the time
protected
string
renderArrayElements(array $elements,string $delimiter)
Traverses an array and calls the method defined in the first element
protected
string
renderAttributes( array $attributes )
Renders all the attributes
protected
string
renderElement(string $tag,array $attributes = [])
Renders an element
protected
string
renderFullElement(string $tag,string $text,array $attributes = [],bool $raw = false)
Renders an element
protected
string
renderTag(string $tag,array $attributes = [],string $close = "")
Renders a tag
protected
string
selfClose(string $tag,array $attributes = [])
Produces a self close tag i.e. <img />
protected
string
$delimiter = ""
protected
Doctype|null
$doctype = null
protected
EscaperInterface
$escaper
protected
string
$indent = " "
protected
int
$indentLevel = 1
Public · 1
__construct()
```php
public function __construct(
EscaperInterface $escaper,
Doctype|null $doctype = null
);
```
AbstractHelper constructor.
Protected · 10
close()
```php
protected function close(
string $tag,
bool $raw = false
): string;
```
Produces a closing tag
indent()
```php
protected function indent(): string;
```
Replicates the indent x times as per indentLevel
injectAttribute()
```php
protected function injectAttribute(
string $key,
string $value,
array $attributes
): array;
```
Forces 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()
```php
protected function orderAttributes(
array $overrides,
array $attributes
): array;
```
Keeps all the attributes sorted - same order all the time
renderArrayElements()
```php
protected function renderArrayElements(
array $elements,
string $delimiter
): string;
```
Traverses an array and calls the method defined in the first element
with attributes as the second, returning the resulting string
renderAttributes()
```php
protected function renderAttributes( array $attributes ): string;
```
Renders all the attributes
renderElement()
```php
protected function renderElement(
string $tag,
array $attributes = []
): string;
```
Renders an element
renderFullElement()
```php
protected function renderFullElement(
string $tag,
string $text,
array $attributes = [],
bool $raw = false
): string;
```
Renders an element
renderTag()
```php
protected function renderTag(
string $tag,
array $attributes = [],
string $close = ""
): string;
```
Renders a tag
selfClose()
```php
protected function selfClose(
string $tag,
array $attributes = []
): string;
```
Produces a self close tag i.e.
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\AbstractList`**
- [`Phalcon\Html\Helper\Input\Select`](#htmlhelperinputselect)
- [`Phalcon\Html\Helper\Ol`](#htmlhelperol)
__Uses__ `Phalcon\Html\Exception`
### Method Summary
public
static
__invoke(string $indent = " ",string|null $delimiter = null,array $attributes = [])
public
__toString()
Generates and returns the HTML for the list.
protected
string
getTag()
Returns the tag name.
protected
array
$attributes = []
protected
string
$elementTag = "li"
protected
array
$store = []
Public · 2
__invoke()
```php
public function __invoke(
string $indent = " ",
string|null $delimiter = null,
array $attributes = []
): static;
```
__toString()
```php
public function __toString();
```
Generates and returns the HTML for the list.
Protected · 1
getTag()
```php
abstract protected function getTag(): string;
```
Returns the tag name.
## Html\Helper\AbstractSeries
Abstract
Source on GitHub
@property array $attributes
@property array $store
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\AbstractSeries`**
- [`Phalcon\Html\Helper\Meta`](#htmlhelpermeta)
- [`Phalcon\Html\Helper\Script`](#htmlhelperscript)
- [`Phalcon\Html\Helper\Style`](#htmlhelperstyle)
### Method Summary
public
static
__invoke(string $indent = " ",string|null $delimiter = null)
public
__toString()
Generates and returns the HTML for the list. Entries are sorted by
public
static
reset()
Resets the internal store.
protected
string
getTag()
Returns the tag name.
protected
void
pushOrPlace(array $entry,int $position = -1)
Appends an entry to the store, optionally at a specific integer
protected
array
$attributes = []
protected
array
$store = []
Public · 3
__invoke()
```php
public function __invoke(
string $indent = " ",
string|null $delimiter = null
): static;
```
__toString()
```php
public function __toString();
```
Generates and returns the HTML for the list. Entries are sorted by
their integer key first, so an asset registered with a lower position
renders before one registered with a higher position regardless of
registration order.
reset()
```php
public function reset(): static;
```
Resets the internal store.
Protected · 2
getTag()
```php
abstract protected function getTag(): string;
```
Returns the tag name.
pushOrPlace()
```php
protected function pushOrPlace(
array $entry,
int $position = -1
): void;
```
Appends an entry to the store, optionally at a specific integer
position. When `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
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\Anchor`**
__Uses__ `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Html\Exception`
### Method Summary
public
__construct(EscaperInterface $escaper,Doctype|null $doctype = null,bool $forceRaw = false)
public
string
__invoke(string $href,string $text,array $attributes = [],bool $raw = false)
Produce a <a> tag
protected
bool
$forceRaw = false
Public · 2
__construct()
```php
public function __construct(
EscaperInterface $escaper,
Doctype|null $doctype = null,
bool $forceRaw = false
);
```
__invoke()
```php
public function __invoke(
string $href,
string $text,
array $attributes = [],
bool $raw = false
): string;
```
Produce a <a> tag
## Html\Helper\Base
Class
Source on GitHub
Class Base
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\Base`**
__Uses__ `Phalcon\Html\Exception`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string|null $href = null,
array $attributes = []
): string;
```
Produce a `
- [`Phalcon\Html\Helper\AbstractHelper`](#htmlhelperabstracthelper)
- **`Phalcon\Html\Helper\Body`**
__Uses__ `Phalcon\Html\Exception`
### Method Summary
### Methods
Public · 1