Sections

Class Phalcon\Html\Attributes

Source on GitHub

Namespace Phalcon\Html   Uses Phalcon\Support\Collection, Phalcon\Html\Attributes\RenderInterface   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

Interface Phalcon\Html\Attributes\AttributesInterface

Source on GitHub

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

Methods

public function getAttributes(): Attributes;

Get Attributes

public function setAttributes( Attributes $attributes ): AttributesInterface;

Set Attributes

Interface Phalcon\Html\Attributes\RenderInterface

Source on GitHub

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

Methods

public function render(): string;

Generate a string represetation

Class Phalcon\Html\Breadcrumbs

Source on GitHub

Namespace Phalcon\Html   Uses Phalcon\Di\DiInterface

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.

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

Class Phalcon\Html\Escaper

Source on GitHub

Namespace Phalcon\Html   Uses Phalcon\Html\Escaper\EscaperInterface   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

Interface Phalcon\Html\Escaper\EscaperInterface

Source on GitHub

Namespace Phalcon\Html\Escaper

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

Class Phalcon\Html\Escaper\Exception

Source on GitHub

Namespace Phalcon\Html\Escaper   Extends \Exception

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

Class Phalcon\Html\EscaperFactory

Source on GitHub

Namespace Phalcon\Html

Class EscaperFactory

Methods

public function newInstance(): Escaper;

Create a new instance of the object

Class Phalcon\Html\Exception

Source on GitHub

Namespace Phalcon\Html   Extends \Exception

Phalcon\Html\Tag\Exception

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

Abstract Class Phalcon\Html\Helper\AbstractHelper

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Escaper\EscaperInterface, Phalcon\Html\Exception

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

Properties

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

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

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

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

Methods

public function __construct( EscaperInterface $escaper );

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.

Abstract Class Phalcon\Html\Helper\AbstractList

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

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.

Abstract Class Phalcon\Html\Helper\AbstractSeries

Source on GitHub

Namespace Phalcon\Html\Helper   Extends AbstractHelper

@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.

abstract protected function getTag(): string;

Returns the tag name.

Class Phalcon\Html\Helper\Anchor

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Anchor

Methods

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

Produce a tag

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

Class Phalcon\Html\Helper\Base

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Base

Methods

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

Produce a <base/> tag.

Class Phalcon\Html\Helper\Body

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Body

Methods

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

Produce a <body> tag.

Class Phalcon\Html\Helper\Button

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Button

Methods

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

Produce a <button> tag.

Class Phalcon\Html\Helper\Close

Source on GitHub

Namespace Phalcon\Html\Helper   Extends AbstractHelper

Class Close

Methods

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

Produce a </...> tag.

Class Phalcon\Html\Helper\Doctype

Source on GitHub

Namespace Phalcon\Html\Helper

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

Methods

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

Produce a tag

public function __toString(): string;

Class Phalcon\Html\Helper\Element

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Element

Methods

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

Produce a tag.

Class Phalcon\Html\Helper\Form

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Form

Methods

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

Produce a <form> tag.

Class Phalcon\Html\Helper\Img

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Img

Methods

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

Produce a tag.

Abstract Class Phalcon\Html\Helper\Input\AbstractInput

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Uses Phalcon\Html\Helper\AbstractHelper   Extends AbstractHelper

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

Class Phalcon\Html\Helper\Input\Checkbox

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Uses Phalcon\Html\Escaper\EscaperInterface   Extends AbstractInput

Class Checkbox

@property array $label

Properties

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

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

Methods

public function __construct( EscaperInterface $escaper );

AbstractHelper constructor.

public function __toString();

Returns the HTML for the input.

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

Attaches a label to the element

Class Phalcon\Html\Helper\Input\Color

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Color

Properties

//
protected type = color;

Class Phalcon\Html\Helper\Input\Date

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Date

Properties

//
protected type = date;

Class Phalcon\Html\Helper\Input\DateTime

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class DateTime

Properties

