forked from zendframework/zendframework
/
Select.php
246 lines (220 loc) · 6.65 KB
/
Select.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
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
239
240
241
242
243
244
245
246
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Form
* @subpackage Element
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\Element;
use Traversable;
use Zend\Form\Element;
use Zend\Form\ElementInterface;
use Zend\Form\Exception\InvalidArgumentException;
use Zend\InputFilter\InputProviderInterface;
use Zend\Validator\Explode as ExplodeValidator;
use Zend\Validator\InArray as InArrayValidator;
use Zend\Validator\ValidatorInterface;
/**
* @category Zend
* @package Zend_Form
* @subpackage Element
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Select extends Element implements InputProviderInterface
{
/**
* Seed attributes
*
* @var array
*/
protected $attributes = array(
'type' => 'select',
);
/**
* @var ValidatorInterface
*/
protected $validator;
/**
* Create an empty option (option with label but no value). If set to null, no option is created
*
* @var bool
*/
protected $emptyOption = null;
/**
* @var array
*/
protected $valueOptions = array();
/**
* @return array
*/
public function getValueOptions()
{
return $this->valueOptions;
}
/**
* @param array $options
* @return Select
*/
public function setValueOptions(array $options)
{
$this->valueOptions = $options;
// Update InArrayValidator validator haystack
if (!is_null($this->validator)) {
if ($this->validator instanceof InArrayValidator){
$validator = $this->validator;
}
if ($this->validator instanceof ExplodeValidator
&& $this->validator->getValidator() instanceof InArrayValidator
){
$validator = $this->validator->getValidator();
}
if (!empty($validator)){
$validator->setHaystack($this->getValueOptionsValues());
}
}
return $this;
}
/**
* Set options for an element. Accepted options are:
* - label: label to associate with the element
* - label_attributes: attributes to use when the label is rendered
* - value_options: list of values and labels for the select options
* _ empty_option: should an empty option be prepended to the options ?
*
* @param array|\Traversable $options
* @return Select|ElementInterface
* @throws InvalidArgumentException
*/
public function setOptions($options)
{
parent::setOptions($options);
if (isset($this->options['value_options'])) {
$this->setValueOptions($this->options['value_options']);
}
// Alias for 'value_options'
if (isset($this->options['options'])) {
$this->setValueOptions($this->options['options']);
}
if (isset($this->options['empty_option'])) {
$this->setEmptyOption($this->options['empty_option']);
}
return $this;
}
/**
* Set a single element attribute
*
* @param string $key
* @param mixed $value
* @return Select|ElementInterface
*/
public function setAttribute($key, $value)
{
// Do not include the options in the list of attributes
// TODO: Deprecate this
if ($key === 'options') {
$this->setValueOptions($value);
return $this;
}
return parent::setAttribute($key, $value);
}
/**
* Set the string for an empty option (can be empty string). If set to null, no option will be added
*
* @param string|null $emptyOption
* @return Select
*/
public function setEmptyOption($emptyOption)
{
$this->emptyOption = $emptyOption;
return $this;
}
/**
* Return the string for the empty option (null if none)
*
* @return string|null
*/
public function getEmptyOption()
{
return $this->emptyOption;
}
/**
* Get validator
*
* @return ValidatorInterface
*/
protected function getValidator()
{
if (null === $this->validator) {
$validator = new InArrayValidator(array(
'haystack' => $this->getValueOptionsValues(),
'strict' => false
));
$multiple = (isset($this->attributes['multiple']))
? $this->attributes['multiple'] : null;
if (true === $multiple || 'multiple' === $multiple) {
$validator = new ExplodeValidator(array(
'validator' => $validator,
'valueDelimiter' => null, // skip explode if only one value
));
}
$this->validator = $validator;
}
return $this->validator;
}
/**
* Provide default input rules for this element
*
* Attaches the captcha as a validator.
*
* @return array
*/
public function getInputSpecification()
{
$spec = array(
'name' => $this->getName(),
'required' => true,
'validators' => array(
$this->getValidator()
)
);
return $spec;
}
/**
* Get only the values from the options attribute
*
* @return array
*/
protected function getValueOptionsValues()
{
$values = array();
$options = $this->getValueOptions();
foreach ($options as $key => $optionSpec) {
if (is_array($optionSpec) && array_key_exists('options', $optionSpec)) {
foreach ($optionSpec['options'] as $nestedKey => $nestedOptionSpec) {
$values[] = $this->getOptionValue($nestedKey, $nestedOptionSpec);
}
continue;
}
$values[] = $this->getOptionValue($key, $optionSpec);
}
return $values;
}
protected function getOptionValue($key, $optionSpec)
{
return is_array($optionSpec) ? $optionSpec['value'] : $key;
}
}