| Namespace | Phalcon\Html | Uses | Phalcon\Support\Collection, Phalcon\Html\Attributes\RenderInterface | Extends | Collection | Implements | RenderInterface |
This class helps to work with HTML Attributes
Czech
German
Greek
English (US)
Spanish
Persian
French
Indonesian
Italian
Japanese
Korean
Polish
Portuguese, Brazilian
Turkish
Ukrainian
Chinese Simplifiedpublic 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
| Namespace | Phalcon\Html\Attributes | Uses | Phalcon\Html\Attributes |
public function getAttributes(): Attributes;
Get Attributes
public function setAttributes( Attributes $attributes ): AttributesInterface;
Set Attributes
| Namespace | Phalcon\Html\Attributes |
public function render(): string;
Generate a string represetation
| 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.
/**
* 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>;
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
| 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
/**
* @var bool
*/
protected doubleEncode = true;
/**
* @var string
*/
protected encoding = utf-8;
/**
* ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
*
* @var int
*/
protected flags = 11;
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
| Namespace | Phalcon\Html\Escaper |
Interface for Phalcon\Html\Escaper
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
| Namespace | Phalcon\Html\Escaper | Extends | \Exception |
Exceptions thrown in Phalcon\Html\Escaper will use this class
| Namespace | Phalcon\Html |
Class EscaperFactory
public function newInstance(): Escaper;
Create a new instance of the object
| Namespace | Phalcon\Html | Extends | \Exception |
Phalcon\Html\Tag\Exception
Exceptions thrown in Phalcon\Html\Tag will use this class
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Escaper\EscaperInterface, Phalcon\Html\Exception |
/**
* @var string
*/
protected delimiter = ;
/**
* @var EscaperInterface
*/
protected escaper;
/**
* @var string
*/
protected indent = ;
/**
* @var int
*/
protected indentLevel = 1;
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.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class AbstractList
/**
* @var array
*/
protected attributes;
/**
* @var string
*/
protected elementTag = li;
/**
* @var array
*/
protected store;
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.
| Namespace | Phalcon\Html\Helper | Extends | AbstractHelper |
/**
* @var array
*/
protected attributes;
/**
* @var array
*/
protected store;
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.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Anchor
public function __invoke( string $href, string $text, array $attributes = [], bool $raw = bool ): string;
Produce a tag
protected function processAttributes( string $href, array $attributes ): array;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Base
public function __invoke( string $href = null, array $attributes = [] ): string;
Produce a <base/> tag.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Body
public function __invoke( array $attributes = [] ): string;
Produce a <body> tag.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Button
public function __invoke( string $text, array $attributes = [], bool $raw = bool ): string;
Produce a <button> tag.
| Namespace | Phalcon\Html\Helper | Extends | AbstractHelper |
Class Close
public function __invoke( string $tag, bool $raw = bool ): string;
Produce a </...> tag.
| Namespace | Phalcon\Html\Helper |
Creates Doctype tags
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;
/**
* @var string
*/
private delimiter;
/**
* @var int
*/
private flag;
public function __construct();
public function __invoke( int $flag = static-constant-access, string $delimiter = string ): Doctype;
Produce a
public function __toString(): string;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Element
public function __invoke( string $tag, string $text, array $attributes = [], bool $raw = bool ): string;
Produce a tag.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Form
public function __invoke( array $attributes = [] ): string;
Produce a <form> tag.
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Img
public function __invoke( string $src, array $attributes = [] ): string;
Produce a tag.
| Namespace | Phalcon\Html\Helper\Input | Uses | Phalcon\Html\Helper\AbstractHelper | Extends | AbstractHelper |
Class AbstractInput
/**
* @var string
*/
protected type = text;
/**
* @var array
*/
protected attributes;
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
| Namespace | Phalcon\Html\Helper\Input | Uses | Phalcon\Html\Escaper\EscaperInterface | Extends | AbstractInput |
Class Checkbox
/**
* @var array
*/
protected label;
/**
* @var string
*/
protected type = checkbox;
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
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Color
//
protected type = color;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Date
//
protected type = date;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class DateTime
//
protected type = datetime;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class DateTimeLocal
//
protected type = datetime-local;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Email
//
protected type = email;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class File
//
protected type = file;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Hidden
//
protected type = hidden;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Image
//
protected type = image;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Input
public function setType( string $type ): AbstractInput;
Sets the type of the input
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Month
//
protected type = month;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Numeric
//
protected type = number;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Password
//
protected type = password;
| Namespace | Phalcon\Html\Helper\Input | Extends | Checkbox |
Class Radio
/**
* @var string
*/
protected type = radio;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Range
//
protected type = range;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Search
//
protected type = search;
| Namespace | Phalcon\Html\Helper\Input | Uses | Phalcon\Html\Helper\AbstractList | Extends | AbstractList |
Class Select
/**
* @var string
*/
protected elementTag = option;
/**
* @var bool
*/
protected inOptGroup = false;
/**
* @var string
*/
protected selected = ;
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;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Submit
//
protected type = submit;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Tel
//
protected type = tel;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Text
| Namespace | Phalcon\Html\Helper\Input | Uses | Phalcon\Html\Exception | Extends | AbstractInput |
Class Textarea
/**
* @var string
*/
protected type = textarea;
public function __toString();
Returns the HTML for the input.
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Time
//
protected type = time;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Url
//
protected type = url;
| Namespace | Phalcon\Html\Helper\Input | Extends | AbstractInput |
Class Week
//
protected type = week;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Label
public function __invoke( string $label, array $attributes = [], bool $raw = bool ): string;
Produce a <label> tag.
| Namespace | Phalcon\Html\Helper | Extends | Style |
Creates tags
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;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractSeries |
Class Meta
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;
| Namespace | Phalcon\Html\Helper | Extends | AbstractList |
Class Ol
public function add( string $text, array $attributes = [], bool $raw = bool ): AbstractList;
Add an element to the list
protected function getTag(): string;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractSeries |
Class Script
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;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractSeries |
Class Style
/**
* @var bool
*/
private isStyle = false;
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;
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Html\Exception | Extends | AbstractHelper |
Class Title
/**
* @var array
*/
protected append;
/**
* @var array
*/
protected prepend;
/**
* @var string
*/
protected title = ;
/**
* @var string
*/
protected separator = ;
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
| Namespace | Phalcon\Html\Helper | Extends | Ol |
Class Ul
protected function getTag(): string;
| Namespace | Phalcon\Html\Link | Uses | Phalcon\Support\Collection |
/**
* @var Collection
*/
protected attributes;
/**
* @var string
*/
protected href = ;
/**
* @var Collection
*/
protected rels;
/**
* @var bool
*/
protected templated = false;
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:
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
| Namespace | Phalcon\Html\Link | Uses | Phalcon\Html\Link\Interfaces\LinkInterface |
/**
* @var array
*/
protected links;
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
| Namespace | Phalcon\Html\Link | Uses | Phalcon\Html\Link\Interfaces\EvolvableLinkInterface | Extends | Link | Implements | EvolvableLinkInterface |
Class Phalcon\Http\Link\EvolvableLink
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.
| Namespace | Phalcon\Html\Link | Uses | Phalcon\Html\Link\Interfaces\EvolvableLinkProviderInterface, Phalcon\Html\Link\Interfaces\LinkInterface | Extends | LinkProvider | Implements | EvolvableLinkProviderInterface |
Class Phalcon\Http\Link\LinkProvider
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.
| Namespace | Phalcon\Html\Link\Interfaces | Extends | LinkInterface |
An evolvable link value object.
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.
| Namespace | Phalcon\Html\Link\Interfaces | Extends | LinkProviderInterface |
An evolvable link provider value object.
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.
| Namespace | Phalcon\Html\Link\Interfaces |
A readable link object.
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:
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.
| Namespace | Phalcon\Html\Link\Interfaces |
A link provider object.
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.
| 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
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:
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.
| Namespace | Phalcon\Html\Link | Uses | Phalcon\Html\Link\Interfaces\LinkInterface, Phalcon\Html\Link\Interfaces\LinkProviderInterface | Extends | AbstractLinkProvider | Implements | LinkProviderInterface |
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.
| Namespace | Phalcon\Html\Link\Serializer | Implements | SerializerInterface |
Class Phalcon\Http\Link\Serializer\Header
public function serialize( array $links ): string | null;
Serializes all the passed links to a HTTP link header
| Namespace | Phalcon\Html\Link\Serializer |
Class Phalcon\Http\Link\Serializer\SerializerInterface
public function serialize( array $links ): string | null;
Serializer method
| 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.
/**
* @var EscaperInterface
*/
private escaper;
/**
* @var array
*/
protected services;
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