Класс HtmlHelper

__construct()source public

__construct( Cake\View\View $View , array $config = [] )

Конструктор

Настройки

• templates Имя файла конфигурации, содержащей шаблоны. Или массив шаблонов для загрузки. См. Cake\View\StringTemplate для форматирования шаблонов.

Настройка наборов тегов

Используя параметр templates, вы можете переопределить теги, которые будет использовать HtmlHelper.

Параметры

Cake\View\View $View

Представление, к которому подключается хелпер.

массив $config по желанию []

Настройки конфигурации хелпера.

Переопределяет

Cake\View\Helper::__construct()

_nestedListItem()source protected

_nestedListItem( array $items , array $options , array $itemOptions )

Внутренняя функция для создания многоуровневого списка (UL/OL) из ассоциативного массива.

Параметры

массив $items

Набор элементов для списка.

массив $options

Дополнительные HTML-атрибуты тега списка (ol/ul).

массив $itemOptions

Параметры и дополнительные HTML-атрибуты тега элемента списка (LI).

Возвращает

строка
Элемент многоуровневого списка

См. также

\Cake\View\Helper\HtmlHelper::nestedList()

_prepareCrumbs()source protected deprecated

_prepareCrumbs( string|array|boolean $startText , boolean $escape = true )

Добавляет startText к массиву хлебных крошек, если он задан

Устаревшее

3.3.6 Используйте BreadcrumbsHelper вместо этого

Параметры

строка/массив/логическое $startText

Текст для добавления в начало

логическое $escape по желанию true

Выполнять ли экранирование вывода

Возвращает

массив
Список хлебных крошек, включая startText (если указан)

_renderCells()source protected

_renderCells( array $line , boolean $useCount = false )

Отображает ячейки для строки таблицы.

Это вспомогательный метод для tableCells(). Переопределите этот метод по мере необходимости, чтобы изменить поведение отображения ячейки.

Параметры

массив $line

Данные строки для отображения.

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

Отображает счётчик в строке. По умолчанию false.

Возвращает

строковый массив

addCrumb()source public устаревший

addCrumb( string $name , string|array|null $link = null , array $options = [] )

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

Устаревший

3.3.6 Используйте BreadcrumbsHelper вместо этого

Параметры

строка $name

Текст для ссылки

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

URL для ссылки (если пусто, это не будет ссылка)

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

Атрибуты ссылки, например ['id' => 'selected']

Возвращает

$this

См. также

\Cake\View\Helper\HtmlHelper::link() для получения подробной информации об $options, которые могут быть использованы.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper

charset()source public

charset( string|null $charset = null )

Возвращает тег META charset.

Параметры

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

Набор символов, используемый в теге meta. Если пусто, используется значение App.encoding. Пример: "utf-8".

Возвращает

строка
Тег meta, содержащий указанный набор символов.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-charset-tags

css()source public

css( string|array $path , array $options = [] )

Создает элемент ссылки для таблиц стилей CSS.

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

Включение одного файла CSS:

echo $this->Html->css('styles.css');

Включение нескольких файлов CSS:

echo $this->Html->css(['one.css', 'two.css']);

Добавление таблицы стилей в блок представления "css":

$this->Html->css('styles.css', ['block' => true]);

Добавление таблицы стилей в пользовательский блок:

$this->Html->css('styles.css', ['block' => 'layoutCss']);

Параметры

• block Установите в значение true, чтобы добавить вывод в блок представления "css" или укажите имя пользовательского блока.
• once Необходимо ли проверять файл css на уникальность. Если true, файлы css будут включаться только один раз, используйте false, чтобы разрешить включение одного и того же css более одного раза за запрос.
• plugin Значение false предотвратит обработку пути как плагина
• rel По умолчанию 'stylesheet'. Если равно 'import', таблица стилей будет импортироваться.
• fullBase Если true, URL получит полный адрес для файла css.

Параметры

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

Имя файла таблицы стилей CSS или массив, содержащий имена файлов таблиц стилей CSS. Если $path начинается с '/', путь будет относительным к каталогу webroot вашей приложения. В противном случае путь будет относительным к вашему пути к CSS, обычно webroot/css.

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

Массив опций и аргументов HTML.

Возвращает

строка|null
Тег CSS <link /> или <style /> tag, в зависимости от типа ссылки.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-css-files

div()source public

div( string|null $class = null , string|null $text = null , array $options = [] )

Возвращает отформатированный тег DIV для HTML-форм.

Параметры

• escape Необходимо ли выполнять экранирование содержимого.

Параметры

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

Имя класса CSS элемента div.

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

