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

_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.

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

string[]

addCrumb()source public

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

Добавляет ссылку в массив breadcrumbs.

Устарело

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".

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

string
Тег 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-аргументов.

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

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

Параметры

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

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

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

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

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

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

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

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

docType()source public

docType( string $type 'html5' )

Возвращает строку типа документа.

Возможные типы документов:

• 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'

Тип документа для использования.

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

string|null
Строка типа документа

Ссылка

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 )

Возвращает breadcrumbs в виде списка (x)html

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

Опции

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

Устарело

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

Параметры

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

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

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

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

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

string|null
HTML список breadcrumbs.

Ссылка

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 )

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

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

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

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

Устарело

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

Параметры

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

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

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

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

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

string|null
Составленные breadcrumbs

Ссылка

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

Параметры

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

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

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

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

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

string
Завершенный тег 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 [] )

Возвращает элемент audio/video

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

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

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 Текст для включения внутри тега audio/video
• 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 Нужно ли экранировать содержимое с помощью html_entity.

Параметры

строка $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 встраиваемо или добавляет его к указанному блоку представления в зависимости от настроек, используемых при запуске scriptBlock.

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

string|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

Нужно ли отображать блок стилей в одну строку.

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

string
Данные стилей 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.

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

string

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, поэтому счетчик нечетных/четных строк будет сброшен до нуля только для этого вызова.

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

string
Отформатированный 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.

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

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

Ссылка

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

tableRow()source public

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

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

Параметры

строка $content

Содержимое строки.

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

Атрибуты HTML.

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

string

tag()source public

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

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

Параметры

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

Параметры

строка $name

Имя тега.

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

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

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

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

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

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

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__debugInfo()source public

__debugInfo( )

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

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

array

__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

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

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

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

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

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

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

string
JS-код onclick

addClass()source public

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

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

Параметры

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

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

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

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

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

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

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

array
Массив параметров с установленным $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

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

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

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

Возвращает

смешанный
Значение конфигурации, которое считывается.

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

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