Класс 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).

Возвращает

string
Элемент вложенного списка

См.

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

_prepareCrumbs()source protected deprecated

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

Добавляет startText в массив crumbs, если он задан

Устарело

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 будут включены только один раз; use false, чтобы разрешить включение одного и того же CSS более одного раза за запрос.
• plugin Значение false предотвратит разбор пути как плагина
• rel По умолчанию равно 'stylesheet'. Если равно 'import', stylesheet будет импортирован.
• fullBase Если true, URL получит полный адрес для файла CSS.

Параметры

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

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

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

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

Возвращает

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

Ссылка

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 Strict.
• html4-trans: HTML4 Transitional.
• html4-frame: HTML4 Frameset.
• html5: HTML5. Значение по умолчанию.
• xhtml-strict: XHTML1 Strict.
• xhtml-trans: XHTML1 Transitional.
• xhtml-frame: XHTML1 Frameset.
• 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() в качестве параметра %%%CODE_BLOCK_80%%.

Устаревший

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 Если предоставлен, будет создана ссылка на картинку, и ссылка будет указывать на %%%CODE_BLOCK_87%%.
• fullBase Если true, атрибут src получит полный адрес файла изображения.
• plugin Значение false предотвратит разбор пути как плагина

Параметры

строка|массив $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 Тип элемента медиа для генерации, либо "audio", либо "video". Если тег не задан, он угадывается на основе 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 = [] )

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

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

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

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

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

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

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

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

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

Параметры

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

Параметры

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

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

строка|массив|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 Нужно ли экранировать содержимое с помощью html_entity_decode.

Параметры

строка $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 Значение false предотвратит обработку пути как плагина.
• fullBase Если true, URL получит полный адрес для файла скрипта.

Параметры

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

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

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

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

Возвращает

строка|null

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

Ссылка

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#creating-inline-javascript-blocks

scriptEnd()source public

scriptEnd( )

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

Возвращает

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

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-inline-javascript-blocks

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#creating-inline-javascript-blocks

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#creating-css-programatically

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

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

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

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

массив или boolean или 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#creating-table-cells

tableHeaders()source public

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

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

Параметры

массив $names

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

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

Опции HTML для элементов TR.

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

Опции HTML для элементов TH.

Возвращает

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

Ссылка

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

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
Экземпляр помощника, если помощник с указанным именем существует

__set()source public

__set( string $name , mixed $value )

Магический установщик для удалённых свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанное

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
Код onclick JS

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

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

boolean|строка $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

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

boolean $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

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

Возвращает

смешанный
Данные конфигурации по указанному ключу или 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

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

boolean $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>',
        'confirmJs' => '{{confirm}}'
    ]
]

[
    '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']