Строковое содержимое, которое будет отображаться внутри элемента div. Если null, будет напечатан только стартовый тег

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

Дополнительные атрибуты HTML тега DIV

Возвращает

строка
Отформатированный элемент DIV

docType()source public

docType( string $type = 'html5' )

Возвращает строку doctype.

Возможные doctype:

• html4-strict: HTML4 Строгий.
• html4-trans: HTML4 Переходный.
• html4-frame: HTML4 Фреймсет.
• html5: HTML5. Значение по умолчанию.
• xhtml-strict: XHTML1 Строгий.
• xhtml-trans: XHTML1 Переходный.
• xhtml-frame: XHTML1 Фреймсет.
• xhtml11: XHTML1.1.

Параметры

строка $type необязательно 'html5'

Используемый doctype.

Возвращает

строка|null
Строка doctype

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-doctype-tags

getCrumbList()source public устаревший

getCrumbList( array $options = [] , string|array|boolean $startText = false )

Возвращает хлебные крошки в виде списка (x)html.

Этот метод использует HtmlHelper::tag() для генерации списка и его элементов. Работает аналогично HtmlHelper::getCrumbs(), поэтому использует опции, с которыми была добавлена каждая крошка.

Параметры

• separator Содержимое разделителя, которое нужно вставить между хлебными крошками, по умолчанию ''
• firstClass Класс для тега-обертки первой хлебной крошки, по умолчанию 'first'
• lastClass Класс для тега-обертки текущей активной страницы, по умолчанию 'last'

Устаревший

3.3.6 Используйте BreadcrumbsHelper вместо этого

Параметры

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

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

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

Это будет первой крошкой, если false, по умолчанию это первая крошка в массиве. Также может быть массивом, см. HtmlHelper::getCrumbs для подробностей.

Возвращает

строка|null
HTML-список хлебных крошек.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper

getCrumbs()source public устаревший

getCrumbs( string $separator = '»' , string|array|boolean $startText = false )

Возвращает след хлебных крошек как последовательность разделенных » ссылок.

Если $startText является массивом, допустимые ключи:

• text Определяет текст/содержимое ссылки.
• url Определяет целевой адрес созданной ссылки.

Все остальные ключи будут переданы в HtmlHelper::link() как параметр $options.

Устаревший

3.3.6 Используйте BreadcrumbsHelper вместо этого

Параметры

строка $separator необязательно '»'

Текст для разделения крошек.

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

Это будет первой крошкой, если false, по умолчанию это первая крошка в массиве. Также может быть массивом, см. выше для подробностей.

Возвращает

строка|null
Составленные хлебные крошки

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper

image()source public

image( string|array $path , array $options = [] )

Создаёт отформатированный элемент IMG.

Этот метод установит пустой атрибут alt, если он не был предоставлен.

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

Создать обычное изображение:

echo $this->Html->image('cake_icon.png', ['alt' => 'CakePHP']);

Создать ссылку на изображение:

echo $this->Html->image('cake_icon.png', ['alt' => 'CakePHP', 'url' => 'https://cakephp.org']);

Параметры:

• url Если предоставлен путь к изображению, будет сгенерирована ссылка, которая будет указывать на $options['url'].
• fullBase Если значение истинно, атрибут src получит полный адрес файла изображения.
• plugin Ложное значение предотвратит обработку пути как плагина.

Параметры

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

Путь к файлу изображения, относительно каталога app/webroot/img/.

массив $options дополнительно []

Массив HTML-атрибутов. См. выше для специальных параметров.

Возвращает

строка
полный тег img

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-images

implementedEvents()source public

implementedEvents( )

Обработчики событий.

Возвращает

массив

Переопределяет

Cake\View\Helper::implementedEvents()

link()source public

link( string|array $title , string|array|null $url = null , array $options = [] )

Создаёт HTML-ссылку.

Если $url начинается с "http://", это обрабатывается как внешняя ссылка. В противном случае, это обрабатывается как путь к контроллеру/действию и анализируется с помощью метода UrlHelper::build().

Если $url пустой, используется $title вместо него.

Параметры

• escape Установите в значение false, чтобы отключить экранирование заголовка и атрибутов.
• escapeTitle Установите в значение false, чтобы отключить экранирование заголовка. Имеет приоритет над значением escape)
• confirm Сообщение подтверждения JavaScript.

Параметры

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

Содержимое, которое будет заключено в теги <a>. Может быть массивом, если $url равен null. Если $url равен null, $title используется как URL и заголовок.

строка|массив|null $url дополнительно null