//
protected type = datetime;

Class Phalcon\Html\Helper\Input\DateTimeLocal

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class DateTimeLocal

Properties

//
protected type = datetime-local;

Class Phalcon\Html\Helper\Input\Email

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Email

Properties

//
protected type = email;

Class Phalcon\Html\Helper\Input\File

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class File

Properties

//
protected type = file;

Class Phalcon\Html\Helper\Input\Hidden

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Hidden

Properties

//
protected type = hidden;

Class Phalcon\Html\Helper\Input\Image

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Image

Properties

//
protected type = image;

Class Phalcon\Html\Helper\Input\Input

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Input

Methods

public function setType( string $type ): AbstractInput;

Sets the type of the input

Class Phalcon\Html\Helper\Input\Month

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Month

Properties

//
protected type = month;

Class Phalcon\Html\Helper\Input\Numeric

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Numeric

Properties

//
protected type = number;

Class Phalcon\Html\Helper\Input\Password

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Password

Properties

//
protected type = password;

Class Phalcon\Html\Helper\Input\Radio

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends Checkbox

Class Radio

Properties

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

Class Phalcon\Html\Helper\Input\Range

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Range

Properties

//
protected type = range;

Class Phalcon\Html\Helper\Input\Search

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Search

Properties

//
protected type = search;

Class Phalcon\Html\Helper\Input\Select

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Uses Phalcon\Html\Helper\AbstractList   Extends AbstractList

Class Select

@property string $elementTag @property bool $inOptGroup @property string $selected

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;

Class Phalcon\Html\Helper\Input\Submit

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Submit

Properties

//
protected type = submit;

Class Phalcon\Html\Helper\Input\Tel

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Tel

Properties

//
protected type = tel;

Class Phalcon\Html\Helper\Input\Text

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Text

Class Phalcon\Html\Helper\Input\Textarea

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Uses Phalcon\Html\Exception   Extends AbstractInput

Class Textarea

Properties

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

Methods

public function __toString();

Returns the HTML for the input.

Class Phalcon\Html\Helper\Input\Time

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Time

Properties

//
protected type = time;

Class Phalcon\Html\Helper\Input\Url

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Url

Properties

//
protected type = url;

Class Phalcon\Html\Helper\Input\Week

Source on GitHub

Namespace Phalcon\Html\Helper\Input   Extends AbstractInput

Class Week

Properties

//
protected type = week;

Class Phalcon\Html\Helper\Label

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

Class Label

Methods

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

Produce a <label> tag.

Class Phalcon\Html\Helper\Link

Source on GitHub

Namespace Phalcon\Html\Helper   Extends Style

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

Class Phalcon\Html\Helper\Meta

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractSeries

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;

Class Phalcon\Html\Helper\Ol

Source on GitHub

Namespace Phalcon\Html\Helper   Extends AbstractList

Class Ol

Methods

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

Add an element to the list

protected function getTag(): string;

Class Phalcon\Html\Helper\Script

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractSeries

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;

Class Phalcon\Html\Helper\Style

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractSeries

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;

Class Phalcon\Html\Helper\Title

Source on GitHub

Namespace Phalcon\Html\Helper   Uses Phalcon\Html\Exception   Extends AbstractHelper

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

Class Phalcon\Html\Helper\Ul

Source on GitHub

Namespace Phalcon\Html\Helper   Extends Ol

Class Ul

Methods

protected function getTag(): string;

Abstract Class Phalcon\Html\Link\AbstractLink

Source on GitHub

Namespace Phalcon\Html\Link   Uses Phalcon\Support\Collection

@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

Abstract Class Phalcon\Html\Link\AbstractLinkProvider

Source on GitHub

Namespace Phalcon\Html\Link   Uses Phalcon\Html\Link\Interfaces\LinkInterface

@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

Class Phalcon\Html\Link\EvolvableLink

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.

Class Phalcon\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.

Interface Phalcon\Html\Link\Interfaces\EvolvableLinkInterface

