Skip to content
Phalcondocs

Phalcon Html

Updated View as Markdown

Html\Attributes

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

    • Phalcon\Html\Attributes\RenderInterface
    • Phalcon\Support\Collection

  • Extends

    Collection

  • Implements

    • RenderInterface

This class helps to work with HTML Attributes

Methods

public function __toString(): string;

Alias of the render method

public function render(): string;

Render attributes as HTML attributes

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

  • Namespace

    • Phalcon\Html\Attributes

  • Uses

    • Phalcon\Html\Attributes

  • Extends

  • Implements

  • Phalcon\Html\Attributes\AttributesInterface
  • Interface Phalcon\Html\Attributes\AttributesInterface */

Methods

public function getAttributes(): Attributes;

Get Attributes

public function setAttributes( Attributes $attributes ): AttributesInterface;

Set Attributes

Html\Attributes\RenderInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Attributes

  • Uses

  • Extends

  • Implements

  • Phalcon\Html\Attributes\RenderInterface
  • Interface Phalcon\Html\Attributes\RenderInterface */

Methods

public function render(): string;

Generate a string represetation

Html\Breadcrumbs

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

    • Phalcon\Di\DiInterface

  • Extends

  • Implements

Phalcon\Html\Breadcrumbs

This component offers an easy way to create breadcrumbs for your application. The resulting HTML when calling render() will have each breadcrumb enclosed in <dt> tags, while the whole string is enclosed in <dl> tags.

@deprecated Will be removed in future version Use {@see Phalcon\Html\Helper\Breadcrumbs} instead.

Properties

/**
 * Keeps all the breadcrumbs
 *
 * @var array
 */
private $elements;

/**
 * Crumb separator
 *
 * @var string
 */
private $separator =  / ;

/**
 * The HTML template to use to render the breadcrumbs.
 *
 * @var string
 */
private $template = <dt><a href=\"%link%\">%label%</a></dt>;

Methods

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

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");
public function clear(): void;

Clears the crumbs

$breadcrumbs->clear()
public function getSeparator(): string;

Crumb separator

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();
public function render(): string;

Renders and outputs breadcrumbs based on previously set template.

echo $breadcrumbs->render();
public function setSeparator( string $separator ): Breadcrumbs;
public function toArray(): array;

Returns the internal breadcrumbs array

Html\Escaper

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

    • Phalcon\Html\Escaper\EscaperInterface

  • Extends

  • Implements

    • EscaperInterface

Phalcon\Html\Escaper

Escapes different kinds of text securing them. By using this component you may prevent XSS attacks.

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->escapeCss("font-family: <Verdana>");

echo $escaped; // font\2D family\3A \20 \3C Verdana\3E

Properties

/**
 * @var bool
 */
protected $doubleEncode = true;

/**
 * @var string
 */
protected $encoding = utf-8;

/**
 * ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
 *
 * @var int
 */
protected $flags = 11;

Methods

public function attributes( mixed $input ): string;

Escapes a HTML attribute string or array

