\Cake\View\WidgetCheckboxWidget

Input widget for creating checkbox widgets.

This input class can be used to render basic simple input elements like hidden, text, email, tel and other types.

Summary

Methods

Properties

Constants

__construct()
render()
secureFields()

No public properties found

No constants found

_isChecked()

$_templates

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/View/Widget/CheckboxWidget.php
Package: Default
Class hierarchy: \Cake\View\Widget\BasicWidget

\Cake\View\Widget\CheckboxWidget

Properties

$_templates

$_templates : \Cake\View\StringTemplate

StringTemplate instance.

Type

\Cake\View\StringTemplate

Methods

__construct()

__construct(\Cake\View\StringTemplate  $templates)

Constructor.

Parameters

\Cake\View\StringTemplate

$templates

Templates list.

render()

render(array  $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 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.

secureFields()

secureFields(array  $data) : array

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.

_isChecked()

_isChecked(array  $data) : boolean

Check whether or not the checkbox should be checked.

Parameters

array

$data

Data to look at and determine checked state.

Returns

boolean