Class CheckboxWidget
Input widget for creating checkbox widgets.
- Cake\View\Widget\BasicWidget implements Cake\View\Widget\WidgetInterface
-
Cake\View\Widget\CheckboxWidget
Inherited Properties
Method Summary
-
_isChecked() protected
Check whether or not the checkbox should be checked. -
render() public
Render a checkbox element.
Method Detail
_isChecked() protected ¶
_isChecked( array $data )
Check whether or not the checkbox should be checked.
Parameters
- array $data
- Data to look at and determine checked state.
Returns
boolean
render() public ¶
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 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
string
Generated HTML string.
Generated HTML string.
Overrides
Methods inherited from Cake\View\Widget\BasicWidget
secureFields() public ¶
secureFields( array $data )
Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]
Parameters
- array $data
- The data to render.
Returns
array
Array of fields to secure.
Array of fields to secure.