[TASK] Streamline phpdoc annotations in EXT:fluid
[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 class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
77 {
78 /**
79 * @var string
80 */
81 protected $tagName = 'select';
82
83 /**
84 * @var mixed
85 */
86 protected $selectedValue;
87
88 /**
89 * Initialize arguments.
90 */
91 public function initializeArguments()
92 {
93 parent::initializeArguments();
94 $this->registerUniversalTagAttributes();
95 $this->registerTagAttribute('size', 'string', 'Size of input field');
96 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
97 $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.');
98 $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);
99 $this->registerArgument('optionValueField', 'string', 'If specified, will call the appropriate getter on each object to determine the value.');
100 $this->registerArgument('optionLabelField', 'string', 'If specified, will call the appropriate getter on each object to determine the label.');
101 $this->registerArgument('sortByOptionLabel', 'boolean', 'If true, List will be sorted by label.', false, false);
102 $this->registerArgument('selectAllByDefault', 'boolean', 'If specified options are selected if none was set before.', false, false);
103 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
104 $this->registerArgument('prependOptionLabel', 'string', 'If specified, will provide an option at first position with the specified label.');
105 $this->registerArgument('prependOptionValue', 'string', 'If specified, will provide an option at first position with the specified value.');
106 $this->registerArgument('multiple', 'boolean', 'If set multiple options may be selected.', false, false);
107 $this->registerArgument('required', 'boolean', 'If set no empty value is allowed.', false, false);
108 }
109
110 /**
111 * Render the tag.
112 *
113 * @return string rendered tag.
114 */
115 public function render()
116 {
117 if (isset($this->arguments['required']) && $this->arguments['required']) {
118 $this->tag->addAttribute('required', 'required');
119 }
120 $name = $this->getName();
121 if (isset($this->arguments['multiple']) && $this->arguments['multiple']) {
122 $this->tag->addAttribute('multiple', 'multiple');
123 $name .= '[]';
124 }
125 $this->tag->addAttribute('name', $name);
126 $options = $this->getOptions();
127
128 $this->addAdditionalIdentityPropertiesIfNeeded();
129 $this->setErrorClassAttribute();
130 $content = '';
131 // register field name for token generation.
132 // in case it is a multi-select, we need to register the field name
133 // as often as there are elements in the box
134 if (isset($this->arguments['multiple']) && $this->arguments['multiple']) {
135 $content .= $this->renderHiddenFieldForEmptyValue();
136 $optionsCount = count($options);
137 for ($i = 0; $i < $optionsCount; $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 $prependContent = $this->renderPrependOptionTag();
153 $tagContent = $this->renderOptionTags($options);
154 $childContent = $this->renderChildren();
155 $this->viewHelperVariableContainer->remove(static::class, 'selectedValue');
156 $this->viewHelperVariableContainer->remove(static::class, 'registerFieldNameForFormTokenGeneration');
157 if (isset($this->arguments['optionsAfterContent']) && $this->arguments['optionsAfterContent']) {
158 $tagContent = $childContent . $tagContent;
159 } else {
160 $tagContent .= $childContent;
161 }
162 $tagContent = $prependContent . $tagContent;
163
164 $this->tag->forceClosingTag(true);
165 $this->tag->setContent($tagContent);
166 $content .= $this->tag->render();
167 return $content;
168 }
169
170 /**
171 * Render prepended option tag
172 *
173 * @return string rendered prepended empty option
174 */
175 protected function renderPrependOptionTag()
176 {
177 $output = '';
178 if ($this->hasArgument('prependOptionLabel')) {
179 $value = $this->hasArgument('prependOptionValue') ? $this->arguments['prependOptionValue'] : '';
180 $label = $this->arguments['prependOptionLabel'];
181 $output .= $this->renderOptionTag($value, $label, false) . LF;
182 }
183 return $output;
184 }
185
186 /**
187 * Render the option tags.
188 *
189 * @param array $options the options for the form.
190 * @return string rendered tags.
191 */
192 protected function renderOptionTags($options)
193 {
194 $output = '';
195 foreach ($options as $value => $label) {
196 $isSelected = $this->isSelected($value);
197 $output .= $this->renderOptionTag($value, $label, $isSelected) . LF;
198 }
199 return $output;
200 }
201
202 /**
203 * Render the option tags.
204 *
205 * @return array an associative array of options, key will be the value of the option tag
206 */
207 protected function getOptions()
208 {
209 if (!is_array($this->arguments['options']) && !$this->arguments['options'] instanceof \Traversable) {
210 return [];
211 }
212 $options = [];
213 $optionsArgument = $this->arguments['options'];
214 foreach ($optionsArgument as $key => $value) {
215 if (is_object($value) || is_array($value)) {
216 if ($this->hasArgument('optionValueField')) {
217 $key = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionValueField']);
218 if (is_object($key)) {
219 if (method_exists($key, '__toString')) {
220 $key = (string)$key;
221 } else {
222 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('Identifying value for object of class "' . get_class($value) . '" was an object.', 1247827428);
223 }
224 }
225 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
226 // @todo use $this->persistenceManager->isNewObject() once it is implemented
227 $key = $this->persistenceManager->getIdentifierByObject($value);
228 } elseif (method_exists($value, '__toString')) {
229 $key = (string)$value;
230 } else {
231 throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception('No identifying value for object of class "' . get_class($value) . '" found.', 1247826696);
232 }
233 if ($this->hasArgument('optionLabelField')) {
234 $value = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionLabelField']);
235 if (is_object($value)) {
236 if (method_exists($value, '__toString')) {
237 $value = (string)$value;
238 } else {
239 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);
240 }
241 }
242 } elseif (method_exists($value, '__toString')) {
243 $value = (string)$value;
244 } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {
245 // @todo use $this->persistenceManager->isNewObject() once it is implemented
246 $value = $this->persistenceManager->getIdentifierByObject($value);
247 }
248 }
249 $options[$key] = $value;
250 }
251 if ($this->arguments['sortByOptionLabel']) {
252 asort($options, SORT_LOCALE_STRING);
253 }
254 return $options;
255 }
256
257 /**
258 * Render the option tags.
259 *
260 * @param mixed $value Value to check for
261 * @return bool TRUE if the value should be marked a s selected; FALSE otherwise
262 */
263 protected function isSelected($value)
264 {
265 $selectedValue = $this->getSelectedValue();
266 if ($value === $selectedValue || (string)$value === $selectedValue) {
267 return true;
268 }
269 if ($this->hasArgument('multiple')) {
270 if ($selectedValue === null && $this->arguments['selectAllByDefault'] === true) {
271 return true;
272 }
273 if (is_array($selectedValue) && in_array($value, $selectedValue)) {
274 return true;
275 }
276 }
277 return false;
278 }
279
280 /**
281 * Retrieves the selected value(s)
282 *
283 * @return mixed value string or an array of strings
284 */
285 protected function getSelectedValue()
286 {
287 $this->setRespectSubmittedDataValue(true);
288 $value = $this->getValueAttribute();
289 if (!is_array($value) && !$value instanceof \Traversable) {
290 return $this->getOptionValueScalar($value);
291 }
292 $selectedValues = [];
293 foreach ($value as $selectedValueElement) {
294 $selectedValues[] = $this->getOptionValueScalar($selectedValueElement);
295 }
296 return $selectedValues;
297 }
298
299 /**
300 * Get the option value for an object
301 *
302 * @param mixed $valueElement
303 * @return string
304 */
305 protected function getOptionValueScalar($valueElement)
306 {
307 if (is_object($valueElement)) {
308 if ($this->hasArgument('optionValueField')) {
309 return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($valueElement, $this->arguments['optionValueField']);
310 }
311 // @todo use $this->persistenceManager->isNewObject() once it is implemented
312 if ($this->persistenceManager->getIdentifierByObject($valueElement) !== null) {
313 return $this->persistenceManager->getIdentifierByObject($valueElement);
314 }
315 return (string)$valueElement;
316 }
317 return $valueElement;
318 }
319
320 /**
321 * Render one option tag
322 *
323 * @param string $value value attribute of the option tag (will be escaped)
324 * @param string $label content of the option tag (will be escaped)
325 * @param bool $isSelected specifies wheter or not to add selected attribute
326 * @return string the rendered option tag
327 */
328 protected function renderOptionTag($value, $label, $isSelected)
329 {
330 $output = '<option value="' . htmlspecialchars($value) . '"';
331 if ($isSelected) {
332 $output .= ' selected="selected"';
333 }
334 $output .= '>' . htmlspecialchars($label) . '</option>';
335 return $output;
336 }
337 }