On this page
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() protectedCheck whether or not the checkbox should be checked.
-
render() publicRender a checkbox element.
Method Detail
_isChecked()source 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
booleanrender()source 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 matchesvalue
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.
Parameters
-
array
$data
- The data to create a checkbox with.
Cake\View\Form\ContextInterface
$context
- The current form context.
Returns
stringGenerated HTML string.
Overrides
Cake\View\Widget\BasicWidget::render()
Methods inherited from Cake\View\Widget\BasicWidget
__construct()source public
__construct( Cake\View\StringTemplate $templates )
Constructor.
Parameters
-
Cake\View\StringTemplate
$templates
- Templates list.
secureFields()source 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
arrayArray of fields to secure.
Implementation of
Cake\View\Widget\WidgetInterface::secureFields()
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.View.Widget.CheckboxWidget.html