Phalcon Tag | Phalcon Documentation

Tag

Phalcon\Tag is designed to simplify building of HTML tags. It provides a set of helpers to generate HTML in a dynamic way. This component is a class that you can extend to add more helpers.

Phalcon\Tag

Uses Phalcon\Di\Di · Phalcon\Di\DiInterface · Phalcon\Html\Escaper\EscaperInterface · Phalcon\Html\Link\Link · Phalcon\Html\Link\Serializer\Header · Phalcon\Mvc\Url\UrlInterface · Phalcon\Support\Helper\Str\Friendly · Phalcon\Tag\Exception · Phalcon\Tag\Select

Method Summary

Constants

intHTML32 = 1

intHTML401_FRAMESET = 4

intHTML401_STRICT = 2

intHTML401_TRANSITIONAL = 3

intHTML5 = 5

intXHTML10_FRAMESET = 8

intXHTML10_STRICT = 6

intXHTML10_TRANSITIONAL = 7

intXHTML11 = 9

intXHTML20 = 10

intXHTML5 = 11

Properties

protectedbool$autoEscape = true

protectedDiInterface|null$container = nullDI Container

protectedarray$displayValuesPre-assigned values for components

protectedarray$documentAppendTitle

protectedarray$documentPrependTitle

protectedstring|null$documentTitle = nullHTML document title

protectedstring|null$documentTitleSeparator = null

protectedint$documentType = 11

protectedEscaperInterface|null$escaperService = null

protectedUrlInterface|null$urlService = null

Methods

Public · 56

`appendTitle()`

public static function appendTitle( mixed $title ): void;

Appends a text to current document title

`checkField()`

public static function checkField( mixed $parameters ): string;

Builds a HTML input[type=“check”] tag

`colorField()`

public static function colorField( mixed $parameters ): string;

Builds a HTML input[type=“color”] tag

`dateField()`

public static function dateField( mixed $parameters ): string;

Builds a HTML input[type=“date”] tag

`dateTimeField()`

public static function dateTimeField( mixed $parameters ): string;

Builds a HTML input[type=“datetime”] tag

`dateTimeLocalField()`

public static function dateTimeLocalField( mixed $parameters ): string;

Builds a HTML input[type=“datetime-local”] tag

`displayTo()`

public static function displayTo(
    string $id,
    mixed $value
): void;

Alias of Phalcon\Tag::setDefault()

`emailField()`

public static function emailField( mixed $parameters ): string;

Builds a HTML input[type=“email”] tag

`endForm()`

public static function endForm(): string;

Builds a HTML close FORM tag

`fileField()`

public static function fileField( mixed $parameters ): string;

Builds a HTML input[type=“file”] tag

`formLegacy()`

public static function formLegacy( mixed $parameters ): string;

Builds a HTML FORM tag

`friendlyTitle()`

public static function friendlyTitle(
    string $text,
    string $separator = "-",
    bool $lowercase = true,
    mixed $replace = null
): string;

Converts texts into URL-friendly titles

`getDI()`

public static function getDI(): DiInterface;

Internally gets the request dispatcher

`getDocType()`

public static function getDocType(): string;

Get the document type declaration of content

`getEscaper()`

public static function getEscaper( array $params ): EscaperInterface|null;

Obtains the ‘escaper’ service if required

`getEscaperService()`

public static function getEscaperService(): EscaperInterface;

Returns an Escaper service from the default DI

`getTitle()`

public static function getTitle(
    bool $prepend = true,
    bool $append = true
): string;

Gets the current document title. The title will be automatically escaped.

`getTitleSeparator()`

public static function getTitleSeparator(): string;

Gets the current document title separator

`getUrlService()`

public static function getUrlService(): UrlInterface;

Returns a URL service from the default DI

`getValue()`

public static function getValue(
    mixed $name,
    array $params = []
);

Every helper calls this function to check whether a component has a predefined value using Phalcon\Tag::setDefault() or value from $_POST

`hasValue()`

public static function hasValue( mixed $name ): bool;

Check if a helper has a default value set using Phalcon\Tag::setDefault() or value from $_POST

`hiddenField()`

public static function hiddenField( mixed $parameters ): string;

Builds a HTML input[type=“hidden”] tag

`image()`

public static function image(
    mixed $parameters = null,
    bool $local = true
): string;

Builds HTML IMG tags

`imageInput()`

public static function imageInput( mixed $parameters ): string;

Builds a HTML input[type=“image”] tag

`javascriptInclude()`

public static function javascriptInclude(
    mixed $parameters = null,
    bool $local = true
): string;

Builds a SCRIPT[type=“javascript”] tag

`linkTo()`

public static function linkTo(
    mixed $parameters,
    mixed $text = null,
    mixed $local = true
): string;

Builds a HTML A tag using framework conventions

`monthField()`

public static function monthField( mixed $parameters ): string;

Builds a HTML input[type=“month”] tag

