[TASK] Streamline return tags in phpdocs
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / UploadViewHelper.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 * A view helper which generates an <input type="file"> HTML element.
19 * Make sure to set enctype="multipart/form-data" on the form!
20 *
21 * = Examples =
22 *
23 * <code title="Example">
24 * <f:form.upload name="file" />
25 * </code>
26 * <output>
27 * <input type="file" name="file" />
28 * </output>
29 *
30 * @api
31 */
32 class UploadViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
33 {
34 /**
35 * @var string
36 */
37 protected $tagName = 'input';
38
39 /**
40 * Initialize the arguments.
41 *
42 * @api
43 */
44 public function initializeArguments()
45 {
46 parent::initializeArguments();
47 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
48 $this->registerTagAttribute('multiple', 'string', 'Specifies that the file input element should allow multiple selection of files');
49 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
50 $this->registerUniversalTagAttributes();
51 }
52
53 /**
54 * Renders the upload field.
55 *
56 * @return string
57 * @api
58 */
59 public function render()
60 {
61 $name = $this->getName();
62 $allowedFields = ['name', 'type', 'tmp_name', 'error', 'size'];
63 foreach ($allowedFields as $fieldName) {
64 $this->registerFieldNameForFormTokenGeneration($name . '[' . $fieldName . ']');
65 }
66 $this->tag->addAttribute('type', 'file');
67
68 if (isset($this->arguments['multiple'])) {
69 $this->tag->addAttribute('name', $name . '[]');
70 } else {
71 $this->tag->addAttribute('name', $name);
72 }
73
74 $this->setErrorClassAttribute();
75 return $this->tag->render();
76 }
77 }