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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\Element;
use DateTime as PhpDateTime;
use Traversable;
use Zend\Form\Element;
use Zend\Form\ElementPrepareAwareInterface;
use Zend\Form\FormInterface;
use Zend\InputFilter\InputProviderInterface;
use Zend\Stdlib\ArrayUtils;
use Zend\Validator\Regex as RegexValidator;
use Zend\Validator\ValidatorInterface;
class MonthSelect extends Element implements InputProviderInterface, ElementPrepareAwareInterface
{
/**
* Select form element that contains values for month
*
* @var Select
*/
protected $monthElement;
/**
* Select form element that contains values for year
*
* @var Select
*/
protected $yearElement;
/**
* Min year to use for the select (default: current year - 100)
*
* @var int
*/
protected $minYear;
/**
* Max year to use for the select (default: current year)
*
* @var int
*/
protected $maxYear;
/**
* If set to true, it will generate an empty option for every select (this is mainly needed by most JavaScript
* libraries to allow to have a placeholder)
*
* @var bool
*/
protected $createEmptyOption = false;
/**
* If set to true, view helpers will render delimiters between <select> elements, according to the
* specified locale
*
* @var bool
*/
protected $renderDelimiters = true;
/**
* @var ValidatorInterface
*/
protected $validator;
/**
* Constructor. Add two selects elements
*
* @param null|int|string $name Optional name for the element
* @param array $options Optional options for the element
*/
public function __construct($name = null, $options = [])
{
$this->minYear = date('Y') - 100;
$this->maxYear = date('Y');
$this->monthElement = new Select('month');
$this->yearElement = new Select('year');
parent::__construct($name, $options);
}
/**
* Set element options.
*
* Accepted options for MonthSelect:
*
* - month_attributes: HTML attributes to be rendered with the month element
* - year_attributes: HTML attributes to be rendered with the month element
* - min_year: min year to use in the year select
* - max_year: max year to use in the year select
*
* @param array|Traversable $options
* @return self
*/
public function setOptions($options)
{
parent::setOptions($options);
if ($options instanceof Traversable) {
$options = ArrayUtils::iteratorToArray($options);
}
if (isset($options['month_attributes'])) {
$this->setMonthAttributes($options['month_attributes']);
}
if (isset($options['year_attributes'])) {
$this->setYearAttributes($options['year_attributes']);
}
if (isset($options['min_year'])) {
$this->setMinYear($options['min_year']);
}
if (isset($options['max_year'])) {
$this->setMaxYear($options['max_year']);
}
if (isset($options['create_empty_option'])) {
$this->setShouldCreateEmptyOption($options['create_empty_option']);
}
if (isset($options['render_delimiters'])) {
$this->setShouldRenderDelimiters($options['render_delimiters']);
}
return $this;
}
/**
* @return Select
*/
public function getMonthElement()
{
return $this->monthElement;
}
/**
* @return Select
*/
public function getYearElement()
{
return $this->yearElement;
}
/**
* Get both the year and month elements
*
* @return array
*/
public function getElements()
{
return [$this->monthElement, $this->yearElement];
}
/**
* Set the month attributes
*
* @param array $monthAttributes
* @return self
*/
public function setMonthAttributes(array $monthAttributes)
{
$this->monthElement->setAttributes($monthAttributes);
return $this;
}
/**
* Get the month attributes
*
* @return array
*/
public function getMonthAttributes()
{
return $this->monthElement->getAttributes();
}
/**
* Set the year attributes
*
* @param array $yearAttributes
* @return self
*/
public function setYearAttributes(array $yearAttributes)
{
$this->yearElement->setAttributes($yearAttributes);
return $this;
}
/**
* Get the year attributes
*
* @return array
*/
public function getYearAttributes()
{
return $this->yearElement->getAttributes();
}
/**
* @param int $minYear
* @return self
*/
public function setMinYear($minYear)
{
$this->minYear = $minYear;
return $this;
}
/**
* @return int
*/
public function getMinYear()
{
return $this->minYear;
}
/**
* @param int $maxYear
* @return self
*/
public function setMaxYear($maxYear)
{
$this->maxYear = $maxYear;
return $this;
}
/**
* @return int
*/
public function getMaxYear()
{
return $this->maxYear;
}
/**
* @param bool $createEmptyOption
* @return self
*/
public function setShouldCreateEmptyOption($createEmptyOption)
{
$this->createEmptyOption = (bool) $createEmptyOption;
return $this;
}
/**
* @return bool
*/
public function shouldCreateEmptyOption()
{
return $this->createEmptyOption;
}
/**
* @param bool $renderDelimiters
* @return self
*/
public function setShouldRenderDelimiters($renderDelimiters)
{
$this->renderDelimiters = (bool) $renderDelimiters;
return $this;
}
/**
* @return bool
*/
public function shouldRenderDelimiters()
{
return $this->renderDelimiters;
}
/**
* @param mixed $value
* @return self
*/
public function setValue($value)
{
if ($value instanceof PhpDateTime) {
$value = [
'year' => $value->format('Y'),
'month' => $value->format('m')
];
}
$this->yearElement->setValue($value['year']);
$this->monthElement->setValue($value['month']);
return $this;
}
/**
* @return string
*/
public function getValue()
{
return sprintf(
'%s-%s',
$this->getYearElement()->getValue(),
$this->getMonthElement()->getValue()
);
}
/**
* Prepare the form element (mostly used for rendering purposes)
*
* @param FormInterface $form
* @return void
*/
public function prepareElement(FormInterface $form)
{
$name = $this->getName();
$this->monthElement->setName($name . '[month]');
$this->yearElement->setName($name . '[year]');
}
/**
* Get validator
*
* @return ValidatorInterface
*/
protected function getValidator()
{
return new RegexValidator('/^[0-9]{4}\-(0?[1-9]|1[012])$/');
}
/**
* Should return an array specification compatible with
* {@link Zend\InputFilter\Factory::createInput()}.
*
* @return array
*/
public function getInputSpecification()
{
return [
'name' => $this->getName(),
'required' => false,
'filters' => [
['name' => 'MonthSelect'],
],
'validators' => [
$this->getValidator(),
],
];
}
/**
* Clone the element (this is needed by Collection element, as it needs different copies of the elements)
*/
public function __clone()
{
$this->monthElement = clone $this->monthElement;
$this->yearElement = clone $this->yearElement;
}
}