Source on GitHub

Namespace Phalcon\Html\Link\Interfaces   Extends LinkInterface

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.

Interface Phalcon\Html\Link\Interfaces\EvolvableLinkProviderInterface

Source on GitHub

Namespace Phalcon\Html\Link\Interfaces   Extends LinkProviderInterface

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.

Interface Phalcon\Html\Link\Interfaces\LinkInterface

Source on GitHub

Namespace Phalcon\Html\Link\Interfaces

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.

Interface Phalcon\Html\Link\Interfaces\LinkProviderInterface

Source on GitHub

Namespace Phalcon\Html\Link\Interfaces

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.

Class Phalcon\Html\Link\Link

Source on GitHub

Namespace Phalcon\Html\Link   Uses Phalcon\Support\Collection, Phalcon\Support\Collection\CollectionInterface, Phalcon\Html\Link\Interfaces\LinkInterface   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.

Class Phalcon\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.

Class Phalcon\Html\Link\Serializer\Header

Source on GitHub

Namespace Phalcon\Html\Link\Serializer   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

Interface Phalcon\Html\Link\Serializer\SerializerInterface

Source on GitHub

Namespace Phalcon\Html\Link\Serializer

Class Phalcon\Http\Link\Serializer\SerializerInterface

Methods

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

Serializer method

Class Phalcon\Html\TagFactory

Source on GitHub

Namespace Phalcon\Html   Uses Phalcon\Html\Escaper, Phalcon\Html\Escaper\EscaperInterface, Phalcon\Factory\AbstractFactory   Extends AbstractFactory

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 string body(array $attributes = []) @method string button(string $text, array $attributes = [], bool $raw = false) @method string close(string $tag, bool $raw = false) @method string 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 string inputCheckbox(string $name, string $value = null, array $attributes = []) @method string inputColor(string $name, string $value = null, array $attributes = []) @method string inputDate(string $name, string $value = null, array $attributes = []) @method string inputDateTime(string $name, string $value = null, array $attributes = []) @method string inputDateTimeLocal(string $name, string $value = null, array $attributes = []) @method string inputEmail(string $name, string $value = null, array $attributes = []) @method string inputFile(string $name, string $value = null, array $attributes = []) @method string inputHidden(string $name, string $value = null, array $attributes = []) @method string inputImage(string $name, string $value = null, array $attributes = []) @method string inputInput(string $name, string $value = null, array $attributes = []) @method string inputMonth(string $name, string $value = null, array $attributes = []) @method string inputNumeric(string $name, string $value = null, array $attributes = []) @method string inputPassword(string $name, string $value = null, array $attributes = []) @method string inputRadio(string $name, string $value = null, array $attributes = []) @method string inputRange(string $name, string $value = null, array $attributes = []) @method string inputSearch(string $name, string $value = null, array $attributes = []) @method string inputSelect(string $name, string $value = null, array $attributes = []) @method string inputSubmit(string $name, string $value = null, array $attributes = []) @method string inputTel(string $name, string $value = null, array $attributes = []) @method string inputText(string $name, string $value = null, array $attributes = []) @method string inputTextarea(string $name, string $value = null, array $attributes = []) @method string inputTime(string $name, string $value = null, array $attributes = []) @method string inputUrl(string $name, string $value = null, array $attributes = []) @method string inputWeek(string $name, string $value = null, array $attributes = []) @method string label(string $label, array $attributes = [], bool $raw = false) @method string link(string $indent = ‘ ‘, string $delimiter = PHP_EOL) @method string meta(string $indent = ‘ ‘, string $delimiter = PHP_EOL) @method string ol(string $text, array $attributes = [], bool $raw = false) @method string script(string $indent = ‘ ‘, string $delimiter = PHP_EOL) @method string style(string $indent = ‘ ‘, string $delimiter = PHP_EOL) @method string title(string $indent = ‘ ‘, string $delimiter = PHP_EOL) @method string 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