Класс StringTemplate

Предоставляет интерфейс для регистрации и вставки содержимого в простые, не содержащие логики строковые шаблоны.

Используется несколькими вспомогательными функциями для предоставления простых гибких шаблонов для генерации HTML и другого контента.

Namespace: Cake\View

Краткое описание полей

$_compactAttributes protected

array

Список атрибутов, которые могут быть компактно представлены.
$_compiled protected

array

Содержит список скомпилированных шаблонов
$_config protected

array

Конфигурация времени выполнения
$_configInitialized protected

bool

Инициализировано ли свойство конфигурации значениями по умолчанию
$_configStack protected

array

Стек наборов шаблонов, временно сохраненных.
$_defaultConfig protected

array

Шаблоны по умолчанию, которые хранит этот экземпляр.

Краткое описание методов

__construct() public

Конструктор.
_compileTemplates() protected

Компилирует шаблоны в более эффективный формат, совместимый с printf().
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_formatAttribute() protected

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимизированными атрибутами, которые имеют то же значение, что и их имя, например, 'disabled' и 'checked'
add() public

Регистрирует список шаблонов по имени
addClass() public

Добавляет класс и возвращает уникальный список либо в виде массива, либо разделенного пробелами
configShallow() public

Слияние предоставленной конфигурации с существующей. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
format() public

Форматирует строку шаблона с помощью $data
formatAttributes() public

Возвращает строку, разделенную пробелами, с элементами массива $options. Если ключ массива $options является одним из перечисленных в StringTemplate::$_compactAttributes и его значение является одним из:
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
load() public

Загружает файл конфигурации, содержащий шаблоны.
pop() public

Восстанавливает самый недавно добавленный набор шаблонов.
push() public

Добавляет текущие шаблоны в стек шаблонов.
remove() public

Удаляет шаблон с указанным именем.
setConfig() public

Устанавливает конфигурацию.

Подробное описание методов

__construct() public

__construct(array $config = [])

Конструктор.

Параметры

array $config optional: Набор шаблонов для добавления.

_compileTemplates() protected

_compileTemplates(string[] $templates = []): void

Компиляция шаблонов в более эффективный формат, совместимый с printf().

Параметры

string[] $templates optional: Имена шаблонов для компиляции. Если пусто, будут скомпилированы все шаблоны.

Возвращает

void

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_formatAttribute() protected

_formatAttribute(string $key, string|string[] $value, bool $escape = true): string

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимизированными атрибутами, которые имеют то же значение, что и их имя, например, 'disabled' и 'checked'

Параметры

string $key: Имя атрибута для создания
string|string[] $value: Значение атрибута для создания.
bool $escape optional: Определяет, необходимо ли экранировать значение

Возвращает

string

add() public

add(string[] $templates): $this

Регистрирует список шаблонов по имени

Пример:

$templater->add([
  'link' => '<a href="{{url}}">{{title}}</a>'
  'button' => '<button>{{text}}</button>'
]);

Параметры

string[] $templates: Ассоциативный список именованных шаблонов.

Возвращает

$this

addClass() public

addClass(array|string $input, array|string $newClass, string $useIndex = 'class'): string|string[]

Добавляет класс и возвращает уникальный список либо в виде массива, либо через пробел

Параметры

array|string $input: Массив или строка, к которой нужно добавить класс
array|string $newClass: новый класс или классы для добавления
string $useIndex optional: если вы вводите массив с элементом, отличным от значения по умолчанию 'class'.

Возвращает

string|string[]

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Слияние предоставленной конфигурации с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

format() public

format(string $name, array $data): string

Форматирует строку шаблона с $data

Параметры

string $name: Имя шаблона.
array $data: Данные для вставки.

Возвращает

string

Исключения

RuntimeException
Если шаблон не найден.

formatAttributes() public

formatAttributes(array|null $options, array|null $exclude = null): string

Возвращает строку, разделенную пробелами, с элементами массива $options. Если ключ массива $options является одним из перечисленных в StringTemplate::$_compactAttributes и его значение является одним из:

'1' (строка)
1 (целое число)
true (булево)
'true' (строка)

Тогда значение будет установлено идентичным имени ключа. Если значение не является одним из этих 4, параметр не выводится.

'escape' - это специальный параметр, который управляет преобразованием атрибутов в их HTML-кодированные эквиваленты. Установите значение false, чтобы отключить HTML-кодирование.

Если значение для любого ключа параметра установлено в null или false, этот параметр будет исключен из вывода.

Этот метод использует шаблоны 'attribute' и 'compactAttribute'. Каждый из этих шаблонов использует переменные name и value. Вы можете изменить эти шаблоны, чтобы изменить способ форматирования атрибутов.

Параметры

array|null $options: Массив параметров.
array|null $exclude optional: Массив параметров для исключения, эти параметры не будут включены в результат.

Возвращает

string

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

load() public

load(string $file): void

Загружает файл конфигурации, содержащий шаблоны.

Файлы шаблонов должны определять переменную $config, содержащую все шаблоны для загрузки. Загруженные шаблоны будут объединены с существующими шаблонами.

Параметры

string $file: Файл для загрузки

Возвращает

void

pop() public

pop(): void

Восстанавливает последний набор шаблонов, который был добавлен в стек.

Возвращает

void

push() public

push(): void

Добавляет текущие шаблоны в стек шаблонов.

Возвращает

void

remove() public

remove(string $name): void

Удаляет именованный шаблон.

Параметры

string $name: Шаблон для удаления.

Возвращает

void

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Необходимо ли рекурсивно объединять или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

Подробное описание свойства

`$_compactAttributes` protected

Список атрибутов, которые могут быть сделаны компактными.

Тип

array

`$_compiled` protected

Содержит список скомпилированных шаблонов

Тип

array

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Было ли свойство конфигурации уже настроено с параметрами по умолчанию

Тип

bool

`$_configStack` protected

Стек наборов шаблонов, которые были временно сохранены.

Тип

array

`$_defaultConfig` protected

Шаблоны по умолчанию, которые хранит этот экземпляр.

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.View.StringTemplate.html