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