forked from zendframework/zendframework
/
MultiCheckbox.php
205 lines (183 loc) · 5.14 KB
/
MultiCheckbox.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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\Element;
use Zend\Form\ElementInterface;
use Zend\Form\Exception\InvalidArgumentException;
use Zend\Validator\Explode as ExplodeValidator;
use Zend\Validator\InArray as InArrayValidator;
use Zend\Validator\ValidatorInterface;
class MultiCheckbox extends Checkbox
{
/**
* Seed attributes
*
* @var array
*/
protected $attributes = array(
'type' => 'multi_checkbox',
);
/**
* @var bool
*/
protected $disableInArrayValidator = false;
/**
* @var bool
*/
protected $useHiddenElement = false;
/**
* @var string
*/
protected $uncheckedValue = '';
/**
* @var array
*/
protected $valueOptions = array();
/**
* @return array
*/
public function getValueOptions()
{
return $this->valueOptions;
}
/**
* @param array $options
* @return MultiCheckbox
*/
public function setValueOptions(array $options)
{
$this->valueOptions = $options;
// Update Explode validator haystack
if ($this->validator instanceof ExplodeValidator) {
$validator = $this->validator->getValidator();
$validator->setHaystack($this->getValueOptionsValues());
}
return $this;
}
/**
* @param string $key
* @return self
*/
public function unsetValueOption($key)
{
if (isset($this->valueOptions[$key])) {
unset($this->valueOptions[$key]);
}
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
*
* @param array|\Traversable $options
* @return MultiCheckbox|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['disable_inarray_validator'])) {
$this->setDisableInArrayValidator($this->options['disable_inarray_validator']);
}
return $this;
}
/**
* Set a single element attribute
*
* @param string $key
* @param mixed $value
* @return MultiCheckbox|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 flag to allow for disabling the automatic addition of an InArray validator.
*
* @param bool $disableOption
* @return Select
*/
public function setDisableInArrayValidator($disableOption)
{
$this->disableInArrayValidator = (bool) $disableOption;
return $this;
}
/**
* Get the disable in array validator flag.
*
* @return bool
*/
public function disableInArrayValidator()
{
return $this->disableInArrayValidator;
}
/**
* Get validator
*
* @return ValidatorInterface
*/
protected function getValidator()
{
if (null === $this->validator && !$this->disableInArrayValidator()) {
$inArrayValidator = new InArrayValidator(array(
'haystack' => $this->getValueOptionsValues(),
'strict' => false,
));
$this->validator = new ExplodeValidator(array(
'validator' => $inArrayValidator,
'valueDelimiter' => null, // skip explode if only one value
));
}
return $this->validator;
}
/**
* Get only the values from the options attribute
*
* @return array
*/
protected function getValueOptionsValues()
{
$values = array();
$options = $this->getValueOptions();
foreach ($options as $key => $optionSpec) {
$value = (is_array($optionSpec)) ? $optionSpec['value'] : $key;
$values[] = $value;
}
if ($this->useHiddenElement()) {
$values[] = $this->getUncheckedValue();
}
return $values;
}
/**
* Sets the value that should be selected.
*
* @param mixed $value The value to set.
* @return MultiCheckbox
*/
public function setValue($value)
{
$this->value = $value;
return $this;
}
}