Spec-Zone.ru › CakePHP 3.3

Класс MultiCheckboxWidget

Класс виджета для генерации нескольких флажков.

Cake\View\Widget\MultiCheckboxWidget реализует Cake\View\Widget\WidgetInterface использует Cake\View\Helper\IdGeneratorTrait
Пространство имен: Cake\View\Widget
Расположение: View/Widget/MultiCheckboxWidget.php

Резюме свойств

  • $_label protected
    Cake\View\Widget\LabelWidget
    Экземпляр виджета метки.
  • $_templates protected
    Cake\View\StringTemplate
    Экземпляр шаблона для использования.

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

  • _idPrefix, _idSuffixes

Резюме методов

  • __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|null $disabled )

Вспомогательный метод для определения, какие опции отключены.

Параметры

строка $key
Ключ для проверки.
массив|null $disabled
Значения, которые отключены.

Возвращает

boolean

_isSelected()source protected

_isSelected( string $key , array|string|null $selected )

Вспомогательный метод для определения, какие опции выбраны.

Параметры

строка $key
Ключ для проверки.
массив|строка|null $selected
Выбранные значения.

Возвращает

boolean

_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 Ассоциативный массив value=>метки для генерации опций.
  • 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

_clearIds()source protected

_clearIds( )

Очистить сохраненные суффиксы ID.

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

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

$_labelsource

protected Cake\View\Widget\LabelWidget

Экземпляр виджета метки.

$_templatessource

protected Cake\View\StringTemplate

Экземпляр шаблона для использования.

© 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.3/class-Cake.View.Widget.MultiCheckboxWidget.html

Spec-Zone.ru

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