Cake-относительный URL или массив параметров URL, или внешний URL (начинается с http://)

массив $options дополнительно []

Массив параметров и HTML-атрибутов.

Возвращает

строка
Элемент <a />.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-links

media()source public

media( string|array $path , array $options = [] )

Возвращает элемент аудио/видео.

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

Использование аудиофайла:

echo $this->Html->media('audio.mp3', ['fullBase' => true]);

Выводит:

<video src="http://www.somehost.com/files/audio.mp3">Fallback text</video>

Использование видеофайла:

echo $this->Html->media('video.mp4', ['text' => 'Fallback text']);

Выводит:

<video src="/files/video.mp4">Fallback text</video>

Использование нескольких видеофайлов:

echo $this->Html->media(
     ['video.mp4', ['src' => 'video.ogv', 'type' => "video/ogg; codecs='theora, vorbis'"]],
     ['tag' => 'video', 'autoplay']
);

Выводит:

<video autoplay="autoplay">
     <source src="/files/video.mp4" type="video/mp4"/>
     <source src="/files/video.ogv" type="video/ogv; codecs='theora, vorbis'"/>
</video>

Параметры

• tag Тип элемента медиа для генерации, либо "аудио", либо "видео". Если тег не предоставлен, он определяется на основе MIME-типа файла.
• text Текст, который должен быть включён внутри тега аудио/видео.
• pathPrefix Префикс пути, используемый для относительных URL-адресов, по умолчанию 'files/'.
• fullBase Если предоставлено, атрибут src получит полный адрес, включая доменное имя.

Параметры

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

Путь к видеофайлу, относительно каталога webroot/{$options['pathPrefix']}. Или массив, где каждый элемент сам может быть строкой пути или ассоциативным массивом, содержащим ключи src и type

массив $options дополнительно []

Массив HTML-атрибутов и специальных параметров выше.

Возвращает

строка
Сгенерированный элемент медиа

meta()source public

meta( string|array $type , string|array|null $content = null , array $options = [] )

Создаёт ссылку на внешний ресурс и обрабатывает основные теги meta.

Создать тег meta, который выводится встроеным:

$this->Html->meta('icon', 'favicon.ico');

Добавить тег meta в пользовательский блок просмотра "meta":

$this->Html->meta('description', 'A great page', ['block' => true]);

Добавить тег meta в пользовательский блок просмотра:

$this->Html->meta('description', 'A great page', ['block' => 'metaTags']);

Создать пользовательский тег meta:

$this->Html->meta(['property' => 'og:site_name', 'content' => 'CakePHP']);

Параметры

• block - Установите в значение true, чтобы добавить вывод в блок просмотра "meta" или указать имя пользовательского блока.

Параметры

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

Заголовок внешнего ресурса или массив атрибутов для пользовательского тега meta.

строка|массив|null $content дополнительно null

Адрес внешнего ресурса или строка для атрибута content

массив $options дополнительно []

Другие атрибуты для сгенерированного тега. Если атрибут type имеет значения html, rss, atom или icon, возвращается MIME-тип.

Возвращает

строка|null
Полный элемент <link />, или null, если элемент был отправлен в блок.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-meta-tags

nestedList()source public

nestedList( array $list , array $options = [] , array $itemOptions = [] )

Создаёт список со вложенными элементами (UL/OL) из ассоциативного массива.

Параметры для $options:

• tag - Тип тега списка (ol/ul)

Параметры для $itemOptions:

• even - Класс для использования для чётных строк.
• odd - Класс для использования для нечётных строк.

Параметры

массив $list

Набор элементов для списка.

массив $options дополнительно []

Параметры и дополнительные HTML-атрибуты тега списка (ol/ul).

массив $itemOptions дополнительно []

Параметры и дополнительные HTML-атрибуты тега элемента списка (LI).

Возвращает

строка
Вложенный список

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-nested-lists

para()source public

para( string $class , string $text , array $options = [] )

Возвращает отформатированный тег P.

Параметры

• escape Нужно ли экранировать содержимое.

Параметры

строка $class

Имя класса CSS элемента p.

строка $text

Строковое содержимое, которое будет внутри элемента p.

массив $options дополнительно []

Дополнительные HTML-атрибуты тега P.

Возвращает

строка
Отформатированный элемент P

script()source public

script( string|array $url , array $options = [] )

Возвращает один или несколько тегов script в зависимости от количества переданных скриптов.

Если имя файла начинается с "/", путь будет относительным к корневому пути приложения. В противном случае, путь будет относительным к пути к JavaScript, обычно webroot/js.

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

Включить один файл скрипта:

echo $this->Html->script('styles.js');

Включить несколько файлов скриптов:

echo $this->Html->script(['one.js', 'two.js']);

Добавить файл скрипта в пользовательский блок:

$this->Html->script('styles.js', ['block' => 'bodyScript']);

Параметры

• block Установите в значение true, чтобы добавить вывод в блок просмотра "script" или указать имя пользовательского блока.
• once Необходимо ли проверять скрипт на уникальность. Если true, скрипты будут включены только один раз, установите в false, чтобы разрешить включение одного и того же скрипта более одного раза за запрос.
• plugin Ложное значение предотвратит обработку пути как плагина.
• fullBase Если значение истинно, URL получит полный адрес файла скрипта.

Параметры

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

Строка или массив файлов JavaScript для включения.

массив $options дополнительно []

Массив параметров и HTML-атрибутов, см. выше.

Возвращает

строка|null

Строка тегов <script /> или null, если блок указан в параметрах или если $once истинно и файл уже включен ранее.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-javascript-files

scriptBlock()source public

scriptBlock( string $script , array $options = [] )

Оборачивает $script в тег script.

Параметры

• safe (boolean) Определяет, нужно ли оборачивать $script в <![CDATA[ ]]>. По умолчанию false.
• block Устанавливается в true для добавления вывода в блок представления "script" или для указания пользовательского имени блока.

Параметры

строка $script

Скрипт для обертывания

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

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

Возвращает

строка|null
Строка или null в зависимости от значения $options['block'].

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-встроенных-блоков-javascript

scriptEnd()source public

scriptEnd( )

Завершает буферизованный фрагмент захвата JavaScript. Генерирует тег script встроеный или добавляет его в указанный блок представления в зависимости от настроек, используемых при запуске scriptBlock.

Возвращает

строка|null
В зависимости от настроек scriptStart(), либо тег script, либо null

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-встроенных-блоков-javascript

scriptStart()source public

scriptStart( array $options = [] )

Начинает блок скрипта, который захватывает вывод до вызова HtmlHelper::scriptEnd(). Этот блок захвата захватывает весь вывод между методами и создает из него scriptBlock.

Параметры

• safe (boolean) Определяет, нужно ли оборачивать $script в <![CDATA[ ]]>. См. scriptBlock().
• block Устанавливается в true для добавления вывода в блок представления "script" или для указания пользовательского имени блока.

Параметры

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

Параметры для блока кода.

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-встроенных-блоков-javascript

style()source public

style( array $data , boolean $oneLine = true )

Создает данные стилей CSS из массива свойств CSS.

Пример использования:

echo $this->Html->style(['margin' => '10px', 'padding' => '10px'], true);

// creates
'margin:10px;padding:10px;'

Параметры

массив $data

Массив данных стилей, ключи будут использованы как имена свойств, значения как значения свойств.

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

Указывает, должен ли блок стилей отображаться в одну строку.

Возвращает

строка
Данные стилей CSS

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-css-программно

tableCell()source public

tableCell( string $content , array $options = [] )

Отображает ячейку таблицы (тег TD с атрибутами).

Параметры

строка $content

Содержание ячейки.

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

Атрибуты HTML.

Возвращает

строка

tableCells()source public

tableCells( array|string $data , array|boolean|null $oddTrOptions = null , array|boolean|null $evenTrOptions = null , boolean $useCount = false , boolean $continueOddEven = true )

Возвращает отформатированную строку строк таблицы (TR с TD в них).

Параметры

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

Массив данных таблицы

массив|логическое|null $oddTrOptions необязательно null

Опции HTML для нечетных строк TR, если true, используется useCount.

массив|логическое|null $evenTrOptions необязательно null

Опции HTML для четных строк TR.

boolean $useCount необязательно false

Добавляет класс "column-$i".

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

Если false, будет использоваться динамическая переменная $count, так что счетчик четных/нечетных строк будет сброшен до нуля только для этого вызова.

Возвращает

строка
Отформатированный HTML

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-ячеек-таблицы

tableHeaders()source public

tableHeaders( array $names , array $trOptions = null , array $thOptions = null )

Возвращает строку отформатированных и именованных заголовков таблицы.

Параметры

массив $names

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

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

Опции HTML для тегов TR.

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

Опции HTML для тегов TH.

Возвращает

строка
Завершенные заголовки таблицы

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-заголовков-таблицы

tableRow()source public

tableRow( string $content , array $options = [] )

Отображает отдельную строку таблицы (тег TR с атрибутами).

Параметры

строка $content

Содержание строки.

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

Атрибуты HTML.

Возвращает

строка

tag()source public

tag( string $name , string|null $text = null , array $options = [] )

Возвращает отформатированный тег блока, например DIV, SPAN, P.

Параметры

• escape Определяет, нужно ли экранировать содержимое с помощью html_entity.

Параметры

строка $name

Имя тега.

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

Строковое содержимое, которое будет отображаться внутри элемента div. Если null, будет напечатан только стартовый тег.

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

Дополнительные атрибуты HTML тега DIV, см. выше.

Возвращает

строка
Отформатированный элемент тега

__call()source public

__call( string $method , array $params )

Предоставляет некритичные ошибки при вызовах отсутствующих методов.

Параметры

строка $method

Метод для вызова

массив $params

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Лениво загружает вспомогательные функции.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр вспомогательной функции, если вспомогательная функция с указанным именем существует

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

Код, который будет выполнен после выбора пользователем 'OK'

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

Код, который будет выполнен после выбора пользователем 'Отмена'

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

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

Возвращает

строка
JS-код onclick

addClass()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Добавляет заданный класс к параметрам элемента

Параметры

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

Массив параметров/атрибутов для добавления класса

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

Имя добавляемого класса.

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

Ключ для использования класса.

Возвращает

массив
Массив параметров со значением $key.

getView()source public

getView( )

Получение экземпляра представления, к которому привязан помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод обратного вызова конструктора.

Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский.

Параметры

массив $config

Настройки конфигурации, предоставленные этому помощнику.

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

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

Возвращает

строка

getTemplates()source public

getTemplates( string|null $template = null )

Получает шаблоны для использования или определенный шаблон.

Параметры

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

Строка для чтения определенного шаблона, null для всех.

Возвращает

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

setTemplates()source public

setTemplates( array $templates )

Устанавливает используемые шаблоны.

Параметры

массив $templates

Добавляемые шаблоны.

Возвращает

$this

templater()source public

templater( )

Возвращает экземпляр templater.

Возвращает

Cake\View\StringTemplate

templates()source public deprecated

templates( string|null|array $templates = null )

Получение/установка используемых шаблонов.

Устаревшее

3.4.0 Используйте setTemplates()/getTemplates() вместо этого.

Параметры

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

null или строка позволяют читать шаблоны. Массив позволяет добавлять шаблоны.

Возвращает

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

_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

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

Выбрасывает

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

config()source public deprecated

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

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию 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

Возвращаемое значение, когда ключ не существует.

Возвращает

смешанное
Считываемое значение конфигурации.

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

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

Возвращает

$this

Выбрасывает

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

[]

[
    'templates' => [
        'meta' => '<meta{{attrs}}/>',
        'metalink' => '<link href="{{url}}"{{attrs}}/>',
        'link' => '<a href="{{url}}"{{attrs}}>{{content}}</a>',
        'mailto' => '<a href="mailto:{{url}}"{{attrs}}>{{content}}</a>',
        'image' => '<img src="{{url}}"{{attrs}}/>',
        'tableheader' => '<th{{attrs}}>{{content}}</th>',
        'tableheaderrow' => '<tr{{attrs}}>{{content}}</tr>',
        'tablecell' => '<td{{attrs}}>{{content}}</td>',
        'tablerow' => '<tr{{attrs}}>{{content}}</tr>',
        'block' => '<div{{attrs}}>{{content}}</div>',
        'blockstart' => '<div{{attrs}}>',
        'blockend' => '</div>',
        'tag' => '<{{tag}}{{attrs}}>{{content}}</{{tag}}>',
        'tagstart' => '<{{tag}}{{attrs}}>',
        'tagend' => '</{{tag}}>',
        'tagselfclosing' => '<{{tag}}{{attrs}}/>',
        'para' => '<p{{attrs}}>{{content}}</p>',
        'parastart' => '<p{{attrs}}>',
        'css' => '<link rel="{{rel}}" href="{{url}}"{{attrs}}/>',
        'style' => '<style{{attrs}}>{{content}}</style>',
        'charset' => '<meta charset="{{charset}}"/>',
        'ul' => '<ul{{attrs}}>{{content}}</ul>',
        'ol' => '<ol{{attrs}}>{{content}}</ol>',
        'li' => '<li{{attrs}}>{{content}}</li>',
        'javascriptblock' => '<script{{attrs}}>{{content}}</script>',
        'javascriptstart' => '<script>',
        'javascriptlink' => '<script src="{{url}}"{{attrs}}></script>',
        'javascriptend' => '</script>'
    ]
]

[
    'html4-strict' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
    'html4-trans' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">',
    'html4-frame' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">',
    'html5' => '<!DOCTYPE html>',
    'xhtml-strict' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
    'xhtml-trans' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
    'xhtml-frame' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">',
    'xhtml11' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'
]

[]

[]

['Url']