Tag

This file is part of the Phalcon Kit.

Represents a class that extends the Phalcon\Tag class and provides additional functionality.

• Full name: \PhalconKit\Tag
• Parent class: Tag

See Also:

• \Phalcon\Tag

Properties

meta

Represents an array that stores meta-information.

protected static array $meta

• This property is static.

link

Represents an array that stores link information.

protected static array $link

• This property is static.

attr

Represents an array that stores attributes.

protected static array $attr

• This property is static.

assetsManager

Represents a service for managing assets.

protected static \PhalconKit\Assets\Manager|null $assetsManager

• This property is static.

Methods

getAssetsManager

Retrieves the instance of the Assets Manager.

public static getAssetsManager(): \PhalconKit\Assets\Manager

• This method is static. Return Value:

The instance of the Assets Manager

setAssetsManager

Sets the assets manager to be used.

public static setAssetsManager(\PhalconKit\Assets\Manager|null $assetsManager): void

• This method is static. Parameters:

getEscaper

Retrieves the configured escaper instance.

public static getEscaper(array $params): \Phalcon\Html\Escaper\EscaperInterface|null

• This method is static. Parameters:

Return Value:

The configured escaper instance, or null if no escaper is found.

Throws:

If the retrieved escaper instance is not an instance of Escaper. - AssertionError

See Also:

• \Phalcon\Tag::getEscaper()

getEscaperService

Retrieves the escaper service.

public static getEscaperService(): \Phalcon\Html\Escaper\EscaperInterface

• This method is static. Return Value:

The instance of the escaper service.

Throws:

If the retrieved escaper instance is not an instance of Escaper. - AssertionError

See Also:

• \Phalcon\Tag::getEscaperService()

title

Prints the page title with optional prefixes and suffixes.

public static title(bool $prepend = true, bool $append = true): void

• This method is static. Parameters:

implodeSprintf

Implode the elements of an array using sprintf and optional glue.

public static implodeSprintf(array $array, string $format = '%s', string|null $glue = null): string

Example:

Tag::implodeSprintf(['class' => 'class1 class2', 'id' => 'my-id', 'test' => ['test1', 'test2']], '%%2$s="%%1$s"', ' ');

Result:

class="class1 class2" id="my-id" test="{['test1', 'test2']}"

• This method is static. Parameters:

Return Value:

The resulting string after implodes. If the input array is empty, an empty string is returned.

escapeParam

Escapes a parameter value based on the attribute.

public static escapeParam(mixed $value = null, string|null $attr = null, string $glue = ' '): array

• This method is static. Parameters:

Return Value:

An array containing the escaped value and the attribute.

get

Retrieves the HTML representation of a specified tag, along with optional parameters and content.

public static get(string $tag, array $params = [], array $html = [], string|null $glue = null): string

Example 1:

Tag::get('div', ['class' => 'class1 class2'], ['content1', 'content2']);

<div class="class1 class2">content1</div>
<div class="class1 class2">content2</div>

Example 2:

Tag::get('div', ['class' => 'class1 class2'], ['content1', 'content2'], ' ');

<div class="class1 class2">content1 content2</div>

Example 3:

