-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
CheckboxWidget.php
95 lines (86 loc) · 2.84 KB
/
CheckboxWidget.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Widget;
use Cake\View\Form\ContextInterface;
/**
* 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.
*/
class CheckboxWidget extends BasicWidget
{
/**
* Data defaults.
*
* @var array<string, mixed>
*/
protected array $defaults = [
'name' => '',
'value' => 1,
'val' => null,
'disabled' => false,
'templateVars' => [],
];
/**
* 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.
*
* @param array<string, mixed> $data The data to create a checkbox with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string Generated HTML string.
*/
public function render(array $data, ContextInterface $context): string
{
$data += $this->mergeDefaults($data, $context);
if ($this->_isChecked($data)) {
$data['checked'] = true;
}
unset($data['val']);
$attrs = $this->_templates->formatAttributes(
$data,
['name', 'value']
);
return $this->_templates->format('checkbox', [
'name' => $data['name'],
'value' => $data['value'],
'templateVars' => $data['templateVars'],
'attrs' => $attrs,
]);
}
/**
* Checks whether the checkbox should be checked.
*
* @param array<string, mixed> $data Data to look at and determine checked state.
* @return bool
*/
protected function _isChecked(array $data): bool
{
if (array_key_exists('checked', $data)) {
return (bool)$data['checked'];
}
return (string)$data['val'] === (string)$data['value'];
}
}