| Namespace | Phalcon\Html | Uses | Phalcon\Collection, Phalcon\Html\Attributes\RenderInterface, Phalcon\Tag | 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
Russian
Turkish
Chinese Simplifiedpublic function __toString(): string;
Alias of the render method
public function render(): string;
Render attributes as HTML attributes
| 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
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 )
public function toArray(): array;
Returns the internal breadcrumbs array
| Namespace | Phalcon\Html | Extends | \Phalcon\Exception |
Phalcon\Html\Tag\Exception
Exceptions thrown in Phalcon\Html\Tag will use this class
| Namespace | Phalcon\Html\Helper | Uses | Phalcon\Escaper\EscaperInterface, Phalcon\Html\Exception |
Class AbstractHelper
@property string $delimiter @property Escaper $escaper @property string $indent @property int $indentLevel
/**
* @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 = null, 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 |
Class AbstractSeries
/**
* @var array
*/
protected attributes;
/**
* @var array
*/
protected store;
public function __invoke( string $indent = null, 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</p>
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 | | 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
@property array $attributes @property string $type @property string $value
/**
* @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\Escaper\EscaperInterface, Phalcon\Helper\Arr | | Extends | AbstractInput |
Class Checkbox
@property array $label
/**
* @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 = numeric;
| 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
@property string $elementTag @property bool $inOptGroup @property string $selected
/**
* @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 an element to the list
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\Helper\Arr, 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( array $attributes = [] ): string;
Produce a <label> tag.
| Namespace | Phalcon\Html\Helper | | Extends | AbstractSeries |
Class Link
public function add( string $rel, string $href ): Link;
Add an element to the list
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 | | Extends | Style |
Class Script
protected function getAttributes( string $src, array $attributes ): array;
Returns the necessary attributes
protected function getTag(): string;
| Namespace | Phalcon\Html\Helper | | Uses | Phalcon\Html\Exception | | Extends | AbstractSeries |
Class Style
public function add( string $href, array $attributes = [] );
Add an element to the list
protected function getAttributes( string $href, array $attributes ): array;
Returns the necessary attributes
protected function getTag(): string;
| 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
/**
* @var array
*/
protected append;
/**
* @var array
*/
protected prepend;
/**
* @var string
*/
protected title = ;
/**
* @var string
*/
protected separator = ;
public function __invoke( string $separator = string, string $indent = null, 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
| Namespace | Phalcon\Html\Helper | | Extends | Ol |
Class Ul
protected function getTag(): string;
| Namespace | Phalcon\Html\Link | | Uses | Psr\Link\EvolvableLinkInterface | | Extends | Link | | Implements | EvolvableLinkInterface |
Class Phalcon\Http\Link\EvolvableLink
@property array attributes @property string href @property array rels @property bool templated
public function withAttribute( mixed $attribute, mixed $value );
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( mixed $href );
Returns an instance with the specified href.
public function withRel( mixed $rel );
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( mixed $attribute );
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( mixed $rel );
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 | Psr\Link\EvolvableLinkProviderInterface, Psr\Link\LinkInterface | | Extends | LinkProvider | | Implements | EvolvableLinkProviderInterface |
Class Phalcon\Http\Link\LinkProvider
@property LinkInterface[] links
public function withLink( LinkInterface $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.
public function withoutLink( LinkInterface $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.
| Namespace | Phalcon\Html\Link | | Uses | Phalcon\Collection, Phalcon\Collection\CollectionInterface, Psr\Link\LinkInterface | | Implements | LinkInterface |
Class Phalcon\Http\Link\Link
@property array attributes @property string href @property array rels @property bool templated
/**
* @var Collection|CollectionInterface
*/
protected attributes;
/**
* @var string
*/
protected href = ;
/**
* @var Collection|CollectionInterface
*/
protected rels;
/**
* @var bool
*/
protected templated = false;
public function __construct( string $rel = string, string $href = string, array $attributes = [] );
Link constructor.
public function getAttributes();
Returns a list of attributes that describe the target URI.
public function getHref();
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();
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();
Returns whether or not this is a templated link.
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 | Psr\Link\LinkInterface, Psr\Link\LinkProviderInterface | | Implements | LinkProviderInterface |
Class Phalcon\Http\Link\LinkProvider
@property LinkInterface[] links
/**
* @var LinkInterface[]
*/
protected links;
public function __construct( array $links = [] );
LinkProvider constructor.
public function getLinks();
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 );
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 getKey( LinkInterface $link ): string;
Returns the object hash key
| Namespace | Phalcon\Html\Link\Serializer | | Uses | Psr\Link\EvolvableLinkInterface | | 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\Escaper, Phalcon\Escaper\EscaperInterface, Phalcon\Factory\AbstractFactory | | Extends | AbstractFactory |
ServiceLocator implementation for Tag helpers
/**
* @var EscaperInterface
*/
private escaper;
public function __construct( EscaperInterface $escaper, array $services = [] );
TagFactory constructor.
public function newInstance( string $name ): mixed;
protected function getAdapters(): array;