Class CheckboxWidget
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.
Property Summary
-
$_templates protected
Cake\View\StringTemplateStringTemplate instance.
-
$defaults protected
arrayData defaults.
Method Summary
-
__construct() public
Constructor.
-
_isChecked() protected
Check whether or not the checkbox should be checked.
-
mergeDefaults() protected
Merge default values with supplied data.
-
render() public
Render a checkbox element.
-
secureFields() public
Returns a list of fields that need to be secured for this widget.
-
setMaxLength() protected
Set value for "maxlength" attribute if applicable.
-
setRequired() protected
Set value for "required" attribute if applicable.
-
setStep() protected
Set value for "step" attribute if applicable.
Method Detail
__construct() ¶ public
__construct(Cake\View\StringTemplate $templates)Constructor.
Parameters
-
Cake\View\StringTemplate$templates Templates list.
_isChecked() ¶ protected
_isChecked(array $data): boolCheck whether or not the checkbox should be checked.
Parameters
-
array$data Data to look at and determine checked state.
Returns
boolmergeDefaults() ¶ protected
mergeDefaults(array $data, Cake\View\Form\ContextInterface $context): arrayMerge default values with supplied data.
Parameters
-
array$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
Returns
arrayUpdated data array.
render() ¶ public
render(array $data, Cake\View\Form\ContextInterface $context): stringRender 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 matchesvaluethe 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.
Parameters
-
array$data The data to create a checkbox with.
-
Cake\View\Form\ContextInterface$context The current form context.
Returns
stringGenerated HTML string.
secureFields() ¶ public
secureFields(array $data): string[]Returns a list of fields that need to be secured for this widget.
Parameters
-
array$data
Returns
string[]setMaxLength() ¶ protected
setMaxLength(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): arraySet value for "maxlength" attribute if applicable.
Parameters
-
array$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
arrayUpdated data array.
setRequired() ¶ protected
setRequired(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): arraySet value for "required" attribute if applicable.
Parameters
-
array$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
arrayUpdated data array.
setStep() ¶ protected
setStep(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): arraySet value for "step" attribute if applicable.
Parameters
-
array$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
arrayUpdated data array.