Spec-Zone.ru › CakePHP 3.8

Класс 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|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

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

_idSuffix()source protected

_idSuffix( string $val )

Сгенерировать суффикс ID.

Обеспечивает уникальность id для заданного набора полей.

Параметры

строка $val
Значение атрибута ID.

Возвращает

строка
Сгенерированный суффикс ID.

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

$_labelsource

protected Cake\View\Widget\LabelWidget

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

END_OF_DOCUMENT_MARKER

$_templatessource

protected Cake\View\StringTemplate

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

© 2005–present 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.8/class-Cake.View.Widget.MultiCheckboxWidget.html

Spec-Zone.ru

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