If the input is an array, the keys are the attribute names and the values are attribute values. If a value is boolean (true/false) then the attribute will have no value: ['disabled' => true] -> `’disabled``

The resulting string will have attribute pairs separated by a space.

public function css( string $input ): string;

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

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

Detect the character encoding of a string to be handled by an encoder. Special-handling for chr(172) and chr(128) to chr(159) which fail to be detected by mb_detect_encoding()

public function escapeCss( string $input ): string;

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

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

Escapes a HTML string. Internally uses htmlspecialchars

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

Escapes a HTML attribute string

public function escapeJs( string $input ): string;

Escape JavaScript strings by replacing non-alphanumeric chars by their hexadecimal escaped representation

public function escapeUrl( string $input ): string;

Escapes a URL. Internally uses rawurlencode

public function getEncoding(): string;
public function getFlags(): int;
public function html( string $input = null ): string;

Escapes a HTML string. Internally uses htmlspecialchars

public function js( string $input ): string;

Escape javascript strings by replacing non-alphanumeric chars by their hexadecimal escaped representation

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

Utility to normalize a string’s encoding to UTF-32.

public function setDoubleEncode( bool $doubleEncode ): Escaper;

Sets the double_encode to be used by the escaper

$escaper->setDoubleEncode(false);
public function setEncoding( string $encoding ): EscaperInterface;

Sets the encoding to be used by the escaper

$escaper->setEncoding("utf-8");
public function setFlags( int $flags ): EscaperInterface;

Sets the HTML quoting type for htmlspecialchars

$escaper->setFlags(ENT_XHTML);
public function setHtmlQuoteType( int $flags ): EscaperInterface;

Sets the HTML quoting type for htmlspecialchars

$escaper->setHtmlQuoteType(ENT_XHTML);
public function url( string $input ): string;

Escapes a URL. Internally uses rawurlencode

protected function phpHtmlSpecialChars( string $input ): string;

Proxy method for testing

Html\Escaper\EscaperInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Escaper

  • Uses

  • Extends

  • Implements

Interface for Phalcon\Html\Escaper

Methods

public function attributes( string $input ): string;

Escapes a HTML attribute string

public function css( string $input ): string;

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

public function getEncoding(): string;

Returns the internal encoding used by the escaper

public function html( string $input ): string;

Escapes a HTML string

public function js( string $input ): string;

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

public function setEncoding( string $encoding ): EscaperInterface;

Sets the encoding to be used by the escaper

public function setFlags( int $flags ): EscaperInterface;

Sets the HTML quoting type for htmlspecialchars

public function url( string $input ): string;

Escapes a URL. Internally uses rawurlencode

Html\Escaper\Exception

Source on GitHub

  • Namespace

    • Phalcon\Html\Escaper

  • Uses

  • Extends

    \Exception

  • Implements

Exceptions thrown in Phalcon\Html\Escaper will use this class

Html\EscaperFactory

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

  • Extends

  • Implements

Class EscaperFactory

Methods

public function newInstance(): Escaper;

Create a new instance of the object

Html\Exception

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

  • Extends

    \Exception

  • Implements

Phalcon\Html\Tag\Exception

Exceptions thrown in Phalcon\Html\Tag will use this class

Html\Helper\AbstractHelper Abstract

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Escaper\EscaperInterface
    • Phalcon\Html\Exception

  • Extends

  • Implements

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

Properties

/**
 * @var string
 */
protected $delimiter = ;

/**
 * @var Doctype|null
 */
protected $doctype;

/**
 * @var EscaperInterface
 */
protected $escaper;

/**
 * @var string
 */
protected $indent =     ;

/**
 * @var int
 */
protected $indentLevel = 1;

Methods

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

AbstractHelper constructor.

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

Produces a closing tag

protected function indent(): string;

Replicates the indent x times as per indentLevel

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

Keeps all the attributes sorted - same order all the tome

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

protected function renderAttributes( array $attributes ): string;

Renders all the attributes

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

Renders an element

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

Renders an element

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

Renders a tag

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

Produces a self close tag i.e.

Html\Helper\AbstractList Abstract

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class AbstractList

Properties

/**
 * @var array
 */
protected $attributes;

/**
 * @var string
 */
protected $elementTag = li;

/**
 * @var array
 */
protected $store;

Methods

public function __invoke( string $indent = string, string $delimiter = null, array $attributes = [] ): AbstractList;
public function __toString();

Generates and returns the HTML for the list.

abstract protected function getTag(): string;

Returns the tag name.

Html\Helper\AbstractSeries Abstract

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

    AbstractHelper

  • Implements

@property array $attributes @property array $store

Properties

/**
 * @var array
 */
protected $attributes;

/**
 * @var array
 */
protected $store;

Methods

public function __invoke( string $indent = string, string $delimiter = null ): AbstractSeries;
public function __toString();

Generates and returns the HTML for the list.

public function reset(): AbstractSeries;

Resets the internal store.

abstract protected function getTag(): string;

Returns the tag name.

Html\Helper\Anchor

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Anchor

Methods

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

Produce a <a> tag

protected function processAttributes( string $href, array $attributes ): array;

Html\Helper\Base

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Base

Methods

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

Produce a <base/> tag.

Html\Helper\Body

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Body

Methods

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

Produce a <body> tag.

Html\Helper\Breadcrumbs

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Escaper\EscaperInterface
    • Phalcon\Support\Helper\Str\Interpolate

  • Extends

    AbstractHelper

  • Implements

This component offers an easy way to create breadcrumbs for your application. The resulting HTML when calling render() will have each breadcrumb enclosed in <li> tags, while the whole string is enclosed in <nav> and <ol> tags.

@phpstan-type TTemplate = array{ main: string, line: string, last: string, } @phpstan-type TElement = array{ attributes: array<string, string>, icon: string, link: string, text: string, }

Properties

/**
 * @var array<string, string>
 */
private $attributes;

/**
 * Keeps all the breadcrumbs.
 *
 * @var array<int, TElement>
 */
private $data;

/**
 * Crumb separator.
 *
 * @var string
 */
private $separator = <li>/</li>;

/**
 * The HTML template to use to render the breadcrumbs.
 *
 * @var TTemplate
 */
private $template;

/**
 * The HTML template to use to render the breadcrumbs.
 *
 * @var Interpolate
 */
private $interpolator;

Methods

public function __construct( EscaperInterface $escaper );

AbstractHelper constructor.

public function __invoke( string $indent = string, string $delimiter = null ): Breadcrumbs;

Sets the indent and delimiter and returns the object back.

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

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");
public function clear(): void;

Clears the crumbs.

$breadcrumbs->clear()
public function clearAttributes(): Breadcrumbs;

Clear the attributes of the parent element.

public function getAttributes(): array;

Get the attributes of the parent element.

public function getSeparator(): string;

Returns the separator.

public function getTemplate(): array;

Return the current template.

public function remove( int $index ): void;

Removes crumb by url.

// Remove the second element
$breadcrumbs->remove(2);
public function render(): string;

Renders and outputs breadcrumbs based on previously set template.

echo $breadcrumbs->render();
public function setAttributes( array $attributes ): Breadcrumbs;

Set the attributes for the parent element.

public function setSeparator( string $separator ): Breadcrumbs;

Set the separator.

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

Set the HTML template.

public function toArray(): array;

Returns the internal breadcrumbs array.

Html\Helper\Button

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Button

Methods

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

Produce a <button> tag.

Html\Helper\Close

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

    AbstractHelper

  • Implements

Class Close

Methods

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

Produce a </...> tag.

Html\Helper\Doctype

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

  • Implements

Creates Doctype tags

Constants

const HTML32 = 1;
const HTML401_FRAMESET = 4;
const HTML401_STRICT = 2;
const HTML401_TRANSITIONAL = 3;
const HTML5 = 5;
const XHTML10_FRAMESET = 8;
const XHTML10_STRICT = 6;
const XHTML10_TRANSITIONAL = 7;
const XHTML11 = 9;
const XHTML20 = 10;
const XHTML5 = 11;

Properties

/**
 * @var string
 */
private $delimiter;

/**
 * @var int
 */
private $type;

Methods

public function __construct();
public function __invoke( int $type = static-constant-access, string $delimiter = string ): Doctype;

Produce a <doctype> tag

public function __toString(): string;
public function getType(): int;

Html\Helper\Element

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Element

Methods

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

Produce a tag.

Html\Helper\Form

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Form

Methods

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

Produce a <form> tag.

Html\Helper\Img

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Img

Methods

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

Produce a <img> tag.

Html\Helper\Input\AbstractInput Abstract

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

    • Phalcon\Html\Helper\AbstractHelper
    • Phalcon\Html\Helper\Doctype

  • Extends

    AbstractHelper

  • Implements

Class AbstractInput

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

Properties

/**
 * @var string
 */
protected $type = text;

/**
 * @var array
 */
protected $attributes;

Methods

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

Returns the HTML for the input.

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

Sets the value of the element

Html\Helper\Input\Checkbox

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

    • Phalcon\Html\Escaper\EscaperInterface
    • Phalcon\Html\Helper\Doctype

  • Extends

    AbstractInput

  • Implements

Class Checkbox

@property array $label

Properties

/**
 * @var array
 */
protected $label;

/**
 * @var string
 */
protected $type = checkbox;

Methods

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

AbstractHelper constructor.

public function __toString();

Returns the HTML for the input.

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

Attaches a label to the element

Html\Helper\Input\Color

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Color

Properties

//
protected $type = color;

Html\Helper\Input\Date

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Date

Properties

//
protected $type = date;

Html\Helper\Input\DateTime

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class DateTime

Properties

//
protected $type = datetime;

Html\Helper\Input\DateTimeLocal

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class DateTimeLocal

Properties

//
protected $type = datetime-local;

Html\Helper\Input\Email

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Email

Properties

//
protected $type = email;

Html\Helper\Input\File

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class File

Properties

//
protected $type = file;

Html\Helper\Input\Hidden

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Hidden

Properties

//
protected $type = hidden;

Html\Helper\Input\Image

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Image

Properties

//
protected $type = image;

Html\Helper\Input\Input

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Input

Methods

public function setType( string $type ): AbstractInput;

Sets the type of the input

Html\Helper\Input\Month

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Month

Properties

//
protected $type = month;

Html\Helper\Input\Numeric

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Numeric

Properties

//
protected $type = number;

Html\Helper\Input\Password

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Password

Properties

//
protected $type = password;

Html\Helper\Input\Radio

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    Checkbox

  • Implements

Class Radio

Properties

/**
 * @var string
 */
protected $type = radio;

Html\Helper\Input\Range

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Range

Properties

//
protected $type = range;

Html\Helper\Input\Search

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Search

Properties

//
protected $type = search;

Html\Helper\Input\Select

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

    • Phalcon\Html\Helper\AbstractList

  • Extends

    AbstractList

  • Implements

Class Select

Properties

/**
 * @var string
 */
protected $elementTag = option;

/**
 * @var bool
 */
protected $inOptGroup = false;

/**
 * @var string
 */
protected $selected = ;

Methods

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

Add an element to the list

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

Add a placeholder to the element

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

Creates an option group

public function selected( string $selected ): Select;
protected function getTag(): string;
protected function optGroupEnd(): string;
protected function optGroupStart( string $label, array $attributes ): string;

Html\Helper\Input\Submit

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Submit

Properties

//
protected $type = submit;

Html\Helper\Input\Tel

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Tel

Properties

//
protected $type = tel;

Html\Helper\Input\Text

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Text

Html\Helper\Input\Textarea

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractInput

  • Implements

Class Textarea

Properties

/**
 * @var string
 */
protected $type = textarea;

Methods

public function __toString();

Returns the HTML for the input.

Html\Helper\Input\Time

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Time

Properties

//
protected $type = time;

Html\Helper\Input\Url

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Url

Properties

//
protected $type = url;

Html\Helper\Input\Week

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper\Input

  • Uses

  • Extends

    AbstractInput

  • Implements

Class Week

Properties

//
protected $type = week;

Html\Helper\Label

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Label

Methods

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

Produce a <label> tag.

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

    Style

  • Implements

Creates <link> tags

Methods

public function add( string $url, array $attributes = [] );

Add an element to the list

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

Returns the necessary attributes

protected function getTag(): string;

Html\Helper\Meta

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractSeries

  • Implements

Class Meta

Methods

public function add( array $attributes = [] ): Meta;

Add an element to the list

public function addHttp( string $httpEquiv, string $content ): Meta;
public function addName( string $name, string $content ): Meta;
public function addProperty( string $name, string $content ): Meta;
protected function getTag(): string;

Html\Helper\Ol

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

    AbstractList

  • Implements

Class Ol

Methods

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

Add an element to the list

protected function getTag(): string;

Html\Helper\Script

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractSeries

  • Implements

Class Script

Methods

public function add( string $url, array $attributes = [] );

Add an element to the list

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

Returns the necessary attributes

protected function getTag(): string;

Html\Helper\Style

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractSeries

  • Implements

Class Style

Properties

/**
 * @var bool
 */
private $isStyle = false;

Methods

public function add( string $url, array $attributes = [] );

Add an element to the list

public function setStyle( bool $flag ): Style;

Sets if this is a style or link tag

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

Returns the necessary attributes

protected function getTag(): string;

Html\Helper\Title

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

    • Phalcon\Html\Exception

  • Extends

    AbstractHelper

  • Implements

Class Title

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

Properties

/**
 * @var array
 */
protected $append;

/**
 * @var array
 */
protected $prepend;

/**
 * @var string
 */
protected $title = ;

/**
 * @var string
 */
protected $separator = ;

Methods

public function __invoke( string $indent = string, string $delimiter = null ): Title;

Sets the separator and returns the object back

public function __toString();

Returns the title tags

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

Appends text to current document title

public function get(): string;

Returns the title

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

Prepends text to current document title

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

Sets the title

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

Sets the separator

Html\Helper\Ul

Source on GitHub

  • Namespace

    • Phalcon\Html\Helper

  • Uses

  • Extends

    Ol

  • Implements

Class Ul

Methods

protected function getTag(): string;

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Support\Collection

  • Extends

  • Implements

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

Properties

/**
 * @var Collection
 */
protected $attributes;

/**
 * @var string
 */
protected $href = ;

/**
 * @var Collection
 */
protected $rels;

/**
 * @var bool
 */
protected $templated = false;

Methods

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

Link constructor.

protected function doGetAttributes(): array;

Returns a list of attributes that describe the target URI.

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.

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.

protected function doIsTemplated(): bool;

Returns whether this is a templated link.

protected function doWithAttribute( string $key, mixed $value );
protected function doWithHref( string $href );
protected function doWithRel( string $key );
protected function doWithoutAttribute( string $key );
protected function doWithoutRel( string $key );
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 Abstract

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Html\Link\Interfaces\LinkInterface

  • Extends

  • Implements

@property array $links

Properties

/**
 * @var array
 */
protected $links;

Methods

public function __construct( array $links = [] );

LinkProvider constructor.

protected function doGetLinks(): array;

Returns an iterable of LinkInterface objects.

The iterable may be an array or any PHP \Traversable object. If no links are available, an empty array or \Traversable MUST be returned.

protected function doGetLinksByRel( string $rel ): array;

Returns an iterable of LinkInterface objects that have a specific relationship.

The iterable may be an array or any PHP \Traversable object. If no links with that relationship are available, an empty array or \Traversable MUST be returned.

protected function doWithLink( mixed $link );

Returns an instance with the specified link included.

If the specified link is already present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

protected function doWithoutLink( mixed $link );

Returns an instance with the specified link removed.

If the specified link is not present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

protected function getKey( mixed $link ): string;

Returns the object hash key

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Html\Link\Interfaces\EvolvableLinkInterface

  • Extends

    Link

  • Implements

    • EvolvableLinkInterface

Class Phalcon\Http\Link\EvolvableLink

@property array attributes @property string href @property array rels @property bool templated

Methods

public function withAttribute( mixed $attribute, mixed $value ): EvolvableLinkInterface;

Returns an instance with the specified attribute added.

If the specified attribute is already present, it will be overwritten with the new value.

public function withHref( string $href ): EvolvableLinkInterface;

Returns an instance with the specified href.

public function withRel( string $rel ): EvolvableLinkInterface;

Returns an instance with the specified relationship included.

If the specified rel is already present, this method MUST return normally without errors, but without adding the rel a second time.

public function withoutAttribute( string $attribute ): EvolvableLinkInterface;

Returns an instance with the specified attribute excluded.

If the specified attribute is not present, this method MUST return normally without errors.

public function withoutRel( string $rel ): EvolvableLinkInterface;

Returns an instance with the specified relationship excluded.

If the specified rel is not present, this method MUST return normally without errors.

Html\Link\EvolvableLinkProvider

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Html\Link\Interfaces\EvolvableLinkProviderInterface
    • Phalcon\Html\Link\Interfaces\LinkInterface

  • Extends

    LinkProvider

  • Implements

    • EvolvableLinkProviderInterface

Class Phalcon\Http\Link\LinkProvider

@property LinkInterface[] links

Methods

public function withLink( LinkInterface $link ): EvolvableLinkProviderInterface;

Returns an instance with the specified link included.

If the specified link is already present, this method MUST return normally without errors. The link is present if link is === identical to a link object already in the collection.

public function withoutLink( LinkInterface $link ): EvolvableLinkProviderInterface;

Returns an instance with the specified link removed.

If the specified link is not present, this method MUST return normally without errors. The link is present if link is === identical to a link object already in the collection.

Html\Link\Interfaces\EvolvableLinkInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Interfaces

  • Uses

  • Extends

    LinkInterface

  • Implements

An evolvable link value object.

Methods

public function withAttribute( string $attribute, string $value ): EvolvableLinkInterface;

Returns an instance with the specified attribute added.

If the specified attribute is already present, it will be overwritten with the new value.

public function withHref( string $href ): EvolvableLinkInterface;

Returns an instance with the specified href.

public function withRel( string $rel ): EvolvableLinkInterface;

Returns an instance with the specified relationship included.

If the specified rel is already present, this method MUST return normally without errors, but without adding the rel a second time.

public function withoutAttribute( string $attribute ): EvolvableLinkInterface;

Returns an instance with the specified attribute excluded.

If the specified attribute is not present, this method MUST return normally without errors.

public function withoutRel( string $rel ): EvolvableLinkInterface;

Returns an instance with the specified relationship excluded.

If the specified rel is already not present, this method MUST return normally without errors.

Html\Link\Interfaces\EvolvableLinkProviderInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Interfaces

  • Uses

  • Extends

    LinkProviderInterface

  • Implements

An evolvable link provider value object.

Methods

public function withLink( LinkInterface $link ): EvolvableLinkProviderInterface;

Returns an instance with the specified link included.

If the specified link is already present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

public function withoutLink( LinkInterface $link ): EvolvableLinkProviderInterface;

Returns an instance with the specifed link removed.

If the specified link is not present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

Html\Link\Interfaces\LinkInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Interfaces

  • Uses

  • Extends

  • Implements

A readable link object.

Methods

public function getAttributes(): array;

Returns a list of attributes that describe the target URI.

public function getHref(): 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.

public function getRels(): 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.

public function isTemplated(): bool;

Returns whether this is a templated link.

Html\Link\Interfaces\LinkProviderInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Interfaces

  • Uses

  • Extends

  • Implements

A link provider object.

Methods

public function getLinks(): array;

Returns an array of LinkInterface objects.

public function getLinksByRel( string $rel ): array;

Returns an array of LinkInterface objects that have a specific relationship.

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Html\Link\Interfaces\LinkInterface
    • Phalcon\Support\Collection
    • Phalcon\Support\Collection\CollectionInterface

  • Extends

    AbstractLink

  • Implements

    • LinkInterface

Class Phalcon\Http\Link\Link

@property array attributes @property string href @property array rels @property bool templated

Methods

public function getAttributes(): array;

Returns a list of attributes that describe the target URI.

public function getHref(): 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.

public function getRels(): 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.

public function isTemplated(): bool;

Returns whether or not this is a templated link.

Html\Link\LinkProvider

Source on GitHub

  • Namespace

    • Phalcon\Html\Link

  • Uses

    • Phalcon\Html\Link\Interfaces\LinkInterface
    • Phalcon\Html\Link\Interfaces\LinkProviderInterface

  • Extends

    AbstractLinkProvider

  • Implements

    • LinkProviderInterface

@property LinkInterface[] links

Methods

public function getLinks(): array;

Returns an iterable of LinkInterface objects.

The iterable may be an array or any PHP \Traversable object. If no links are available, an empty array or \Traversable MUST be returned.

public function getLinksByRel( mixed $rel ): array;

Returns an iterable of LinkInterface objects that have a specific relationship.

The iterable may be an array or any PHP \Traversable object. If no links with that relationship are available, an empty array or \Traversable MUST be returned.

Html\Link\Serializer\Header

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Serializer

  • Uses

  • Extends

  • Implements

    • SerializerInterface

Class Phalcon\Http\Link\Serializer\Header

Methods

public function serialize( array $links ): string | null;

Serializes all the passed links to a HTTP link header

Html\Link\Serializer\SerializerInterface Interface

Source on GitHub

  • Namespace

    • Phalcon\Html\Link\Serializer

  • Uses

  • Extends

  • Implements

Class Phalcon\Http\Link\Serializer\SerializerInterface

Methods

public function serialize( array $links ): string | null;

Serializer method

Html\TagFactory

Source on GitHub

  • Namespace

    • Phalcon\Html

  • Uses

    • Phalcon\Factory\AbstractFactory
    • Phalcon\Html\Escaper\EscaperInterface
    • Phalcon\Html\Helper\Breadcrumbs
    • Phalcon\Html\Helper\Doctype
    • Phalcon\Html\Helper\Input\Checkbox
    • Phalcon\Html\Helper\Input\Color
    • Phalcon\Html\Helper\Input\Date
    • Phalcon\Html\Helper\Input\DateTime
    • Phalcon\Html\Helper\Input\DateTimeLocal
    • Phalcon\Html\Helper\Input\Email
    • Phalcon\Html\Helper\Input\File
    • Phalcon\Html\Helper\Input\Hidden
    • Phalcon\Html\Helper\Input\Image
    • Phalcon\Html\Helper\Input\Input
    • Phalcon\Html\Helper\Input\Month
    • Phalcon\Html\Helper\Input\Numeric
    • Phalcon\Html\Helper\Input\Password
    • Phalcon\Html\Helper\Input\Radio
    • Phalcon\Html\Helper\Input\Range
    • Phalcon\Html\Helper\Input\Search
    • Phalcon\Html\Helper\Input\Select
    • Phalcon\Html\Helper\Input\Submit
    • Phalcon\Html\Helper\Input\Tel
    • Phalcon\Html\Helper\Input\Text
    • Phalcon\Html\Helper\Input\Textarea
    • Phalcon\Html\Helper\Input\Time
    • Phalcon\Html\Helper\Input\Url
    • Phalcon\Html\Helper\Input\Week
    • Phalcon\Html\Helper\Meta
    • Phalcon\Html\Helper\Ol
    • Phalcon\Html\Helper\Script
    • Phalcon\Html\Helper\Style
    • Phalcon\Html\Helper\Title
    • Phalcon\Html\Helper\Ul
    • Phalcon\Html\Link\Link

  • Extends

    AbstractFactory

  • Implements

ServiceLocator implementation for Tag helpers.

Services are registered using the constructor using a key-value pair. The key is the name of the tag helper, while the value is a callable that returns the object.

The class implements __call() to allow calling helper objects as methods.

@property EscaperInterface $escaper @property array $services

@method string a(string $href, string $text, array $attributes = [], bool $raw = false) @method string base(string $href, array $attributes = []) @method Breadcrumbs breadcrumbs(string $indent = ’ ’, string $delimiter = “\n”) @method string body(array $attributes = []) @method string button(string $text, array $attributes = [], bool $raw = false) @method string close(string $tag, bool $raw = false) @method Doctype doctype(int $flag, string $delimiter) @method string element(string $tag, string $text, array $attributes = [], bool $raw = false) @method string form(array $attributes = []) @method string img(string $src, array $attributes = []) @method Checkbox inputCheckbox(string $name, string $value = null, array $attributes = []) @method Color inputColor(string $name, string $value = null, array $attributes = []) @method Date inputDate(string $name, string $value = null, array $attributes = []) @method DateTime inputDateTime(string $name, string $value = null, array $attributes = []) @method DateTimeLocal inputDateTimeLocal(string $name, string $value = null, array $attributes = []) @method Email inputEmail(string $name, string $value = null, array $attributes = []) @method File inputFile(string $name, string $value = null, array $attributes = []) @method Hidden inputHidden(string $name, string $value = null, array $attributes = []) @method Image inputImage(string $name, string $value = null, array $attributes = []) @method Input inputInput(string $name, string $value = null, array $attributes = []) @method Month inputMonth(string $name, string $value = null, array $attributes = []) @method Numeric inputNumeric(string $name, string $value = null, array $attributes = []) @method Password inputPassword(string $name, string $value = null, array $attributes = []) @method Radio inputRadio(string $name, string $value = null, array $attributes = []) @method Range inputRange(string $name, string $value = null, array $attributes = []) @method Search inputSearch(string $name, string $value = null, array $attributes = []) @method Select inputSelect(string $name, string $value = null, array $attributes = []) @method Submit inputSubmit(string $name, string $value = null, array $attributes = []) @method Tel inputTel(string $name, string $value = null, array $attributes = []) @method Text inputText(string $name, string $value = null, array $attributes = []) @method Textarea inputTextarea(string $name, string $value = null, array $attributes = []) @method Time inputTime(string $name, string $value = null, array $attributes = []) @method Url inputUrl(string $name, string $value = null, array $attributes = []) @method Week inputWeek(string $name, string $value = null, array $attributes = []) @method string label(string $label, array $attributes = [], bool $raw = false) @method Link link(string $indent = ’ ’, string $delimiter = PHP_EOL) @method Meta meta(string $indent = ’ ’, string $delimiter = PHP_EOL) @method Ol ol(string $text, array $attributes = [], bool $raw = false) @method Script script(string $indent = ’ ’, string $delimiter = PHP_EOL) @method Style style(string $indent = ’ ’, string $delimiter = PHP_EOL) @method Title title(string $indent = ’ ’, string $delimiter = PHP_EOL) @method Ul ul(string $text, array $attributes = [], bool $raw = false)

Properties

/**
 * @var EscaperInterface
 */
private $escaper;

/**
 * @var array
 */
protected $services;

Methods

public function __call( string $name, array $arguments );

Magic call to make the helper objects available as methods.

public function __construct( EscaperInterface $escaper, array $services = [] );

TagFactory constructor.

public function has( string $name ): bool;
public function newInstance( string $name ): mixed;

Create a new instance of the object

public function set( string $name, mixed $method ): void;
protected function getExceptionClass(): string;
protected function getServices(): array;

Returns the available services

Type to search…

↑↓ navigate↵ selectEsc close