Класс MultiCheckboxWidget
Класс виджета для создания множественных чекбоксов.
- Cake\View\Widget\MultiCheckboxWidget реализует Cake\View\Widget\WidgetInterface использует Cake\View\Helper\IdGeneratorTrait
Подробное описание методов
__constructисходный код public
__construct( Cake\View\StringTemplate $templates , Cake\View\Widget\LabelWidget $label )
Вывод виджета множественных чекбоксов.
Этот класс использует следующие шаблоны:
-
checkboxВыводит элементы управления чекбоксом. Принимает переменныеname,valueиattrs. -
checkboxWrapperВыводит содержащий div/элемент для чекбокса и его метки. Принимает переменныеinputиlabel.
Параметры
-
Cake\View\StringTemplate$templates - Список шаблонов.
-
Cake\View\Widget\LabelWidget$label - Экземпляр виджета метки.
_isDisabledисходный код protected
_isDisabled( string $key , array|null $disabled )
Вспомогательный метод для определения, какие параметры отключены.
Параметры
- строка
$key - Ключ для проверки.
- массив|null
$disabled - Значения, которые должны быть отключены.
Возвращает
booleanbool
_isSelectedисходный код protected
_isSelected( string $key , array|string|null $selected )
Вспомогательный метод для определения, какие параметры выбраны.
Параметры
- строка
$key - Ключ для проверки.
- массив|строка|null
$selected - Выбранные значения.
Возвращает
booleanbool
_renderInputисходный код protected
_renderInput( array $checkbox , Cake\View\Form\ContextInterface $context )
Вывод одного чекбокса и обертки.
Параметры
- массив
$checkbox - Массив, содержащий пары ключ/значение опций чекбокса
-
Cake\View\Form\ContextInterface$context - Объект контекста.
Возвращает
stringстрока
renderисходный код public
render( array $data , Cake\View\Form\ContextInterface $context )
Вывод виджета множественных чекбоксов.
Данные поддерживают следующие параметры.
-
nameАтрибут name вводимых элементов.[]будет добавлен к имени. -
optionsМассив опций для создания чекбоксов. -
valСтрока/целое число или массив значений, которые должны быть отмечены. Также может быть сложный набор опций. -
disabledБулево значение или массив чекбоксов, которые нужно отключить. -
escapeУстановить в false, чтобы отключить HTML-экранирование. -
optionsАссоциативный массив value=>метки для создания опций. -
idPrefixПрефикс для сгенерированных атрибутов ID.
Формат опций
Параметр опций может принимать различные форматы данных в зависимости от сложности генерируемого HTML.
Вы можете сгенерировать простые опции, используя базовый ассоциативный массив:
'options' => ['elk' => 'Elk', 'beaver' => 'Beaver']
Если вам нужно определить дополнительные атрибуты для элементов опций, вы можете использовать сложную форму опций:
'options' => [ ['value' => 'elk', 'text' => 'Elk', 'data-foo' => 'bar'], ]
Эта форма требует, чтобы оба ключа value и text были определены. Если какой-либо из них не задан, опции не будут сгенерированы правильно.
Параметры
- массив
$data - Данные для создания набора чекбоксов.
-
Cake\View\Form\ContextInterface$context - Текущий контекст формы.
Возвращает
stringстрока
Реализация
Cake\View\Widget\WidgetInterface::render() secureFieldsисходный код public
secureFields( array $data )
Возвращает список полей, которые нужно защитить для данного виджета. Поля представлены в формате Model[field][suffix]
Параметры
- массив
$data - Данные для отображения.
Возвращает
arrayМассив полей для защиты.
Реализация
Cake\View\Widget\WidgetInterface::secureFields() Используемые методы из Cake\View\Helper\IdGeneratorTrait
_domIdисходный код protected
_domId( string $value )
Генерация ID, подходящего для использования в атрибуте ID.
Параметры
- строка
$value - Значение для преобразования в ID.
Возвращает
stringСгенерированный ID.
_idисходный код protected
_id( string $name , string $val )
Генерация атрибута ID для элемента.
Обеспечение уникальности ID для набора полей.
Параметры
- строка
$name - Имя атрибута ID.
- строка
$val - Значение атрибута ID.
Возвращает
stringСгенерированный ID.
Резюме свойств
Используемые свойства из Cake\View\Helper\IdGeneratorTrait
$_idSuffixesисходный код
protected массив
Список суффиксов id, используемых в текущем отображении.
[]
© 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.1/class-Cake.View.Widget.MultiCheckboxWidget.html