[TASK] Streamline return tags in phpdocs
[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 }
112
113 /**
114 * Render the tag.
115 *
116 * @return string rendered tag.
117 * @api
118 */
119 public function render()
120 {
121 $name = $this->getName();
122 if ($this->arguments['multiple']) {
123 $this->tag->addAttribute('multiple', 'multiple');
124 $name .= '[]';
125 }
126 $this->tag->addAttribute('name', $name);
127 $options = $this->getOptions();
128
129 $this->addAdditionalIdentityPropertiesIfNeeded();
130 $this->setErrorClassAttribute();
131 $content = '';
132 // register field name for token generation.
133 // in case it is a multi-select, we need to register the field name
134 // as often as there are elements in the box
135 if ($this->arguments['multiple']) {
136 $content .= $this->renderHiddenFieldForEmptyValue();
137 for ($i = 0; $i < count($options); $i++) {
138 $this->registerFieldNameForFormTokenGeneration($name);
139 }
140 // save the parent field name so that any child f:form.select.option
141 // tag will know to call registerFieldNameForFormTokenGeneration
142 $this->viewHelperVariableContainer->addOrUpdate(
143 static::class,
144 'registerFieldNameForFormTokenGeneration',
145 $name
146 );
147 } else {
148 $this->registerFieldNameForFormTokenGeneration($name);
149 }
150
151 $this->viewHelperVariableContainer->addOrUpdate(static::class, 'selectedValue', $this->getSelectedValue());
152 $tagContent = $this->renderOptionTags($options);
153 $childContent = $this->renderChildren();
154 $this->viewHelperVariableContainer->remove(static::class, 'selectedValue');
155 $this->viewHelperVariableContainer->remove(static::class, 'registerFieldNameForFormTokenGeneration');
156 if ($this->arguments['optionsAfterContent']) {
157 $tagContent = $childContent . $tagContent;
158 } else {
159 $tagContent .= $childContent;
160 }
161
162 $this->tag->forceClosingTag(true);
163 $this->tag->setContent($tagContent);
164 $content .= $this->tag->render();
165 return $content;
166 }
167
168 /**
169 * Render the option tags.
170 *
171 * @param array $options the options for the form.
172 * @return string rendered tags.
173 */
174 protected function renderOptionTags($options)
175 {
176 $output = '';
177 if ($this->hasArgument('prependOptionLabel')) {
178 $value = $this->hasArgument('prependOptionValue') ? $this->arguments['prependOptionValue'] : '';
179 $label = $this->arguments['prependOptionLabel'];
180 $output .= $this->renderOptionTag($value, $label, false) . LF;
181 }
182 foreach ($options as $value => $label) {
183 $isSelected = $this->isSelected($value);
184 $output .= $this->renderOptionTag($value, $label, $isSelected) . LF;
185 }
186 return $output;
187 }
188
189 /**
190 * Render the option tags.
191 *
192 * @return array an associative array of options, key will be the value of the option tag
193 */
194 protected function getOptions()
195 {
196 if (!is_array($this->arguments['options']) && !$this->arguments['options'] instanceof \Traversable) {
197 return [];
198 }
199 $options = [];
200 $optionsArgument = $this->arguments['options'];
201 foreach ($optionsArgument as $key => $value) {
202 if (is_object($value) || is_array($value)) {
203 if ($this->hasArgument('optionValueField')) {
204 $key = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionValueField']);
205 if (is_object($key)) {
206 if (method_exists($key, '__toString')) {
207 $key = (string)$key;
208 } else {
209 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('Identifying value for object of class "' . get_class($value) . '" was an object.', 1247827428);
210 }
211 }
212 // @todo use $this->persistenceManager->isNewObject() once it is implemented
213 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
214 $key = $this->persistenceManager->getIdentifierByObject($value);
215 } elseif (method_exists($value, '__toString')) {
216 $key = (string)$value;
217 } else {
218 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('No identifying value for object of class "' . get_class($value) . '" found.', 1247826696);
219 }
220 if ($this->hasArgument('optionLabelField')) {
221 $value = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionLabelField']);
222 if (is_object($value)) {
223 if (method_exists($value, '__toString')) {
224 $value = (string)$value;
225 } else {
226 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);
227 }
228 }
229 } elseif (method_exists($value, '__toString')) {
230 $value = (string)$value;
231 // @todo use $this->persistenceManager->isNewObject() once it is implemented
232 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
233 $value = $this->persistenceManager->getIdentifierByObject($value);
234 }
235 }
236 $options[$key] = $value;
237 }
238 if ($this->arguments['sortByOptionLabel']) {
239 asort($options, SORT_LOCALE_STRING);
240 }
241 return $options;
242 }
243
244 /**
245 * Render the option tags.
246 *
247 * @param mixed $value Value to check for
248 * @return bool TRUE if the value should be marked a s selected; FALSE otherwise
249 */
250 protected function isSelected($value)
251 {
252 $selectedValue = $this->getSelectedValue();
253 if ($value === $selectedValue || (string)$value === $selectedValue) {
254 return true;
255 }
256 if ($this->hasArgument('multiple')) {
257 if (is_null($selectedValue) && $this->arguments['selectAllByDefault'] === true) {
258 return true;
259 } elseif (is_array($selectedValue) && in_array($value, $selectedValue)) {
260 return true;
261 }
262 }
263 return false;
264 }
265
266 /**
267 * Retrieves the selected value(s)
268 *
269 * @return mixed value string or an array of strings
270 */
271 protected function getSelectedValue()
272 {
273 $this->setRespectSubmittedDataValue(true);
274 $value = $this->getValueAttribute();
275 if (!is_array($value) && !$value instanceof \Traversable) {
276 return $this->getOptionValueScalar($value);
277 }
278 $selectedValues = [];
279 foreach ($value as $selectedValueElement) {
280 $selectedValues[] = $this->getOptionValueScalar($selectedValueElement);
281 }
282 return $selectedValues;
283 }
284
285 /**
286 * Get the option value for an object
287 *
288 * @param mixed $valueElement
289 * @return string
290 */
291 protected function getOptionValueScalar($valueElement)
292 {
293 if (is_object($valueElement)) {
294 if ($this->hasArgument('optionValueField')) {
295 return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($valueElement, $this->arguments['optionValueField']);
296 } else {
297 // @todo use $this->persistenceManager->isNewObject() once it is implemented
298 if ($this->persistenceManager->getIdentifierByObject($valueElement) !== null) {
299 return $this->persistenceManager->getIdentifierByObject($valueElement);
300 } else {
301 return (string)$valueElement;
302 }
303 }
304 } else {
305 return $valueElement;
306 }
307 }
308
309 /**
310 * Render one option tag
311 *
312 * @param string $value value attribute of the option tag (will be escaped)
313 * @param string $label content of the option tag (will be escaped)
314 * @param bool $isSelected specifies wheter or not to add selected attribute
315 * @return string the rendered option tag
316 */
317 protected function renderOptionTag($value, $label, $isSelected)
318 {
319 $output = '<option value="' . htmlspecialchars($value) . '"';
320 if ($isSelected) {
321 $output .= ' selected="selected"';
322 }
323 $output .= '>' . htmlspecialchars($label) . '</option>';
324 return $output;
325 }
326 }