Input widget for creating checkbox widgets.
This class is usually used internally by Cake\View\Helper\FormHelper
, it but can be used to generate standalone checkboxes.
Cake\View\StringTemplate
StringTemplate instance.
array<string, mixed>
Data defaults.
Constructor.
Checks whether the checkbox should be checked.
Merge default values with supplied data.
Render a checkbox element.
Returns a list of fields that need to be secured for this widget.
Set value for "maxlength" attribute if applicable.
Set value for "required" attribute if applicable.
Set value for "step" attribute if applicable.
__construct(Cake\View\StringTemplate $templates)
Constructor.
Cake\View\StringTemplate
$templates Templates list.
_isChecked(array<string, mixed> $data): bool
Checks whether the checkbox should be checked.
array<string, mixed>
$data Data to look at and determine checked state.
bool
mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>
Merge default values with supplied data.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
array<string, mixed>
render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string
Render a checkbox element.
Data supports the following keys:
name
- The name of the input.value
- The value attribute. Defaults to '1'.val
- The current value. If it matches value
the checkbox will be checked. You can also use the 'checked' attribute to make the checkbox checked.disabled
- Whether the checkbox should be disabled.Any other attributes passed in will be treated as HTML attributes.
array<string, mixed>
$data The data to create a checkbox with.
Cake\View\Form\ContextInterface
$context The current form context.
string
secureFields(array<string, mixed> $data): array<string>
Returns a list of fields that need to be secured for this widget.
array<string, mixed>
$data array<string>
setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "maxlength" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "required" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "step" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
StringTemplate instance.
Cake\View\StringTemplate
Data 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.4/class-Cake.View.Widget.CheckboxWidget.html