Spec-Zone.ru › CakePHP 4.3

Класс MultiCheckboxWidget

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

Этот класс обычно используется внутри Cake\View\Helper\FormHelper, но может использоваться для создания независимых множественных флажков.

Пространство имен: Cake\View\Widget

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

  • $_idPrefix protected
    string|null

    Префикс для атрибута id.

  • $_idSuffixes protected
    array<string>

    Список суффиксов id, используемых в текущем рендеринге.

  • $_label protected
    Cake\View\Widget\LabelWidget

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

  • $_templates protected
    Cake\View\StringTemplate

    Экземпляр StringTemplate.

  • $defaults protected
    array<string, mixed>

    Значения по умолчанию.

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

  • __construct() public

    Отображение виджета множественных флажков.

  • _clearIds() protected

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

  • _domId() protected

    Генерировать ID, подходящий для использования в атрибуте ID.

  • _id() protected

    Генерировать атрибут ID для элемента.

  • _idSuffix() protected

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

  • _isDisabled() protected

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

  • _isSelected() protected

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

  • _renderInput() protected

    Отобразить один флажок и его контейнер.

  • _renderInputs() protected

    Отобразить поля флажков.

  • mergeDefaults() protected

    Объединить значения по умолчанию с предоставленными данными.

  • render() public

    Отображение виджета множественных флажков.

  • secureFields() public

    Возвращает список полей, которые необходимо защитить для этого виджета.

  • setMaxLength() protected

    Установить значение атрибута "maxlength", если применимо.

  • setRequired() protected

    Установить значение атрибута "required", если применимо.

  • setStep() protected

    Установить значение атрибута "step", если применимо.

END_OF_DOCUMENT_MARKER

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

__construct() 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

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

_clearIds() protected 

_clearIds(): void

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

Возвращает

void

_domId() protected 

_domId(string $value): string

Генерировать идентификатор, подходящий для использования в атрибуте ID.

Параметры

string $value

Значение для преобразования в идентификатор.

Возвращает

string

_id() protected 

_id(string $name, string $val): string

Генерировать атрибут идентификатора для элемента.

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

Параметры

string $name

Имя атрибута ID.

string $val

Значение атрибута ID.

Возвращает

string

_idSuffix() protected 

_idSuffix(string $val): string

Генерировать суффикс идентификатора.

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

Параметры

string $val

Значение атрибута ID.

Возвращает

string

_isDisabled() protected 

_isDisabled(string $key, mixed $disabled): bool

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

Параметры

string $key

Ключ для проверки.

mixed $disabled

Значения для отключения.

Возвращает

bool

_isSelected() protected 

_isSelected(string $key, array<string>|string|int|false|null $selected): bool

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

Параметры

string $key

Ключ для проверки.

array<string>|string|int|false|null $selected

Выбранные значения.

Возвращает

bool

_renderInput() protected 

_renderInput(array<string, mixed> $checkbox, Cake\View\Form\ContextInterface $context): string

Отобразить один флажок и оболочку.

Параметры

array<string, mixed> $checkbox

Массив, содержащий пары ключ/значение опций флажка

Cake\View\Form\ContextInterface $context

Объект контекста.

Возвращает

string

_renderInputs() protected 

_renderInputs(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string>

Отобразить элементы управления флажками.

Параметры

array<string, mixed> $data

Массив данных, определяющих флажки.

Cake\View\Form\ContextInterface $context

Текущий контекст формы.

Возвращает

array<string>

mergeDefaults() protected 

mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>

Объединить значения по умолчанию со значениями предоставленными данными.

Параметры

array<string, mixed> $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

Возвращает

array<string, mixed>

render() public 

render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string

Отобразить виджет с множественными флажками.

Данные поддерживают следующие параметры.

  • name Атрибут name элементов ввода, для создания. [] будет добавлен к имени.
  • options Массив опций для создания флажков.
  • val Строка/целое число или массив значений, которые должны быть отмечены. Также может быть сложный набор опций.
  • disabled Логическое значение или массив флажков, которые должны быть отключены.
  • escape Установите в значение false, чтобы отключить экранирование HTML.
  • options Ассоциативный массив value=>labels для генерации опций.
  • idPrefix Префикс для сгенерированных атрибутов ID.

Формат опций

Опция options может принимать различные форматы данных в зависимости от сложности HTML, который нужно сгенерировать.

Вы можете сгенерировать простые опции, используя базовый ассоциативный массив:

'options' => ['elk' => 'Elk', 'beaver' => 'Beaver']

Если вам необходимо определить дополнительные атрибуты для элементов опций, вы можете использовать сложную форму для опций:

'options' => [
  ['value' => 'elk', 'text' => 'Elk', 'data-foo' => 'bar'],
]

В этом формате обязательно должны быть определены оба ключа value и text. Если какой-либо из них не задан, опции не будут сгенерированы должным образом.

Параметры

array<string, mixed> $data

Данные для генерации набора флажков.

Cake\View\Form\ContextInterface $context

Текущий контекст формы.

Возвращает

string

secureFields() public 

secureFields(array<string, mixed> $data): array<string>

Возвращает список полей, которые нужно зашифровать для этого виджета.

Параметры

array<string, mixed> $data

Возвращает

array<string>

setMaxLength() protected 

setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Устанавливает значение атрибута "maxlength", если применимо.

Параметры

array<string, mixed> $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setRequired() protected 

setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Устанавливает значение атрибута "required", если применимо.

Параметры

array<string, mixed> $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setStep() protected 

setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Устанавливает значение атрибута "step", если применимо.

Параметры

array<string, mixed> $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

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

$_idPrefix protected

Префикс для атрибута id.

Тип

string|null

$_idSuffixes protected

Список суффиксов id, используемых в текущем рендеринге.

Тип

array<string>

$_label protected

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

Тип

Cake\View\Widget\LabelWidget

$_templates protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate

$defaults protected

Значения по умолчанию.

Тип

array<string, mixed>

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

Spec-Zone.ru

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