Класс StringTemplate

__constructsource public

__construct( array $config [] )

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

Параметры

массив $config необязательно []

Набор шаблонов для добавления.

_compileTemplatessource protected

_compileTemplates( array $templates [] )

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

Параметры

массив $templates необязательно []

Имена шаблонов для компиляции. Если пусто, все шаблоны будут скомпилированы.

_formatAttributesource protected

_formatAttribute( string $key , string|array $value , boolean $escape true )

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

Параметры

строка $key

Имя атрибута для создания

строка|массив $value

Значение атрибута для создания.

логическое значение $escape необязательно true

Определяет, нужно ли экранировать значение

Возвращает

string
Составленный атрибут.

addsource public

add( array $templates )

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

Пример:

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

Параметры

массив $templates

Ассоциативный список именованных шаблонов.

Возвращает

mixed
$this

formatsource public

format( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

Данные для вставки.

Возвращает

string|null
Отформатированная строка или null, если шаблон не найден.

formatAttributessource public

formatAttributes( array|null $options , array|null $exclude null )

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

• '1' (строка)
• 1 (целое число)
• true (логическое)
• 'true' (строка)

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

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

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

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

Параметры

массив|null $options

Массив параметров.

массив|null $exclude необязательно null

Массив параметров, которые нужно исключить, эти параметры не будут частью возвращаемого значения.

Возвращает

string
Составленные атрибуты.

loadsource public

load( string $file )

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

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

Параметры

строка $file

Файл для загрузки

popsource public

pop( )

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

pushsource public

push( )

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

removesource public

remove( string $name )

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

Параметры

строка $name

Шаблон для удаления.

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации.

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации.

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

логическое значение|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

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

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

$this->config();

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

$this->config('key');

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

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

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

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

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

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

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

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

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или весь массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

логическое значение $merge необязательно true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Исключения

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

configShallowsource public

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

Объединить предоставленные настройки с существующими. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

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

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

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

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

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

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

Параметры

string|array $key

Ключ для установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

Возвращаемое значение

mixed
Сам объект.

getsource public

get( string|array|null $key null , mixed|null $value null , boolean $merge true )

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

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

$this->config();

Чтение определенного значения:

$this->config('key');

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

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

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

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

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

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

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

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

Параметры

string|array|null $key необязательно null

Ключ для получения/установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию — true.

Возвращаемое значение

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Исключения

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

[
    'allowfullscreen' => true,
    'async' => true,
    'autofocus' => true,
    'autoplay' => true,
    'checked' => true,
    'compact' => true,
    'controls' => true,
    'declare' => true,
    'default' => true,
    'defaultchecked' => true,
    'defaultmuted' => true,
    'defaultselected' => true,
    'defer' => true,
    'disabled' => true,
    'enabled' => true,
    'formnovalidate' => true,
    'hidden' => true,
    'indeterminate' => true,
    'inert' => true,
    'ismap' => true,
    'itemscope' => true,
    'loop' => true,
    'multiple' => true,
    'muted' => true,
    'nohref' => true,
    'noresize' => true,
    'noshade' => true,
    'novalidate' => true,
    'nowrap' => true,
    'open' => true,
    'pauseonexit' => true,
    'readonly' => true,
    'required' => true,
    'reversed' => true,
    'scoped' => true,
    'seamless' => true,
    'selected' => true,
    'sortable' => true,
    'truespeed' => true,
    'typemustmatch' => true,
    'visible' => true,
]

[]

[]

[
]

[]

false