Класс StringTemplate

__construct()source public

__construct( array $config = [] )

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

Параметры

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

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

_compileTemplates()source protected

_compileTemplates( array $templates = [] )

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

Параметры

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

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

_formatAttribute()source protected

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

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

Параметры

строка $key

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

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

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

булево $escape необязательно true

Определяет, должно ли значение быть обработано

Возвращает

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

add()source public

add( array $templates )

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

Пример:

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

Параметры

массив $templates

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

Возвращает

$this

addClass()source public

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

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

Параметры

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

Массив или строка, к которой добавляется класс

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

Новый класс или классы для добавления

строка $useIndex необязательно 'class'

если вы вводите массив с элементом, отличным от стандартного 'class'.

Возвращает

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

format()source public

format( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

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

Возвращает

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

formatAttributes()source public

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

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

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

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

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

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

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

Параметры

массив|null $options

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

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

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

Возвращает

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

load()source public

load( string $file )

Загрузка файла конфигурации с шаблонами.

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

Параметры

строка $file

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

pop()source public

pop( )

Восстановление последнего помещённого набора шаблонов.

push()source public

push( )

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

remove()source public

remove( string $name )

Удаляет шаблон по имени.

Параметры

строка $name

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

смешанное значение

_configWrite()source protected

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

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

Параметры

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

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

смешанное значение $value

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

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

Истинное значение для рекурсивного слияния, 'поверхностное' для простого слияния, ложное значение для перезаписи; по умолчанию ложное.

Исключения

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

config()source 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']);

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

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

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

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

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

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

Возвращает

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

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()source public

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

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

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

смешанное значение $default необязательно null

Значение по умолчанию, если ключ не существует.

Возвращает

смешанное значение
Данные конфигурации по указанному ключу или null, если ключ не существует.

setConfig()source public

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

$this

Исключения

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,
]

[]

[]

[]