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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
<?php
namespace Laminas\Form;
use Laminas\Stdlib\ArrayUtils;
use Laminas\Stdlib\InitializableInterface;
use Traversable;
use function array_key_exists;
use function get_class;
use function gettype;
use function is_array;
use function is_object;
use function is_string;
use function sprintf;
class Element implements
ElementAttributeRemovalInterface,
ElementInterface,
InitializableInterface,
LabelAwareInterface
{
/**
* @var array
*/
protected $attributes = [];
/**
* @var null|string
*/
protected $label;
/**
* @var array
*/
protected $labelAttributes = [];
/**
* Label specific options
*
* @var array
*/
protected $labelOptions = [];
/**
* @var array|Traversable Validation error messages
*/
protected $messages = [];
/**
* @var array custom options
*/
protected $options = [];
/**
* @var mixed
*/
protected $value;
/**
* @var boolean
*/
protected $hasValue = false;
/**
* @param null|int|string $name Optional name for the element
* @param array|Traversable $options Optional options for the element
* @throws Exception\InvalidArgumentException
*/
public function __construct($name = null, $options = [])
{
if (null !== $name) {
$this->setName($name);
}
if (! empty($options)) {
$this->setOptions($options);
}
}
/**
* This function is automatically called when creating element with factory. It
* allows to perform various operations (add elements...)
*
* @return void
*/
public function init()
{
}
/**
* Set value for name
*
* @param string $name
* @return $this
*/
public function setName($name)
{
$this->setAttribute('name', $name);
return $this;
}
/**
* Get value for name
*
* @return string|int
*/
public function getName()
{
return $this->getAttribute('name');
}
/**
* 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
* - label_options: label specific options
*
* @param array|Traversable $options
* @return $this
* @throws Exception\InvalidArgumentException
*/
public function setOptions($options)
{
if ($options instanceof Traversable) {
$options = ArrayUtils::iteratorToArray($options);
} elseif (! is_array($options)) {
throw new Exception\InvalidArgumentException(
'The options parameter must be an array or a Traversable'
);
}
if (isset($options['label'])) {
$this->setLabel($options['label']);
}
if (isset($options['label_attributes'])) {
$this->setLabelAttributes($options['label_attributes']);
}
if (isset($options['label_options'])) {
$this->setLabelOptions($options['label_options']);
}
$this->options = $options;
return $this;
}
/**
* Get defined options
*
* @return array
*/
public function getOptions()
{
return $this->options;
}
/**
* Return the specified option
*
* @param string $option
* @return null|mixed
*/
public function getOption($option)
{
if (! isset($this->options[$option])) {
return null;
}
return $this->options[$option];
}
/**
* Set a single option for an element
*
* @param string $key
* @param mixed $value
* @return $this
*/
public function setOption($key, $value)
{
$this->options[$key] = $value;
return $this;
}
/**
* Set a single element attribute
*
* @param string $key
* @param mixed $value
* @return $this
*/
public function setAttribute($key, $value)
{
// Do not include the value in the list of attributes
if ($key === 'value') {
$this->setValue($value);
return $this;
}
$this->attributes[$key] = $value;
return $this;
}
/**
* Retrieve a single element attribute
*
* @param $key
* @return mixed|null
*/
public function getAttribute($key)
{
if (! isset($this->attributes[$key])) {
return;
}
return $this->attributes[$key];
}
/**
* Remove a single attribute
*
* @param string $key
* @return $this
*/
public function removeAttribute($key)
{
unset($this->attributes[$key]);
return $this;
}
/**
* Does the element has a specific attribute ?
*
* @param string $key
* @return bool
*/
public function hasAttribute($key)
{
return array_key_exists($key, $this->attributes);
}
/**
* Set many attributes at once
*
* Implementation will decide if this will overwrite or merge.
*
* @param array|Traversable $arrayOrTraversable
* @return $this
* @throws Exception\InvalidArgumentException
*/
public function setAttributes($arrayOrTraversable)
{
if (! is_array($arrayOrTraversable) && ! $arrayOrTraversable instanceof Traversable) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects an array or Traversable argument; received "%s"',
__METHOD__,
is_object($arrayOrTraversable) ? get_class($arrayOrTraversable) : gettype($arrayOrTraversable)
));
}
foreach ($arrayOrTraversable as $key => $value) {
$this->setAttribute($key, $value);
}
return $this;
}
/**
* Retrieve all attributes at once
*
* @return array|Traversable
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Remove many attributes at once
*
* @param array $keys
* @return $this
*/
public function removeAttributes(array $keys)
{
foreach ($keys as $key) {
unset($this->attributes[$key]);
}
return $this;
}
/**
* Clear all attributes
*
* @return $this
*/
public function clearAttributes()
{
$this->attributes = [];
return $this;
}
/**
* Set the element value
*
* @param mixed $value
* @return $this
*/
public function setValue($value)
{
$this->value = $value;
$this->hasValue = true;
return $this;
}
/**
* Retrieve the element value
*
* @return mixed
*/
public function getValue()
{
return $this->value;
}
/**
* Set the label used for this element
*
* @param $label
* @return $this
*/
public function setLabel($label)
{
if (is_string($label)) {
$this->label = $label;
}
return $this;
}
/**
* Retrieve the label used for this element
*
* @return null|string
*/
public function getLabel()
{
return $this->label;
}
/**
* Set the attributes to use with the label
*
* @param array $labelAttributes
* @return $this
*/
public function setLabelAttributes(array $labelAttributes)
{
$this->labelAttributes = $labelAttributes;
return $this;
}
/**
* Get the attributes to use with the label
*
* @return array
*/
public function getLabelAttributes()
{
return $this->labelAttributes;
}
/**
* Set many label options at once
*
* Implementation will decide if this will overwrite or merge.
*
* @param array|Traversable $arrayOrTraversable
* @return $this
* @throws Exception\InvalidArgumentException
*/
public function setLabelOptions($arrayOrTraversable)
{
if (! is_array($arrayOrTraversable) && ! $arrayOrTraversable instanceof Traversable) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects an array or Traversable argument; received "%s"',
__METHOD__,
is_object($arrayOrTraversable) ? get_class($arrayOrTraversable) : gettype($arrayOrTraversable)
));
}
foreach ($arrayOrTraversable as $key => $value) {
$this->setLabelOption($key, $value);
}
return $this;
}
/**
* Get label specific options
*
* @return array
*/
public function getLabelOptions()
{
return $this->labelOptions;
}
/**
* Clear all label options
*
* @return $this
*/
public function clearLabelOptions()
{
$this->labelOptions = [];
return $this;
}
/**
* Remove many attributes at once
*
* @param array $keys
* @return $this
*/
public function removeLabelOptions(array $keys)
{
foreach ($keys as $key) {
unset($this->labelOptions[$key]);
}
return $this;
}
/**
* Set a single label optionn
*
* @param string $key
* @param mixed $value
* @return $this
*/
public function setLabelOption($key, $value)
{
$this->labelOptions[$key] = $value;
return $this;
}
/**
* Retrieve a single label option
*
* @param $key
* @return mixed|null
*/
public function getLabelOption($key)
{
if (! isset($this->labelOptions[$key])) {
return null;
}
return $this->labelOptions[$key];
}
/**
* Remove a single label option
*
* @param string $key
* @return $this
*/
public function removeLabelOption($key)
{
unset($this->labelOptions[$key]);
return $this;
}
/**
* Does the element has a specific label option ?
*
* @param string $key
* @return bool
*/
public function hasLabelOption($key)
{
return array_key_exists($key, $this->labelOptions);
}
/**
* Set a list of messages to report when validation fails
*
* @param array|Traversable $messages
* @return $this
* @throws Exception\InvalidArgumentException
*/
public function setMessages($messages)
{
if (! is_array($messages) && ! $messages instanceof Traversable) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects an array or Traversable object of validation error messages; received "%s"',
__METHOD__,
is_object($messages) ? get_class($messages) : gettype($messages)
));
}
$this->messages = $messages;
return $this;
}
/**
* Get validation error messages, if any.
*
* Returns a list of validation failure messages, if any.
*
* @return array|Traversable
*/
public function getMessages()
{
return $this->messages;
}
/**
* @return boolean
*/
public function hasValue()
{
return $this->hasValue;
}
}