/
Radio.php
192 lines (174 loc) · 5.26 KB
/
Radio.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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v3.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Input;
use Cake\Utility\Inflector;
use Traversable;
/**
* Input widget class for generating a set of radio buttons.
*
* This class is intended as an internal implementation detail
* of Cake\View\Helper\FormHelper and is not intended for direct use.
*/
class Radio {
/**
* Template instance.
*
* @var Cake\View\StringTemplate
*/
protected $_templates;
/**
* Constructor
*
* This class uses a few templates:
*
* - `radio` Used to generate the input for a radio button.
* Can use the following variables `name`, `value`, `attrs`.
* - `label` Used to generate the label for a radio button.
* Can use the following variables `attrs`, `text` and `input`.
* - `radioContainer` Used to generate the container element for
* the radio + input element. Can use the `input` and `label`
* variables.
*
* @param Cake\View\StringTemplate $templates
*/
public function __construct($templates) {
$this->_templates = $templates;
}
/**
* Render a set of radio buttons.
*
* Data supports the following keys:
*
* - `name` - Set the input name.
* - `options` - An array of options. See below for more information.
* - `disabled` - Either true or an array of inputs to disable.
* When true, the select element will be disabled.
* - `val` - A string of the option to mark as selected.
* - `label` - Either false to disable label generation, or
* an array of attributes for all labels.
*
* @param array $data The data to build radio buttons with.
* @return string
*/
public function render($data) {
$data += [
'name' => '',
'options' => [],
'disabled' => null,
'val' => null,
'escape' => true,
'label' => true,
'empty' => false,
];
if ($data['options'] instanceof Traversable) {
$options = iterator_to_array($data['options']);
} else {
$options = (array)$data['options'];
}
if (!empty($data['empty'])) {
$empty = $data['empty'] === true ? 'empty' : $data['empty'];
$options = ['' => $empty] + $options;
}
unset($data['empty']);
$opts = [];
foreach ($options as $val => $text) {
$opts[] = $this->_renderInput($val, $text, $data);
}
return implode('', $opts);
}
/**
* Disabled attribute detection.
*
* @param array $radio
* @param array|null|true $disabled
* @return boolean
*/
protected function _isDisabled($radio, $disabled) {
if (!$disabled) {
return false;
}
if ($disabled === true) {
return true;
}
$isNumeric = is_numeric($radio['value']);
return (!is_array($disabled) || in_array((string)$radio['value'], $disabled, !$isNumeric));
}
/**
* Renders a single radio input and label.
*
* @param string|int $val The value of the radio input.
* @param string|array $text The label text, or complex radio type.
* @param array $data Additional options for input generation.
* @return string.
*/
protected function _renderInput($val, $text, $data) {
$escape = $data['escape'];
if (is_int($val) && isset($text['text'], $text['value'])) {
$radio = $text;
$text = $radio['text'];
} else {
$radio = ['value' => $val, 'text' => $text];
}
$radio['name'] = $data['name'];
if (empty($radio['id'])) {
$radio['id'] = mb_strtolower(Inflector::slug($radio['name'] . '_' . $radio['value'], '-'));
}
if (isset($data['val']) && strval($data['val']) === strval($radio['value'])) {
$radio['checked'] = true;
}
if ($this->_isDisabled($radio, $data['disabled'])) {
$radio['disabled'] = true;
}
$input = $this->_templates->format('radio', [
'name' => $radio['name'],
'value' => $escape ? h($radio['value']) : $radio['value'],
'attrs' => $this->_templates->formatAttributes($radio, ['name', 'value', 'text']),
]);
$label = $this->_renderLabel(
$radio,
$data['label'],
$input,
$escape
);
return $this->_templates->format('radioContainer', [
'input' => $input,
'label' => $label,
]);
}
/**
* Renders a label element for a given radio button.
*
* In the future this might be refactored into a separate widget as other
* input types (multi-checkboxes) will also need labels generated.
*
* @param array $radio The input properties.
* @param false|string|array $label The properties for a label.
* @param string $input The input widget.
* @param boolean $escape Whether or not to HTML escape the label.
* @return string Generated label.
*/
protected function _renderLabel($radio, $label, $input, $escape) {
if (!$label) {
return false;
}
$labelAttrs = is_array($label) ? $label : [];
$labelAttrs += ['for' => $radio['id'], 'escape' => $escape];
return $this->_templates->format('label', [
'text' => $escape ? h($radio['text']) : $radio['text'],
'input' => $input,
'attrs' => $this->_templates->formatAttributes($labelAttrs),
]);
}
}