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