`numericField()`

public static function numericField( mixed $parameters ): string;

Builds a HTML input[type=“number”] tag

`passwordField()`

public static function passwordField( mixed $parameters ): string;

Builds a HTML input[type=“password”] tag

`preload()`

public static function preload( mixed $parameters ): string;

Parses the preload element passed and sets the necessary link headers

`prependTitle()`

public static function prependTitle( mixed $title ): void;

Prepends a text to current document title

`radioField()`

public static function radioField( mixed $parameters ): string;

Builds a HTML input[type=“radio”] tag

`rangeField()`

public static function rangeField( mixed $parameters ): string;

Builds a HTML input[type=“range”] tag

`renderAttributes()`

public static function renderAttributes(
    string $code,
    array $attributes
): string;

Renders parameters keeping order in their HTML attributes

`renderTitle()`

public static function renderTitle(
    bool $prepend = true,
    bool $append = true
): string;

Renders the title with title tags. The title is automatically escaped

`resetInput()`

deprecated public static function resetInput(): void;

Resets the request and internal values to avoid those fields will have any default value.

`searchField()`

public static function searchField( mixed $parameters ): string;

Builds a HTML input[type=“search”] tag

`select()`

public static function select(
    mixed $parameters,
    mixed $data = null
): string;

Builds a HTML SELECT tag using a Phalcon\Mvc\Model resultset as options

`selectStatic()`

public static function selectStatic(
    mixed $parameters,
    mixed $data = null
): string;

Builds a HTML SELECT tag using a PHP array for options

`setAutoescape()`

public static function setAutoescape( bool $autoescape ): void;

Set autoescape mode in generated HTML

`setDI()`

public static function setDI( DiInterface $container ): void;

Sets the dependency injector container.

`setDefault()`

public static function setDefault(
    string $id,
    mixed $value
): void;

Assigns default values to generated tags by helpers

`setDefaults()`

public static function setDefaults(
    array $values,
    bool $merge = false
): void;

Assigns default values to generated tags by helpers

`setDocType()`

public static function setDocType( int $doctype ): void;

Set the document type of content

`setTitle()`

public static function setTitle( string $title ): void;

Set the title of view content

`setTitleSeparator()`

public static function setTitleSeparator( string $titleSeparator ): void;

Set the title separator of view content

`stylesheetLink()`

public static function stylesheetLink(
    mixed $parameters = null,
    bool $local = true
): string;

Builds a LINK[rel=“stylesheet”] tag

`submitButton()`

public static function submitButton( mixed $parameters ): string;

Builds a HTML input[type=“submit”] tag

`tagHtml()`

public static function tagHtml(
    string $tagName,
    mixed $parameters = null,
    bool $selfClose = false,
    bool $onlyStart = false,
    bool $useEol = false
): string;

Builds a HTML tag

`tagHtmlClose()`

public static function tagHtmlClose(
    string $tagName,
    bool $useEol = false
): string;

Builds a HTML tag closing tag

`telField()`

public static function telField( mixed $parameters ): string;

Builds a HTML input[type=“tel”] tag

`textArea()`

public static function textArea( mixed $parameters ): string;

Builds a HTML TEXTAREA tag

@paraym array parameters = [ ‘id’ => ‘’, ‘name’ => ‘’, ‘value’ => ‘’, ‘class’ => ‘’ ]

`textField()`

public static function textField( mixed $parameters ): string;

Builds a HTML input[type=“text”] tag

`timeField()`

public static function timeField( mixed $parameters ): string;

Builds a HTML input[type=“time”] tag

`urlField()`

public static function urlField( mixed $parameters ): string;

Builds a HTML input[type=“url”] tag

`weekField()`

public static function weekField( mixed $parameters ): string;

Builds a HTML input[type=“week”] tag

Protected · 2

`inputField()`

static final protected function inputField(
    string $type,
    mixed $parameters,
    bool $asValue = false
): string;

Builds generic INPUT tags

`inputFieldChecked()`

static final protected function inputFieldChecked(
    string $type,
    mixed $parameters
): string;

Builds INPUT tags that implements the checked attribute

Tag\Exception

ClassSource on GitHub

Phalcon\Tag\Exception

Exceptions thrown in Phalcon\Tag will use this class

\Exception
- Phalcon\Tag\Exception

Tag\Select

AbstractSource on GitHub

Phalcon\Tag\Select

Generates a SELECT HTML tag using a static array of values or a Phalcon\Mvc\Model resultset

Phalcon\Tag\Select

Uses Phalcon\Html\Escaper\EscaperInterface · Phalcon\Mvc\Model\ResultsetInterface · Phalcon\Tag

Method Summary

publicstringselectField(mixed$parameters,mixed$data = null)Generates a SELECT tag

Methods

Public · 1

`selectField()`

public static function selectField(
    mixed $parameters,
    mixed $data = null
): string;

Generates a SELECT tag