Class CheckboxWidget

Input widget for creating checkbox widgets.

Namespace: Cake\View\Widget

Properties summary

  • $_templates protected
    \Cake\View\StringTemplate

    StringTemplate instance.

Method Summary

  • __construct() public

    Constructor.

  • _isChecked() protected

    Check whether or not the checkbox should be checked.

  • render() public

    Render a checkbox element.

  • secureFields() public

    Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]

Method Detail

__construct() public 

__construct(mixed $templates)

Constructor.

Parameters

\Cake\View\StringTemplate $templates

Templates list.

_isChecked() protected 

_isChecked(mixed $data)

Check whether or not the checkbox should be checked.

Parameters

array $data

Data to look at and determine checked state.

Returns

bool

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 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() 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

string[]

Array of fields to secure.

Property Detail

$_templates protected

StringTemplate instance.

Type

\Cake\View\StringTemplate

© 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/3.9/class-Cake.View.Widget.CheckboxWidget.html