Класс 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 в массив 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 кодировки символов.

Параметры

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

Параметры

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

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

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

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

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

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

Возвращает

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

docType()source public

docType( string $type 'html5' )

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

Возможные doctypes:

• 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 $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. См. выше для специальных опций.

Возвращает

строка
Завершенный тег img

Ссылка

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

array

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

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.

Параметры

string|array $title

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

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

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

array $options необязательно []

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

Возвращает

string
Элемент <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 получит полный адрес, включая доменное имя

Параметры

string|array $path

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

array $options необязательно []

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

Возвращает

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

meta()source public

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

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

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

$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", или укажите имя кастомного блока.

Параметры

string|array $type

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

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

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

array $options необязательно []

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

Возвращает

string|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 - Класс для использования для нечётных строк.

Параметры

array $list

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

array $options необязательно []

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

array $itemOptions необязательно []

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

Возвращает

string
Вложенный список

Ссылка

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 сущностями.

Параметры

string $class

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

string $text

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

array $options необязательно []

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

Возвращает

string
Отформатированный элемент 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 получит полный адрес для файла скрипта.

Параметры

string|array $url

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

array $options необязательно []

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

Возвращает

string|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", или укажите имя кастомного блока.

Параметры

string $script

Скрипт для обёртки

array $options необязательно []

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

Возвращает

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

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

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

string
Данные 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.

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

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#creating-table-cells

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#creating-table-headings

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

Параметры

строка $name

Имя тега.

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

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

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

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

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

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

__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 необязательно []

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

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

string
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

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

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