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.

Namespace: Cake\View\Widget

Property Summary

  • $_templates protected
    Cake\View\StringTemplate

    StringTemplate instance.

  • $defaults protected
    array<string, mixed>

    Data defaults.

Method Summary

  • __construct() public

    Constructor.

  • _isChecked() protected

    Checks whether 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<string, mixed> $data): bool

Checks whether the checkbox should be checked.

Parameters

array<string, mixed> $data

Data to look at and determine checked state.

Returns

bool

mergeDefaults() protected 

mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>

Merge default values with supplied data.

Parameters

array<string, mixed> $data

Data array

Cake\View\Form\ContextInterface $context

Context instance.

Returns

array<string, mixed>

render() public 

render(array<string, mixed> $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 the checkbox should be disabled.

Any other attributes passed in will be treated as HTML attributes.

Parameters

array<string, mixed> $data

The data to create a checkbox with.

Cake\View\Form\ContextInterface $context

The current form context.

Returns

string

secureFields() public 

secureFields(array<string, mixed> $data): array<string>

Returns a list of fields that need to be secured for this widget.

Parameters

array<string, mixed> $data

Returns

array<string>

setMaxLength() protected 

setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Set value for "maxlength" attribute if applicable.

Parameters

array<string, mixed> $data

Data array

Cake\View\Form\ContextInterface $context

Context instance.

string $fieldName

Field name.

Returns

array<string, mixed>

setRequired() protected 

setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Set value for "required" attribute if applicable.

Parameters

array<string, mixed> $data

Data array

Cake\View\Form\ContextInterface $context

Context instance.

string $fieldName

Field name.

Returns

array<string, mixed>

setStep() protected 

setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Set value for "step" attribute if applicable.

Parameters

array<string, mixed> $data

Data array

Cake\View\Form\ContextInterface $context

Context instance.

string $fieldName

Field name.

Returns

array<string, mixed>

Property Detail

$_templates protected

StringTemplate instance.

Type

Cake\View\StringTemplate

$defaults protected

Data defaults.

Type

array<string, mixed>

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