Spec-Zone.ru › CakePHP 3.2

Класс HtmlHelper

Класс Html Helper для удобного использования HTML-виджетов.

HtmlHelper содержит все необходимые методы для работы с HTML-страницами.

Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\View\Helper\HtmlHelper uses Cake\View\StringTemplateTrait
Пространство имён: Cake\View\Helper
Ссылка: http://book.cakephp.org/3.0/ru/views/helpers/html.html
Расположение: View/Helper/HtmlHelper.php

Краткое описание свойств

  • $_crumbs protected
    array
    Хлебные крошки.
  • $_defaultConfig protected
    array
    Настройка по умолчанию для этого класса
  • $_docTypes protected
    array
    Определения типов документов
  • $_includedAssets protected
    array
    Имена файлов скриптов и CSS, которые были включены один раз
  • $_scriptBlockOptions protected
    array
    Параметры для буфера текущего открытого блока скрипта, если таковой имеется.
  • $helpers public
    array
    Список используемых помощников
  • $response public
    Cake\Network\Response
    Ссылка на объект Response

Краткое описание магических свойств

  • $Url public
    Cake\View\Helper\UrlHelper

Унаследованные свойства

  • _View, _helperMap, fieldset, plugin, request, tags, theme _config, _configInitialized

Краткое описание методов

  • __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 (если он задан)
END_OF_DOCUMENT_MARKER

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

charset()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-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, в зависимости от типа ссылки.

Ссылка

http://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

Ссылка

http://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'

Параметры

массив $options необязательно []
Массив HTML-атрибутов для применения к генерируемым элементам списка.
строка|массив|логическое $startText необязательно false

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

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

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

Ссылка

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

getCrumbs()source public

getCrumbs( string $separator '&raquo;' , string|array|boolean $startText false )

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

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

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

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

Параметры

строка $separator необязательно '&raquo;'
Текст для разделения крошек.
строка|массив|логическое $startText необязательно false

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

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

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

Ссылка

http://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' => '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-images

implementedEvents()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-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 Тип элемента медиа для генерации, либо "аудио", либо "видео". Если тег не предоставлен, он угадывается на основе 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-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).

Возвращает

строка
Вложенный список

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/html.html#creating-nested-lists

para()source public

para( string $class , string $text , array $options [] )

Возвращает отформатированный тег P.

Параметры

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

Параметры

строка $class
Имя класса CSS элемента p.
строка $text
Строковое содержимое, которое будет отображаться внутри элемента p.
массив $options необязательно []
Дополнительные HTML атрибуты тега P.

Возвращает

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

script()source public

script( string|array $url , array $options [] )

Возвращает один или несколько тегов <script> в зависимости от количества предоставленных скриптов.

Если имя файла начинается с "/", путь будет относительным к корневому пути вашего приложения. В противном случае, путь будет относительным к вашему пути к JavaScript, обычно webroot/js.

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

Включение одного файла скрипта:

echo $this->Html->script('styles.js');

Включение нескольких файлов скриптов:

echo $this->Html->script(['one.js', 'two.js']);

Добавление файла скрипта в пользовательский блок:

$this->Html->script('styles.js', ['block' => 'bodyScript']);

Параметры

  • block Установите в true, чтобы добавить вывод в блок представления "script" или указать имя пользовательского блока.
  • once Нужно ли проверять скрипт на уникальность. Если true, скрипты будут включены только один раз, 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-files

scriptBlock()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-blocks

scriptEnd()source public

scriptEnd( )

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

Возвращает

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

Ссылка

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

scriptStart()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#создание-блоков-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
Массив данных стиля, ключи будут использованы в качестве имен свойств, значения в качестве значений свойств.
логическое значение $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
если пытаетесь заменить существующую конфигурацию
END_OF_DOCUMENT_MARKER

_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 Сам объект.

Подробное описание свойств

$_crumbssource

protected массив

Хлебные крошки.

[]

$_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 массив

Параметры для текущего открытого буфера блока скрипта, если таковой имеется.

[]

$helperssource

public массив

Список помощников, используемых этим помощником

['Url']

$responsesource

public Cake\Network\Response

Ссылка на объект Response

Подробное описание магических свойств

$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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API