Класс HtmlHelper

__construct()source public

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

Конструктор

Настройки

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

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

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

Параметры

Cake\View\View $View

Представление, к которому прикреплён помощник.

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

Параметры настроек для помощника.

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

Cake\View\Helper::__construct()

_nestedListItem()source protected

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

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

Параметры

массив $items

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

массив $options

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

массив $itemOptions

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

Возвращает

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

См. также

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

_prepareCrumbs()source protected deprecated

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

Добавляет startText в массив 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 будут включаться только один раз, используйте 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 Необходимо ли экранировать содержимое как html-сущности.

Параметры

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

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

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

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

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

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

Возвращает

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

docType()source public

docType( string $type = 'html5' )

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

Возможные doctype:

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

Параметры

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

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

Возвращает

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

Ссылка

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

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

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

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

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

Параметры

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

Устаревший

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

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

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

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

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

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

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

Устаревший

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

image()source public

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

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

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

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

Создание обычного изображения:

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

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

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

Параметры:

• url Если указан, будет сгенерирована ссылка на изображение, которая будет указывать на $options['url'].
• fullBase Если 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 = [] )

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

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

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

Параметры

строка $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, скрипты включаются только один раз; use 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#создание-блоков-встраиваемого-javascript

scriptEnd()source public

scriptEnd( )

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

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

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

Ссылка

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

scriptStart()source public

scriptStart( array $options = [] )

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

Параметры

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

Параметры

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

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

Ссылка

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

style()source public

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

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

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

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

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

Параметры

массив $data

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

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

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

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

строка
Данные CSS-стилирования

Ссылка

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

tableCell()source public

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

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

Параметры

строка $content

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

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

HTML-атрибуты.

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

строка

tableCells()source public

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

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

Параметры

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

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

массив|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#создание-ячеек-таблицы

tableHeaders()source public

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

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

Параметры

массив $names

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

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

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

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

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

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

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

Ссылка

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

tableRow()source public

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

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

Параметры

строка $content

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

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

HTML-атрибуты.

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

строка

tag()source public

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

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

Параметры

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

Параметры

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

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

Параметры

строка $name

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

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

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

Параметры

строка $message

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

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

смешанное

_confirm()source protected

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

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

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

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

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

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

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

Массив опций

Возвращает

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

addClass()source public

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

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

Параметры

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

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

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

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

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

ключ, используемый для класса.

Возвращает

массив
Массив опций с установленным $key.

getView()source public

getView( )

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

Возвращает

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

initialize()source public

initialize( array $config )

Метод-обработчик конструктора.

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

Параметры

массив $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

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

Возвращает

строку

getTemplates()source public

getTemplates( string|null $template = null )

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

Параметры

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

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

Возвращает

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

setTemplates()source public

setTemplates( array $templates )

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

Параметры

массив $templates

Шаблоны, которые необходимо добавить.

Возвращает

$this

templater()source public

templater( )

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

Возвращает

Cake\View\StringTemplate

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

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

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

Выбрасывает

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

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

Возвращает

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

Выбрасывает

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

Параметры

string|array $key

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

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