Класс CheckboxWidget
Вспомогательный элемент управления для создания элементов типа «флажок».
Этот класс обычно используется внутри Cake\View\Helper\FormHelper, но может использоваться для генерации отдельных флажков.
Краткое описание свойств
- $_templates защищённый
Cake\View\StringTemplateЭкземпляр StringTemplate.
- $defaults защищённый
array<string, mixed>Значения по умолчанию для данных.
Краткое описание методов
-
__construct() публичный
Конструктор.
-
_isChecked() защищённый
Проверяет, должен ли флажок быть отмеченным.
-
mergeDefaults() защищённый
Объединяет значения по умолчанию с предоставленными данными.
-
render() публичный
Отображает элемент флажка.
-
secureFields() публичный
Возвращает список полей, которые необходимо защитить для этого виджета.
-
setMaxLength() защищённый
Устанавливает значение атрибута «maxlength», если применимо.
-
setRequired() защищённый
Устанавливает значение атрибута «required», если применимо.
-
setStep() защищённый
Устанавливает значение атрибута «step», если применимо.
Подробное описание методов
__construct() публичный
__construct(Cake\View\StringTemplate $templates)
Конструктор.
Параметры
-
Cake\View\StringTemplate$templates Список шаблонов.
_isChecked() защищённый
_isChecked(array<string, mixed> $data): bool
Проверяет, должен ли флажок быть отмеченным.
Параметры
-
array<string, mixed>$data Данные для определения состояния отметки.
Возвращает
boolmergeDefaults() защищённый
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() публичный
render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string
Отображает элемент флажка.
Данные поддерживают следующие ключи:
-
name— имя поля ввода. -
value— атрибут значения. По умолчанию '1'. -
val— текущее значение. Если оно совпадает сvalue, флажок будет отмечен. Вы также можете использовать атрибут 'checked', чтобы отметить флажок. -
disabled— флаг, указывающий, должен ли флажок быть отключён.
Любые другие переданные атрибуты будут обработаны как HTML-атрибуты.
Параметры
-
array<string, mixed>$data Данные для создания элемента флажка.
-
Cake\View\Form\ContextInterface$context Текущий контекст формы.
Возвращает
stringsecureFields() публичный
secureFields(array<string, mixed> $data): array<string>
Возвращает список полей, которые необходимо защитить для этого виджета.
Параметры
-
array<string, mixed>$data
Возвращает
array<string>setMaxLength() защищённый
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() защищённый
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() защищённый
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>Подробное описание свойств
$_templates защищённый
Экземпляр StringTemplate.
Тип
Cake\View\StringTemplate$defaults защищённый
Значения по умолчанию для данных.
Тип
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.CheckboxWidget.html
