forked from zendframework/zendframework
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FormMultiCheckbox.php
475 lines (413 loc) · 12.9 KB
/
FormMultiCheckbox.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
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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\View\Helper;
use Zend\Form\ElementInterface;
use Zend\Form\Element\MultiCheckbox as MultiCheckboxElement;
use Zend\Form\Exception;
use Zend\Form\LabelAwareInterface;
class FormMultiCheckbox extends FormInput
{
const LABEL_APPEND = 'append';
const LABEL_PREPEND = 'prepend';
/**
* The attributes applied to option label
*
* @var array
*/
protected $labelAttributes;
/**
* Where will be label rendered?
*
* @var string
*/
protected $labelPosition = self::LABEL_APPEND;
/**
* Separator for checkbox elements
*
* @var string
*/
protected $separator = '';
/**
* Prefixing the element with a hidden element for the unset value?
*
* @var bool
*/
protected $useHiddenElement = false;
/**
* The unchecked value used when "UseHiddenElement" is turned on
*
* @var string
*/
protected $uncheckedValue = '';
/**
* Form input helper instance
*
* @var FormInput
*/
protected $inputHelper;
/**
* Form label helper instance
*
* @var FormLabel
*/
protected $labelHelper;
/**
* Invoke helper as functor
*
* Proxies to {@link render()}.
*
* @param ElementInterface|null $element
* @param null|string $labelPosition
* @return string|FormMultiCheckbox
*/
public function __invoke(ElementInterface $element = null, $labelPosition = null)
{
if (!$element) {
return $this;
}
if ($labelPosition !== null) {
$this->setLabelPosition($labelPosition);
}
return $this->render($element);
}
/**
* Render a form <input> element from the provided $element
*
* @param ElementInterface $element
* @throws Exception\InvalidArgumentException
* @throws Exception\DomainException
* @return string
*/
public function render(ElementInterface $element)
{
if (!$element instanceof MultiCheckboxElement) {
throw new Exception\InvalidArgumentException(sprintf(
'%s requires that the element is of type Zend\Form\Element\MultiCheckbox',
__METHOD__
));
}
$name = static::getName($element);
$options = $element->getValueOptions();
if (empty($options)) {
throw new Exception\DomainException(sprintf(
'%s requires that the element has "value_options"; none found',
__METHOD__
));
}
$attributes = $element->getAttributes();
$attributes['name'] = $name;
$attributes['type'] = $this->getInputType();
$selectedOptions = (array) $element->getValue();
$rendered = $this->renderOptions($element, $options, $selectedOptions, $attributes);
// Render hidden element
$useHiddenElement = method_exists($element, 'useHiddenElement') && $element->useHiddenElement()
? $element->useHiddenElement()
: $this->useHiddenElement;
if ($useHiddenElement) {
$rendered = $this->renderHiddenElement($element, $attributes) . $rendered;
}
return $rendered;
}
/**
* Render options
*
* @param MultiCheckboxElement $element
* @param array $options
* @param array $selectedOptions
* @param array $attributes
* @return string
*/
protected function renderOptions(MultiCheckboxElement $element, array $options, array $selectedOptions,
array $attributes)
{
$escapeHtmlHelper = $this->getEscapeHtmlHelper();
$labelHelper = $this->getLabelHelper();
$labelClose = $labelHelper->closeTag();
$labelPosition = $this->getLabelPosition();
$globalLabelAttributes = array();
$closingBracket = $this->getInlineClosingBracket();
if ($element instanceof LabelAwareInterface) {
$globalLabelAttributes = $element->getLabelAttributes();
}
if (empty($globalLabelAttributes)) {
$globalLabelAttributes = $this->labelAttributes;
}
$combinedMarkup = array();
$count = 0;
foreach ($options as $key => $optionSpec) {
$count++;
if ($count > 1 && array_key_exists('id', $attributes)) {
unset($attributes['id']);
}
$value = '';
$label = '';
$inputAttributes = $attributes;
$labelAttributes = $globalLabelAttributes;
$selected = isset($inputAttributes['selected']) && $inputAttributes['type'] != 'radio' && $inputAttributes['selected'] != false ? true : false;
$disabled = isset($inputAttributes['disabled']) && $inputAttributes['disabled'] != false ? true : false;
if (is_scalar($optionSpec)) {
$optionSpec = array(
'label' => $optionSpec,
'value' => $key
);
}
if (isset($optionSpec['value'])) {
$value = $optionSpec['value'];
}
if (isset($optionSpec['label'])) {
$label = $optionSpec['label'];
}
if (isset($optionSpec['selected'])) {
$selected = $optionSpec['selected'];
}
if (isset($optionSpec['disabled'])) {
$disabled = $optionSpec['disabled'];
}
if (isset($optionSpec['label_attributes'])) {
$labelAttributes = (isset($labelAttributes))
? array_merge($labelAttributes, $optionSpec['label_attributes'])
: $optionSpec['label_attributes'];
}
if (isset($optionSpec['attributes'])) {
$inputAttributes = array_merge($inputAttributes, $optionSpec['attributes']);
}
if (in_array($value, $selectedOptions)) {
$selected = true;
}
$inputAttributes['value'] = $value;
$inputAttributes['checked'] = $selected;
$inputAttributes['disabled'] = $disabled;
$input = sprintf(
'<input %s%s',
$this->createAttributesString($inputAttributes),
$closingBracket
);
if (null !== ($translator = $this->getTranslator())) {
$label = $translator->translate(
$label, $this->getTranslatorTextDomain()
);
}
if (! $element instanceof LabelAwareInterface || ! $element->getLabelOption('disable_html_escape')) {
$label = $escapeHtmlHelper($label);
}
$labelOpen = $labelHelper->openTag($labelAttributes);
$template = $labelOpen . '%s%s' . $labelClose;
switch ($labelPosition) {
case self::LABEL_PREPEND:
$markup = sprintf($template, $label, $input);
break;
case self::LABEL_APPEND:
default:
$markup = sprintf($template, $input, $label);
break;
}
$combinedMarkup[] = $markup;
}
return implode($this->getSeparator(), $combinedMarkup);
}
/**
* Render a hidden element for empty/unchecked value
*
* @param MultiCheckboxElement $element
* @param array $attributes
* @return string
*/
protected function renderHiddenElement(MultiCheckboxElement $element, array $attributes)
{
$closingBracket = $this->getInlineClosingBracket();
$uncheckedValue = $element->getUncheckedValue()
? $element->getUncheckedValue()
: $this->uncheckedValue;
$hiddenAttributes = array(
'name' => $element->getName(),
'value' => $uncheckedValue,
);
return sprintf(
'<input type="hidden" %s%s',
$this->createAttributesString($hiddenAttributes),
$closingBracket
);
}
/**
* Sets the attributes applied to option label.
*
* @param array|null $attributes
* @return FormMultiCheckbox
*/
public function setLabelAttributes($attributes)
{
$this->labelAttributes = $attributes;
return $this;
}
/**
* Returns the attributes applied to each option label.
*
* @return array|null
*/
public function getLabelAttributes()
{
return $this->labelAttributes;
}
/**
* Set value for labelPosition
*
* @param mixed $labelPosition
* @throws Exception\InvalidArgumentException
* @return FormMultiCheckbox
*/
public function setLabelPosition($labelPosition)
{
$labelPosition = strtolower($labelPosition);
if (!in_array($labelPosition, array(self::LABEL_APPEND, self::LABEL_PREPEND))) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects either %s::LABEL_APPEND or %s::LABEL_PREPEND; received "%s"',
__METHOD__,
__CLASS__,
__CLASS__,
(string) $labelPosition
));
}
$this->labelPosition = $labelPosition;
return $this;
}
/**
* Get position of label
*
* @return string
*/
public function getLabelPosition()
{
return $this->labelPosition;
}
/**
* Set separator string for checkbox elements
*
* @param string $separator
* @return FormMultiCheckbox
*/
public function setSeparator($separator)
{
$this->separator = (string) $separator;
return $this;
}
/**
* Get separator for checkbox elements
*
* @return string
*/
public function getSeparator()
{
return $this->separator;
}
/**
* Sets the option for prefixing the element with a hidden element
* for the unset value.
*
* @param bool $useHiddenElement
* @return FormMultiCheckbox
*/
public function setUseHiddenElement($useHiddenElement)
{
$this->useHiddenElement = (bool) $useHiddenElement;
return $this;
}
/**
* Returns the option for prefixing the element with a hidden element
* for the unset value.
*
* @return bool
*/
public function getUseHiddenElement()
{
return $this->useHiddenElement;
}
/**
* Sets the unchecked value used when "UseHiddenElement" is turned on.
*
* @param bool $value
* @return FormMultiCheckbox
*/
public function setUncheckedValue($value)
{
$this->uncheckedValue = $value;
return $this;
}
/**
* Returns the unchecked value used when "UseHiddenElement" is turned on.
*
* @return string
*/
public function getUncheckedValue()
{
return $this->uncheckedValue;
}
/**
* Return input type
*
* @return string
*/
protected function getInputType()
{
return 'checkbox';
}
/**
* Get element name
*
* @param ElementInterface $element
* @throws Exception\DomainException
* @return string
*/
protected static function getName(ElementInterface $element)
{
$name = $element->getName();
if ($name === null || $name === '') {
throw new Exception\DomainException(sprintf(
'%s requires that the element has an assigned name; none discovered',
__METHOD__
));
}
return $name . '[]';
}
/**
* Retrieve the FormInput helper
*
* @return FormInput
*/
protected function getInputHelper()
{
if ($this->inputHelper) {
return $this->inputHelper;
}
if (method_exists($this->view, 'plugin')) {
$this->inputHelper = $this->view->plugin('form_input');
}
if (!$this->inputHelper instanceof FormInput) {
$this->inputHelper = new FormInput();
}
return $this->inputHelper;
}
/**
* Retrieve the FormLabel helper
*
* @return FormLabel
*/
protected function getLabelHelper()
{
if ($this->labelHelper) {
return $this->labelHelper;
}
if (method_exists($this->view, 'plugin')) {
$this->labelHelper = $this->view->plugin('form_label');
}
if (!$this->labelHelper instanceof FormLabel) {
$this->labelHelper = new FormLabel();
}
return $this->labelHelper;
}
}