[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / TextfieldViewHelper.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 * View Helper which creates a text field (<input type="text">).
19 *
20 * = Examples =
21 *
22 * <code title="Example">
23 * <f:form.textfield name="myTextBox" value="default value" />
24 * </code>
25 * <output>
26 * <input type="text" name="myTextBox" value="default value" />
27 * </output>
28 */
29 class TextfieldViewHelper extends AbstractFormFieldViewHelper
30 {
31 /**
32 * @var string
33 */
34 protected $tagName = 'input';
35
36 /**
37 * Initialize the arguments.
38 *
39 * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
40 */
41 public function initializeArguments()
42 {
43 parent::initializeArguments();
44 $this->registerTagAttribute('autofocus', 'string', 'Specifies that an input should automatically get focus when the page loads');
45 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
46 $this->registerTagAttribute('maxlength', 'int', 'The maxlength attribute of the input field (will not be validated)');
47 $this->registerTagAttribute('readonly', 'string', 'The readonly attribute of the input field');
48 $this->registerTagAttribute('size', 'int', 'The size of the input field');
49 $this->registerTagAttribute('placeholder', 'string', 'The placeholder of the textfield');
50 $this->registerTagAttribute('pattern', 'string', 'HTML5 validation pattern');
51 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
52 $this->registerUniversalTagAttributes();
53 $this->registerArgument('required', 'bool', 'If the field is required or not', false, false);
54 $this->registerArgument('type', 'string', 'The field type, e.g. "text", "email", "url" etc.', false, 'text');
55 }
56
57 /**
58 * Renders the textfield.
59 *
60 * @return string
61 */
62 public function render()
63 {
64 $required = $this->arguments['required'] ?? false;
65 $type = $this->arguments['type'] ?? null;
66
67 $name = $this->getName();
68 $this->registerFieldNameForFormTokenGeneration($name);
69 $this->setRespectSubmittedDataValue(true);
70
71 $this->tag->addAttribute('type', $type);
72 $this->tag->addAttribute('name', $name);
73
74 $value = $this->getValueAttribute();
75
76 if ($value !== null) {
77 $this->tag->addAttribute('value', $value);
78 }
79
80 if ($required !== false) {
81 $this->tag->addAttribute('required', 'required');
82 }
83
84 $this->addAdditionalIdentityPropertiesIfNeeded();
85 $this->setErrorClassAttribute();
86
87 return $this->tag->render();
88 }
89 }