[TASK] Update php-cs-fixer to 2.5.0
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / SelectViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * This view helper generates a <select> dropdown list for the use with a form.
19 *
20 * = Basic usage =
21 *
22 * The most straightforward way is to supply an associative array as the "options" parameter.
23 * The array key is used as option key, and the value is used as human-readable name.
24 *
25 * <code title="Basic usage">
26 * <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" />
27 * </code>
28 *
29 * = Pre-select a value =
30 *
31 * To pre-select a value, set "value" to the option key which should be selected.
32 * <code title="Default value">
33 * <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" value="visa" />
34 * </code>
35 * Generates a dropdown box like above, except that "VISA Card" is selected.
36 *
37 * If the select box is a multi-select box (multiple="1"), then "value" can be an array as well.
38 *
39 * = Custom options and option group rendering =
40 *
41 * Child nodes can be used to create a completely custom set of ``<option>`` and ``<optgroup>`` tags in a way compatible with
42 * the HMAC generation. To do so, leave out the ``options`` argument and use child ViewHelpers:
43 * <code title="Custom options and optgroup">
44 * <f:form.select name="myproperty">
45 * <f:form.select.option value="1">Option one</f:form.select.option>
46 * <f:form.select.option value="2">Option two</f:form.select.option>
47 * <f:form.select.optgroup>
48 * <f:form.select.option value="3">Grouped option one</f:form.select.option>
49 * <f:form.select.option value="4">Grouped option twi</f:form.select.option>
50 * </f:form.select.optgroup>
51 * </f:form.select>
52 * </code>
53 * Note: do not use vanilla ``<option>`` or ``<optgroup>`` tags! They will invalidate the HMAC generation!
54 *
55 * = Usage on domain objects =
56 *
57 * If you want to output domain objects, you can just pass them as array into the "options" parameter.
58 * To define what domain object value should be used as option key, use the "optionValueField" variable. Same goes for optionLabelField.
59 * If neither is given, the Identifier (UID/uid) and the __toString() method are tried as fallbacks.
60 *
61 * If the optionValueField variable is set, the getter named after that value is used to retrieve the option key.
62 * If the optionLabelField variable is set, the getter named after that value is used to retrieve the option value.
63 *
64 * If the prependOptionLabel variable is set, an option item is added in first position, bearing an empty string or -
65 * If provided, the value of the prependOptionValue variable as value.
66 *
67 * <code title="Domain objects">
68 * <f:form.select name="users" options="{userArray}" optionValueField="id" optionLabelField="firstName" />
69 * </code>
70 * In the above example, the userArray is an array of "User" domain objects, with no array key specified.
71 *
72 * So, in the above example, the method $user->getId() is called to retrieve the key, and $user->getFirstName() to retrieve the displayed value of each entry.
73 *
74 * The "value" property now expects a domain object, and tests for object equivalence.
75 *
76 * @api
77 */
78 class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
79 {
80 /**
81 * @var string
82 */
83 protected $tagName = 'select';
84
85 /**
86 * @var mixed
87 */
88 protected $selectedValue = null;
89
90 /**
91 * Initialize arguments.
92 *
93 * @api
94 */
95 public function initializeArguments()
96 {
97 parent::initializeArguments();
98 $this->registerUniversalTagAttributes();
99 $this->registerTagAttribute('size', 'string', 'Size of input field');
100 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
101 $this->registerArgument('options', 'array', 'Associative array with internal IDs as key, and the values are displayed in the select box. Can be combined with or replaced by child f:form.select.* nodes.');
102 $this->registerArgument('optionsAfterContent', 'boolean', 'If true, places auto-generated option tags after those rendered in the tag content. If false, automatic options come first.', false, false);
103 $this->registerArgument('optionValueField', 'string', 'If specified, will call the appropriate getter on each object to determine the value.');
104 $this->registerArgument('optionLabelField', 'string', 'If specified, will call the appropriate getter on each object to determine the label.');
105 $this->registerArgument('sortByOptionLabel', 'boolean', 'If true, List will be sorted by label.', false, false);
106 $this->registerArgument('selectAllByDefault', 'boolean', 'If specified options are selected if none was set before.', false, false);
107 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
108 $this->registerArgument('prependOptionLabel', 'string', 'If specified, will provide an option at first position with the specified label.');
109 $this->registerArgument('prependOptionValue', 'string', 'If specified, will provide an option at first position with the specified value.');
110 $this->registerArgument('multiple', 'boolean', 'If set multiple options may be selected.', false, false);
111 $this->registerArgument('required', 'boolean', 'If set no empty value is allowed.', false, false);
112 }
113
114 /**
115 * Render the tag.
116 *
117 * @return string rendered tag.
118 * @api
119 */
120 public function render()
121 {
122 if ($this->arguments['required']) {
123 $this->tag->addAttribute('required', 'required');
124 }
125 $name = $this->getName();
126 if ($this->arguments['multiple']) {
127 $this->tag->addAttribute('multiple', 'multiple');
128 $name .= '[]';
129 }
130 $this->tag->addAttribute('name', $name);
131 $options = $this->getOptions();
132
133 $this->addAdditionalIdentityPropertiesIfNeeded();
134 $this->setErrorClassAttribute();
135 $content = '';
136 // register field name for token generation.
137 // in case it is a multi-select, we need to register the field name
138 // as often as there are elements in the box
139 if ($this->arguments['multiple']) {
140 $content .= $this->renderHiddenFieldForEmptyValue();
141 for ($i = 0; $i < count($options); $i++) {
142 $this->registerFieldNameForFormTokenGeneration($name);
143 }
144 // save the parent field name so that any child f:form.select.option
145 // tag will know to call registerFieldNameForFormTokenGeneration
146 $this->viewHelperVariableContainer->addOrUpdate(
147 static::class,
148 'registerFieldNameForFormTokenGeneration',
149 $name
150 );
151 } else {
152 $this->registerFieldNameForFormTokenGeneration($name);
153 }
154
155 $this->viewHelperVariableContainer->addOrUpdate(static::class, 'selectedValue', $this->getSelectedValue());
156 $prependContent = $this->renderPrependOptionTag();
157 $tagContent = $this->renderOptionTags($options);
158 $childContent = $this->renderChildren();
159 $this->viewHelperVariableContainer->remove(static::class, 'selectedValue');
160 $this->viewHelperVariableContainer->remove(static::class, 'registerFieldNameForFormTokenGeneration');
161 if ($this->arguments['optionsAfterContent']) {
162 $tagContent = $childContent . $tagContent;
163 } else {
164 $tagContent .= $childContent;
165 }
166 $tagContent = $prependContent . $tagContent;
167
168 $this->tag->forceClosingTag(true);
169 $this->tag->setContent($tagContent);
170 $content .= $this->tag->render();
171 return $content;
172 }
173
174 /**
175 * Render prepended option tag
176 *
177 * @return string rendered prepended empty option
178 */
179 protected function renderPrependOptionTag()
180 {
181 $output = '';
182 if ($this->hasArgument('prependOptionLabel')) {
183 $value = $this->hasArgument('prependOptionValue') ? $this->arguments['prependOptionValue'] : '';
184 $label = $this->arguments['prependOptionLabel'];
185 $output .= $this->renderOptionTag($value, $label, false) . LF;
186 }
187 return $output;
188 }
189
190 /**
191 * Render the option tags.
192 *
193 * @param array $options the options for the form.
194 * @return string rendered tags.
195 */
196 protected function renderOptionTags($options)
197 {
198 $output = '';
199 foreach ($options as $value => $label) {
200 $isSelected = $this->isSelected($value);
201 $output .= $this->renderOptionTag($value, $label, $isSelected) . LF;
202 }
203 return $output;
204 }
205
206 /**
207 * Render the option tags.
208 *
209 * @return array an associative array of options, key will be the value of the option tag
210 */
211 protected function getOptions()
212 {
213 if (!is_array($this->arguments['options']) && !$this->arguments['options'] instanceof \Traversable) {
214 return [];
215 }
216 $options = [];
217 $optionsArgument = $this->arguments['options'];
218 foreach ($optionsArgument as $key => $value) {
219 if (is_object($value) || is_array($value)) {
220 if ($this->hasArgument('optionValueField')) {
221 $key = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionValueField']);
222 if (is_object($key)) {
223 if (method_exists($key, '__toString')) {
224 $key = (string)$key;
225 } else {
226 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('Identifying value for object of class "' . get_class($value) . '" was an object.', 1247827428);
227 }
228 }
229 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
230 // @todo use $this->persistenceManager->isNewObject() once it is implemented
231 $key = $this->persistenceManager->getIdentifierByObject($value);
232 } elseif (method_exists($value, '__toString')) {
233 $key = (string)$value;
234 } else {
235 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('No identifying value for object of class "' . get_class($value) . '" found.', 1247826696);
236 }
237 if ($this->hasArgument('optionLabelField')) {
238 $value = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionLabelField']);
239 if (is_object($value)) {
240 if (method_exists($value, '__toString')) {
241 $value = (string)$value;
242 } else {
243 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('Label value for object of class "' . get_class($value) . '" was an object without a __toString() method.', 1247827553);
244 }
245 }
246 } elseif (method_exists($value, '__toString')) {
247 $value = (string)$value;
248 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
249 // @todo use $this->persistenceManager->isNewObject() once it is implemented
250 $value = $this->persistenceManager->getIdentifierByObject($value);
251 }
252 }
253 $options[$key] = $value;
254 }
255 if ($this->arguments['sortByOptionLabel']) {
256 asort($options, SORT_LOCALE_STRING);
257 }
258 return $options;
259 }
260
261 /**
262 * Render the option tags.
263 *
264 * @param mixed $value Value to check for
265 * @return bool TRUE if the value should be marked a s selected; FALSE otherwise
266 */
267 protected function isSelected($value)
268 {
269 $selectedValue = $this->getSelectedValue();
270 if ($value === $selectedValue || (string)$value === $selectedValue) {
271 return true;
272 }
273 if ($this->hasArgument('multiple')) {
274 if (is_null($selectedValue) && $this->arguments['selectAllByDefault'] === true) {
275 return true;
276 }
277 if (is_array($selectedValue) && in_array($value, $selectedValue)) {
278 return true;
279 }
280 }
281 return false;
282 }
283
284 /**
285 * Retrieves the selected value(s)
286 *
287 * @return mixed value string or an array of strings
288 */
289 protected function getSelectedValue()
290 {
291 $this->setRespectSubmittedDataValue(true);
292 $value = $this->getValueAttribute();
293 if (!is_array($value) && !$value instanceof \Traversable) {
294 return $this->getOptionValueScalar($value);
295 }
296 $selectedValues = [];
297 foreach ($value as $selectedValueElement) {
298 $selectedValues[] = $this->getOptionValueScalar($selectedValueElement);
299 }
300 return $selectedValues;
301 }
302
303 /**
304 * Get the option value for an object
305 *
306 * @param mixed $valueElement
307 * @return string
308 */
309 protected function getOptionValueScalar($valueElement)
310 {
311 if (is_object($valueElement)) {
312 if ($this->hasArgument('optionValueField')) {
313 return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($valueElement, $this->arguments['optionValueField']);
314 }
315 // @todo use $this->persistenceManager->isNewObject() once it is implemented
316 if ($this->persistenceManager->getIdentifierByObject($valueElement) !== null) {
317 return $this->persistenceManager->getIdentifierByObject($valueElement);
318 }
319 return (string)$valueElement;
320 }
321 return $valueElement;
322 }
323
324 /**
325 * Render one option tag
326 *
327 * @param string $value value attribute of the option tag (will be escaped)
328 * @param string $label content of the option tag (will be escaped)
329 * @param bool $isSelected specifies wheter or not to add selected attribute
330 * @return string the rendered option tag
331 */
332 protected function renderOptionTag($value, $label, $isSelected)
333 {
334 $output = '<option value="' . htmlspecialchars($value) . '"';
335 if ($isSelected) {
336 $output .= ' selected="selected"';
337 }
338 $output .= '>' . htmlspecialchars($label) . '</option>';
339 return $output;
340 }
341 }