Класс HtmlHelper
Класс Html Helper для удобного использования HTML-виджетов.
HtmlHelper содержит все необходимые методы для работы с HTML-страницами.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\HtmlHelper uses Cake\View\StringTemplateTrait
Ссылка: http://book.cakephp.org/3.0/ru/views/helpers/html.html
Расположение: View/Helper/HtmlHelper.php
Краткое описание свойств
-
$_crumbsprotectedХлебные крошки.array -
$_defaultConfigprotectedНастройка по умолчанию для этого классаarray -
$_docTypesprotectedОпределения типов документовarray -
$_includedAssetsprotectedИмена файлов скриптов и CSS, которые были включены один разarray -
$_scriptBlockOptionsprotectedПараметры для буфера текущего открытого блока скрипта, если таковой имеется.array -
$helperspublicСписок используемых помощниковarray - Ссылка на объект Response
$responsepublic
Краткое описание магических свойств
-
$Urlpublic
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- _nestedListItem() protectedВнутренняя функция для создания вложенного списка (UL/OL) из ассоциативного массива.
- _prepareCrumbs() protectedДобавляет startText в массив crumbs, если он задан
- _renderCells() protectedОтображает ячейки для строки таблицы.
- addCrumb() publicДобавляет ссылку в массив хлебных крошек.
- charset() publicВозвращает тег META charset.
- css() publicСоздаёт элемент ссылки для CSS-стилей.
- div() publicВозвращает отформатированный тег DIV для HTML-форм.
- docType() publicВозвращает строку типа документа.
- getCrumbList() publicВозвращает хлебные крошки в виде списка (x)html
- getCrumbs() publicВозвращает след хлебных крошек в виде последовательности ссылок, разделённых »
- image() publicСоздаёт отформатированный элемент IMG.
- implementedEvents() publicОбработчики событий.
- link() publicСоздаёт HTML-ссылку.
- media() publicВозвращает элемент audio/video
- meta() publicСоздаёт ссылку на внешний ресурс и обрабатывает основные теги meta
- nestedList() publicСоздаёт вложенный список (UL/OL) из ассоциативного массива.
- para() publicВозвращает отформатированный тег P.
- script() publicВозвращает один или несколько тегов
<script>в зависимости от количества переданных скриптов. - scriptBlock() publicОборачивает $script в тег script.
- scriptEnd() public
Закрывает буферизованный участок захвата JavaScript. Генерирует тег script inline или добавляет его в указанный блок представления в зависимости от настроек, использованных при запуске scriptBlock.
- scriptStart() public
Начинает блок скрипта, который захватывает вывод до вызова HtmlHelper::scriptEnd(). Этот блок захвата захватывает весь вывод между методами и создаёт из него scriptBlock.
- style() publicСоздаёт данные CSS-стилей из массива свойств CSS.
- tableCell() publicОтображает отдельную ячейку таблицы (тег TD с атрибутами).
- tableCells() publicВозвращает отформатированную строку строк таблицы (TR с TD в них).
- tableHeaders() publicВозвращает строку отформатированных и именованных заголовков таблицы.
- tableRow() publicОтображает одну строку таблицы (тег TR с атрибутами).
- tag() publicВозвращает отформатированный блок-тег, например DIV, SPAN, P.
Подробное описание методов
__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, если он задан
Параметры
- строка|массив|булево
$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 [] )
Добавляет ссылку в массив хлебных крошек.
Параметры
- строка
$name - Текст для ссылки
- строка|массив|null
$linkнеобязательно null - URL для ссылки (если пусто, это не будет ссылка)
- массив
$optionsнеобязательно [] - Атрибуты ссылки, например ['id' => 'selected']
Возвращаемое значение
$this
См. также
\Cake\View\Helper\HtmlHelper::link() для получения подробной информации об $options, которые можно использовать.Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelpercharset()source public
charset( string|null $charset null )
Возвращает тег META charset.
Параметры
- строка|null
$charsetнеобязательно null Набор символов для использования в теге meta. Если пусто, будет использоваться значение App.encoding. Пример: "utf-8".
Возвращаемое значение
строкаТег meta, содержащий указанный набор символов.
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-charset-tagscss()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, в зависимости от типа ссылки.Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-css-filesdiv()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
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-doctype-tagsgetCrumbList()source public
getCrumbList( array $options [] , string|array|boolean $startText false )
Возвращает хлебные крошки как список (x)html.
Этот метод использует HtmlHelper::tag() для генерации списка и его элементов. Работает аналогично HtmlHelper::getCrumbs(), поэтому использует опции, с которыми была добавлена каждая крошка.
Опции
-
separatorСодержимое разделителя, которое необходимо вставить между хлебными крошками, по умолчанию '' -
firstClassКласс для тега-обёртки первой хлебной крошки, по умолчанию 'first' -
lastClassКласс для тега-обёртки текущей активной страницы, по умолчанию 'last'
Параметры
- массив
$optionsнеобязательно [] - Массив HTML-атрибутов для применения к генерируемым элементам списка.
- строка|массив|логическое
$startTextнеобязательно false Это будет первой крошкой, если false, по умолчанию первая крошка в массиве. Также может быть массивом, см.
HtmlHelper::getCrumbsдля деталей.
Возвращаемое значение
строка|nullHTML список хлебных крошек.
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelpergetCrumbs()source public
getCrumbs( string $separator '»' , string|array|boolean $startText false )
Возвращает след хлебных крошек в виде последовательности с разделителями «».
Если $startText является массивом, допустимые ключи:
-
textОпределяет текст/содержимое для ссылки. -
urlОпределяет целевой адрес созданной ссылки.
Все остальные ключи будут переданы HtmlHelper::link() в качестве параметра $options.
Параметры
- строка
$separatorнеобязательно '»' - Текст для разделения крошек.
- строка|массив|логическое
$startTextнеобязательно false Это будет первой крошкой, если false, по умолчанию первая крошка в массиве. Также может быть массивом, см. выше для деталей.
Возвращаемое значение
строка|nullСоставленные хлебные крошки
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-breadcrumb-trails-with-htmlhelperimage()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' => 'http://cakephp.org']); Опции:
-
urlЕсли предоставлен, будет сгенерирована ссылка на изображение, и ссылка будет указывать на$options['url']. -
fullBaseЕсли true, атрибут src получит полный адрес для файла изображения. -
pluginЗначение False предотвратит обработку пути как плагина
Параметры
- строка
$path - Путь к файлу изображения, относительно каталога app/webroot/img/.
- массив
$optionsнеобязательно [] - Массив HTML атрибутов. См. выше для специальных опций.
Возвращаемое значение
строкаЗавершенный тег img
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-imagesimplementedEvents()source public
implementedEvents( )
Обработчики событий.
Возвращает
массивПереопределяет
Cake\View\Helper::implementedEvents() link()source public
link( string $title , string|array|null $url null , array $options [] )
Создаёт HTML ссылку.
Если $url начинается с "http://", это обрабатывается как внешняя ссылка. В противном случае, это обрабатывается как путь к контроллеру/действию и анализируется с помощью метода UrlHelper::build().
Если $url пустой, используется $title вместо него.
Параметры
-
escapeУстановите в false, чтобы отключить экранирование заголовка и атрибутов. -
escapeTitleУстановите в false, чтобы отключить экранирование заголовка. Имеет приоритет над значениемescape) -
confirmСообщение подтверждения JavaScript.
Параметры
- строка
$title - Содержимое, которое будет заключено в теги
<a>. - строка|массив|null
$urlнеобязательно null Cake-относительный URL или массив параметров URL, или внешняя URL (начинается с http://)
- массив
$optionsнеобязательно [] - Массив параметров и HTML атрибутов.
Возвращает
строкаЭлемент
<a />Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-linksmedia()source public
media( string|array $path , array $options [] )
Возвращает элемент аудио/видео.
Использование
Использование аудио файла:
echo $this->Html->media('audio.mp3', ['fullBase' => true]); Выходные данные:
<video src="http://www.somehost.com/files/audio.mp3">Fallback text</video>
Использование видео файла:
echo $this->Html->media('video.mp4', ['text' => 'Fallback text']); Выходные данные:
<video src="/files/video.mp4">Fallback text</video>
Использование нескольких видео файлов:
echo $this->Html->media(
['video.mp4', ['src' => 'video.ogv', 'type' => "video/ogg; codecs='theora, vorbis'"]],
['tag' => 'video', 'autoplay']
); Выходные данные:
<video autoplay="autoplay">
<source src="/files/video.mp4" type="video/mp4"/>
<source src="/files/video.ogv" type="video/ogv; codecs='theora, vorbis'"/>
</video> Параметры
-
tagТип элемента медиа для генерации, либо "аудио", либо "видео". Если тег не предоставлен, он угадывается на основе MIME типа файла. -
textТекст, который нужно включить внутри тега аудио/видео. -
pathPrefixПрефикс пути, который нужно использовать для относительных URL, по умолчанию 'files/' -
fullBaseЕсли предоставлено, атрибут src получит полный адрес, включая доменное имя.
Параметры
- строка|массив
$path Путь к видеофайлу, относительно директории webroot/{$options['pathPrefix']}. Или массив, где каждый элемент сам по себе может быть строкой пути или ассоциативным массивом, содержащим ключи
srcиtype- массив
$optionsнеобязательно [] - Массив HTML атрибутов и специальных параметров, указанных выше.
Возвращает
строкаСгенерированный элемент медиа
meta()source public
meta( string|array $type , string|array|null $content null , array $options [] )
Создаёт ссылку на внешний ресурс и обрабатывает базовые мета-теги.
Создать мета-тег, который выводится в строке:
`$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 - Адрес внешнего ресурса или строка для атрибута содержимого
- массив
$optionsнеобязательно [] Другие атрибуты для сгенерированного тега. Если атрибут type — html, rss, atom или icon, возвращается MIME-тип.
Возвращает
строкаПолный элемент
<link />Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-meta-tagsnestedList()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).
Возвращает
строкаВложенный список
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-nested-listspara()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, скрипты будут включены только один раз, use false, чтобы разрешить включение одного и того же скрипта более чем один раз за запрос. -
pluginЗначение false предотвратит обработку пути как плагина. -
fullBaseЕсли true, URL получит полный адрес файла скрипта.
Параметры
- строка|массив
$url - Строка или массив файлов JavaScript для включения.
- массив
$optionsнеобязательно [] - Массив опций и HTML атрибутов, см. выше.
Возвращает
строка|nullСтрока тегов <script /> или null, если блок указан в параметрах или если $once — true, и файл уже был включён ранее.
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#linking-to-javascript-filesscriptBlock()source public
scriptBlock( string $script , array $options [] )
Оборачивает $script в тег script.
Параметры
-
safe(boolean) Нужно ли оборачивать $script в<![CDATA[ ]]> -
blockУстановите в true, чтобы добавить вывод в блок представления "script" или указать имя пользовательского блока.
Параметры
- строка
$script - Скрипт для обёртывания
- массив
$optionsнеобязательно [] Используемые параметры. Параметры, не указанные выше, будут обработаны как HTML атрибуты.
Возвращает
строка|nullСтрока или null в зависимости от значения
$options['block']Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-inline-javascript-blocksscriptEnd()source public
scriptEnd( )
Завершает буферизованный раздел захвата JavaScript. Генерирует тег script в строке или добавляет в указанный блок представления в зависимости от настроек, использованных при запуске scriptBlock.
Возвращает
строка|nullВ зависимости от настроек scriptStart() — либо тег script, либо null
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-javascript-blocksscriptStart()source public
scriptStart( array $options [] )
Начать блок скрипта, который захватывает вывод, пока не будет вызван HtmlHelper::scriptEnd(). Этот блок захватит весь вывод между методами и создаст из него scriptBlock.
Параметры
-
safeНужно ли, чтобы блок кода содержал CDATA -
blockУстановите в true, чтобы добавить вывод в блок представления "script", или укажите имя пользовательского блока.
Параметры
- массив
$optionsнеобязательно [] - Параметры для блока кода.
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-блоков-javascriptstyle()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 - Массив данных стиля, ключи будут использованы в качестве имен свойств, значения в качестве значений свойств.
- логическое значение
$oneLineнеобязательно true - Показывать ли блок стиля в одну строку.
Возвращает
строкаДанные стилизации CSS
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-css-программноtableCell()source public
tableCell( string $content , array $options [] )
Отображает одну ячейку таблицы (TD с атрибутами).
Параметры
- строка
$content - Содержимое ячейки.
- массив
$optionsнеобязательно [] - Атрибуты HTML.
Возвращает
строкаtableCells()source public
tableCells( array|string $data , array|boolean|null $oddTrOptions null , array|boolean|null $evenTrOptions null , boolean $useCount false , boolean $continueOddEven true )
Возвращает отформатированную строку строк таблицы (TR с TD внутри).
Параметры
- массив|строка
$data - Массив данных таблицы
- массив|логическое значение|null
$oddTrOptionsнеобязательно null - Атрибуты HTML для нечетных элементов TR, если true используется useCount
- массив|логическое значение|null
$evenTrOptionsнеобязательно null - Атрибуты HTML для четных элементов TR
- логическое значение
$useCountнеобязательно false - Добавляет класс "column-$i"
- логическое значение
$continueOddEvenнеобязательно true Если false, будет использоваться нестатическая переменная $count, поэтому счетчик нечетных/четных строк будет сброшен до нуля только для этого вызова.
Возвращает
строкаОтформатированный HTML
Ссылка
http://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.
Возвращает
строкаЗавершенные заголовки таблицы
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/html.html#создание-заголовков-таблицыtableRow()source public
tableRow( string $content , array $options [] )
Отображает одну строку таблицы (TR с атрибутами).
Параметры
- строка
$content - Содержимое строки.
- массив
$optionsнеобязательно [] - Атрибуты HTML.
Возвращает
строкаtag()source public
tag( string $name , string|null $text null , array $options [] )
Возвращает отформатированный тег блока, т.е. DIV, SPAN, P.
Параметры
-
escapeНужно ли кодировать содержимое как сущности HTML.
Параметры
- строка
$name - Имя тега.
- строка|null
$textнеобязательно null Строковое содержимое, которое будет отображаться внутри элемента div. Если null, будет напечатан только стартовый тег.
- массив
$optionsнеобязательно [] - Дополнительные атрибуты HTML тега DIV, см. выше.
Возвращает
строкаОтформатированный элемент тега
Методы, унаследованные от Cake\View\Helper
__call()source public
__call( string $method , array $params )
Предоставляет ошибки без критических последствий при вызове отсутствующего метода.
Параметры
- строка
$method - Метод для вызова
- массив
$params - Массив параметров для метода.
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массив__get()source public
__get( string $name )
Лениво загружает помощники.
Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
Cake\View\Helper|nullЭкземпляр помощника, если помощник с указанным именем существует
_confirm()source protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- строка
$message - Сообщение для отображения
- строка
$okCode - Код, который будет выполнен после выбора пользователем 'OK'
- строка
$cancelCodeнеобязательно '' - Код, который будет выполнен после выбора пользователем 'Отмена'
- массив
$optionsнеобязательно [] - Массив параметров
Возвращает
строкаJS код onclick
addClass()source public
addClass( array $options [] , string|null $class null , string $key 'class' )
Добавляет заданный класс к параметрам элемента
Параметры
- массив
$optionsнеобязательно [] - Массив параметров/атрибутов, к которому нужно добавить класс
- строка|null
$classнеобязательно null - Имя добавляемого класса.
- строка
$keyнеобязательно 'class' - Ключ, используемый для класса.
Возвращает
массивМассив параметров с установленным $key.
initialize()source public
initialize( array $config )
Метод хука конструктора.
Реализуйте этот метод, чтобы не нужно было переписывать конструктор и вызывать родительский.
Параметры
- массив
$config - Настройки конфигурации, предоставленные этому помощнику.
Методы, используемые из Cake\Core\InstanceConfigTrait
_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 Истинно для рекурсивного слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.
Выбрасывает
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']);
Параметры
- строка|массив|null
$keyнеобязательный null - Ключ для получения/установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательный null - Значение для установки.
- логическое
$mergeнеобязательный true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
смешанныйЗначение конфигурации, которое читается, или сам объект при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединить предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательный null - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_defaultConfigsource
protected массив
Настройки по умолчанию для этого класса
[
'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>'
]
] $_docTypessource
protected массив
Определения типов документов
[
'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">'
] $_includedAssetssource
protected массив
Имена файлов скриптов и CSS, которые были включены один раз
[]
$_scriptBlockOptionssource
protected массив
Параметры для текущего открытого буфера блока скрипта, если таковой имеется.
[]
Подробное описание магических свойств
$Urlsource
public Cake\View\Helper\UrlHelper
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.View.Helper.HtmlHelper.html