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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
namespace ipl\Html\FormElement;
use InvalidArgumentException;
use ipl\Html\Attributes;
use ipl\Html\Common\MultipleAttribute;
use ipl\Html\Html;
use ipl\Html\HtmlElement;
use ipl\Validator\DeferredInArrayValidator;
use ipl\Validator\ValidatorChain;
use UnexpectedValueException;
class SelectElement extends BaseFormElement
{
use MultipleAttribute;
protected $tag = 'select';
/** @var SelectOption[] */
protected $options = [];
/** @var SelectOption[]|HtmlElement[] */
protected $optionContent = [];
/** @var array Disabled select options */
protected $disabledOptions = [];
/** @var array|string|null */
protected $value;
/**
* Get the option with specified value
*
* @param string|int|null $value
*
* @return ?SelectOption
*/
public function getOption($value): ?SelectOption
{
return $this->options[$value] ?? null;
}
/**
* Set the options from specified values
*
* @param array $options
*
* @return $this
*/
public function setOptions(array $options): self
{
$this->options = [];
$this->optionContent = [];
foreach ($options as $value => $label) {
$this->optionContent[$value] = $this->makeOption($value, $label);
}
return $this;
}
/**
* Set the specified options as disable
*
* @param array $disabledOptions
*
* @return $this
*/
public function setDisabledOptions(array $disabledOptions): self
{
if (! empty($this->options)) {
foreach ($this->options as $option) {
$optionValue = $option->getValue();
$option->setAttribute(
'disabled',
in_array($optionValue, $disabledOptions, ! is_int($optionValue))
|| ($optionValue === null && in_array('', $disabledOptions, true))
);
}
$this->disabledOptions = [];
} else {
$this->disabledOptions = $disabledOptions;
}
return $this;
}
/**
* Get the value of the element
*
* Returns `array` when the attribute `multiple` is set to `true`, `string` or `null` otherwise
*
* @return array|string|null
*/
public function getValue()
{
if ($this->isMultiple()) {
return parent::getValue() ?? [];
}
return parent::getValue();
}
public function getValueAttribute()
{
// select elements don't have a value attribute
return null;
}
public function getNameAttribute()
{
$name = $this->getName();
return $this->isMultiple() ? ($name . '[]') : $name;
}
/**
* Make the selectOption for the specified value and the label
*
* @param string|int|null $value Value of the option
* @param string|array $label Label of the option
*
* @return SelectOption|HtmlElement
*/
protected function makeOption($value, $label)
{
if (is_array($label)) {
$grp = Html::tag('optgroup', ['label' => $value]);
foreach ($label as $option => $val) {
$grp->addHtml($this->makeOption($option, $val));
}
return $grp;
}
$option = (new SelectOption($value, $label))
->setAttribute('disabled', in_array($value, $this->disabledOptions, ! is_int($value)));
$option->getAttributes()->registerAttributeCallback('selected', function () use ($option) {
return $this->isSelectedOption($option->getValue());
});
$this->options[$value] = $option;
return $this->options[$value];
}
/**
* Get whether the given option is selected
*
* @param int|string|null $optionValue
*
* @return bool
*/
protected function isSelectedOption($optionValue): bool
{
$value = $this->getValue();
if ($optionValue === '') {
$optionValue = null;
}
if ($this->isMultiple()) {
if (! is_array($value)) {
throw new UnexpectedValueException(
'Value must be an array when the `multiple` attribute is set to `true`'
);
}
return in_array($optionValue, $this->getValue(), ! is_int($optionValue))
|| ($optionValue === null && in_array('', $this->getValue(), true));
}
if (is_array($value)) {
throw new UnexpectedValueException(
'Value cannot be an array without setting the `multiple` attribute to `true`'
);
}
return is_int($optionValue)
// The loose comparison is required because PHP casts
// numeric strings to integers if used as array keys
? $value == $optionValue
: $value === $optionValue;
}
protected function addDefaultValidators(ValidatorChain $chain): void
{
$chain->add(
new DeferredInArrayValidator(function (): array {
$possibleValues = [];
foreach ($this->options as $option) {
if ($option->getAttributes()->get('disabled')->getValue()) {
continue;
}
$possibleValues[] = $option->getValue();
}
return $possibleValues;
})
);
}
protected function assemble()
{
$this->addHtml(...array_values($this->optionContent));
}
protected function registerAttributeCallbacks(Attributes $attributes)
{
parent::registerAttributeCallbacks($attributes);
$attributes->registerAttributeCallback(
'options',
null,
[$this, 'setOptions']
);
$attributes->registerAttributeCallback(
'disabledOptions',
null,
[$this, 'setDisabledOptions']
);
// ZF1 compatibility:
$this->getAttributes()->registerAttributeCallback(
'multiOptions',
null,
[$this, 'setOptions']
);
$this->registerMultipleAttributeCallback($attributes);
}
}
|