Tag::get('footer', ['class' => 'my-footer-class'], [
     Tag::get('ul', ['class' => 'my-ul-class'], [
         Tag::get('li', ['class'] => 'my-li-class', ['content1', 'content2']),
         Tag::get('li', ['class'] => 'my-li-class-2', ['content3', 'content4']),
     ],
     Tag::get('ul', ['class' => 'my-ul-class-2'], [
         Tag::get('li', ['class'] => 'my-li-class-3', ['content5', 'content6']),
     ], ''
], ' ');

<footer class="my-footer-class">
     <ul class="my-ul-class">
         <li class="my-li-class">content1</li>
         <li class="my-li-class">content2</li>
         <li class="my-li-class-2">content3</li>
         <li class="my-li-class-2">content4</li>
     </ul>
     <ul class="my-ul-class-2">
         <li class="my-li-class-3">content5 content6</li>
     </ul>
</div>

• This method is static. Parameters:

Return Value:

The HTML representation of the tag, including parameters and content.

getTag

Retrieves a formatted string representing a specific tag with the given parameters and HTML attributes.

public static getTag(string $tag, array $params = [], array $html = [], string|null $glue = null): string

• This method is static. Parameters:

Return Value:

The formatted HTML string representing the tag with the provided parameters and attributes.

tag

Prints the HTML code for a given tag, with optional parameters and HTML attributes.

public static tag(string $tag, array $params = [], array $html = [], ?string $glue = null): void

• This method is static. Parameters:

getTagParams

Retrieves the tag parameters based on the given tag name, additional parameters, format string, and glue string.

public static getTagParams(string $tag, array $params = [], string $format = ' %2$s="%1$s"', string|null $glue = null): string

• This method is static. Parameters:

Return Value:

The formatted tag parameters joined by the glue string.

tagParams

Returns a formatted string containing tag parameters for the specified tag.

public static tagParams(string $tag, array $params = [], string $format = ' %2$s="%1$s"', string|null $glue = null): void

• This method is static. Parameters:

getParams

Will sprintf an array_map of the array and then implode it with a ' ' glue - Escape attrs and values during the process

public static getParams(array $params = [], string $format = ' %2$s="%1$s"', ?string $glue = null): string

Example:

Tag::getParams(['class' => 'class1 class2', 'id' => 'my-id'])

Result:

class="class1 class2" id="my-id"

• This method is static. Parameters:

Return Value:

Return the imploded sprintf "%%2$s="%%1$s" from an array

params

Prints the formatted parameters to the output.

public static params(array $params = [], string $format = ' %2$s="%1$s"', null|string $glue = null): void

• This method is static. Parameters:

getAttr

Retrieves the attributes of a specific name from the existing list of attributes.

public static getAttr(string $name): array

• This method is static. Parameters:

Return Value:

An array containing the attributes corresponding to the given name. If the attribute does not exist, an empty array is returned.

getAttrs

Retrieves the existing list of attributes.

public static getAttrs(): array

• This method is static. Return Value:

Returns an array containing the existing list of attributes. The attributes are represented as key-value pairs.

setAttr

Sets attributes for a given name.

public static setAttr(string $name, array $attrs = [], bool $merge = true): void

• This method is static. Parameters:

setAttrs

Sets attributes for the object.

public static setAttrs(array $attrs = [], bool $merge = false): array

• This method is static. Parameters:

Return Value:

The updated attributes array after setting the new attributes.

resetAttrs

Reset attributes

public static resetAttrs(): void

• This method is static.

setMetaCharset

Set the meta charset value Specifies the character encoding for the HTML document.

public static setMetaCharset(string $charset = 'UTF-8'): void

Example:

Tag::setMetaCharset('UTF-8');
Tag::meta('charset', 'UTF-8');

Result:

<meta charset="UTF-8">

Common values: UTF-8 - Character encoding for Unicode ISO-8859-1 - Character encoding for the Latin alphabet In theory, any character encoding can be used, but no browser understands all of them. The more widely a character encoding is used, the better the chance that a browser will understand it.

To view all available character encodings, look at IANA character sets. - @link http://www.iana.org/assignments/character-sets/character-sets.xhtml

For more information about the charset values, please visit this documentation below - @link https://www.w3schools.com/tags/att_meta_charset.asp

• This method is static. Parameters:

setMetaProperty

Sets the value of a meta-property.

public static setMetaProperty(string $property, string|null $content = null): void

This method sets the specified meta-property with the given content. If there is already a meta-property with the same name, it will be removed before adding the new one.

• This method is static. Parameters:

setMetaName

Set the meta-name attribute with the given value.

public static setMetaName(string $name, string|null $content = null): void

• This method is static. Parameters:

addMeta

Add meta

public static addMeta(string $attr, string $value, string|null $content = null): void

• This method is static. Parameters:

addRawMeta

Add raw meta

public static addRawMeta(array $meta): void

• This method is static. Parameters:

addLink

Add a new link tag For more information about the attr, values, and other options please visite the w3schools documentation below - https://www.w3schools.com/tags/tag_link.asp

public static addLink(string $attr, string $value, array $options = []): void

Example:

Tag::addLink('rel', 'alternate', ['type' => 'application/atom+xml', 'title' => 'Phalcon Kit', 'href' => '/blog/news/atom"']);

Result:

<link rel="alternate" type="application/atom+xml" title="Phalcon Kit News" href="/blog/news/atom">

• This method is static. Parameters:

addRawLink

Adds a raw link to the existing list of links.

public static addRawLink(array $link): void

• This method is static. Parameters:

removeMeta

Removes meta-tags from the existing list of meta-tags based on the specified attribute, value, and content.

public static removeMeta(string $attr, string|null $value = null, string|null $content = null): void

• This method is static. Parameters:

getMeta

Retrieves the concatenated string representation of the meta-values.

public static getMeta(string|null $glue = null): string|null

• This method is static. Parameters:

Return Value:

The concatenated string representation of the meta-values, or null if there are no meta-values.

meta

Prints the meta-information using the specified glue.

public static meta(string|null $glue = null): void

• This method is static. Parameters:

getLink

Retrieves the links as a concatenated string with an optional glue separator.

public static getLink(string|null $glue = null): string|null

• This method is static. Parameters:

Return Value:

The concatenated string of links, or null if there are no links.

link

Generates and echoes the link string.

public static link(string|null $glue = null): void

• This method is static. Parameters:

getCss

Retrieves the CSS markup for the specified collection or all collections if no collection is specified.

public static getCss(string|null $collection = null): string|null

• This method is static. Parameters:

Return Value:

The CSS markup for the specified collection or all collections. Returns null if no CSS is found.

Throws:

• Exception

css

Prints the CSS markup for the specified collection or the default collection if no collection is provided.

public static css(string|null $collection = null): void

If a collection is provided, it should be a string representing the name of the CSS collection. If no collection is provided, the default collection will be used.

• This method is static. Parameters:

getJs

Retrieves JavaScript markup from the given asset collection or from all asset collections if none is specified.

public static getJs(string|null $collection = null): string|null

• This method is static. Parameters:

Return Value:

The generated JavaScript code, or null if no JavaScript code is found for the specified collection(s).

Throws:

• Exception

js

Outputs the JavaScript markup for a specific collection or for all collections if no collection is specified.

public static js(string|null $collection = null): void

• This method is static. Parameters:

Throws:

• Exception