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
Data defaults.
__construct(\Cake\View\StringTemplate $templates)
Constructor.
\Cake\View\StringTemplate
$templates Templates list.
_isChecked(array $data)
Check whether or not the checkbox should be checked.
array
$data Data to look at and determine checked state.
bool
mergeDefaults(array $data, \Cake\View\Form\ContextInterface $context)
Merge default values with supplied data.
array
$data Data array
\Cake\View\Form\ContextInterface
$context Context instance.
array
Updated data array.
render(array $data, \Cake\View\Form\ContextInterface $context)
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 or not the checkbox should be disabled.Any other attributes passed in will be treated as HTML attributes.
array
$data The data to create a checkbox with.
\Cake\View\Form\ContextInterface
$context The current form context.
string
Generated HTML string.
secureFields(array $data)
Returns a list of fields that need to be secured for this widget.
array
$data The data to render.
string[]
Array of fields to secure.
setMaxLength(array $data, \Cake\View\Form\ContextInterface $context, string $fieldName)
Set value for "maxlength" attribute if applicable.
array
$data Data array
\Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array
Updated data array.
setRequired(array $data, \Cake\View\Form\ContextInterface $context, string $fieldName)
Set value for "required" attribute if applicable.
array
$data Data array
\Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array
Updated data array.
setStep(array $data, \Cake\View\Form\ContextInterface $context, string $fieldName)
Set value for "step" attribute if applicable.
array
$data Data array
\Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array
Updated data array.
StringTemplate instance.
\Cake\View\StringTemplate
Data defaults.
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.1/class-Cake.View.Widget.CheckboxWidget.html