005664fc1f422782c040e34258fb46d683559005
[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 * @api
30 */
31 class TextfieldViewHelper extends AbstractFormFieldViewHelper
32 {
33 /**
34 * @var string
35 */
36 protected $tagName = 'input';
37
38 /**
39 * Initialize the arguments.
40 *
41 * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
42 * @api
43 */
44 public function initializeArguments()
45 {
46 parent::initializeArguments();
47 $this->registerTagAttribute('autofocus', 'string', 'Specifies that an input should automatically get focus when the page loads');
48 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
49 $this->registerTagAttribute('maxlength', 'int', 'The maxlength attribute of the input field (will not be validated)');
50 $this->registerTagAttribute('readonly', 'string', 'The readonly attribute of the input field');
51 $this->registerTagAttribute('size', 'int', 'The size of the input field');
52 $this->registerTagAttribute('placeholder', 'string', 'The placeholder of the textfield');
53 $this->registerTagAttribute('pattern', 'string', 'HTML5 validation pattern');
54 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
55 $this->registerUniversalTagAttributes();
56 $this->registerArgument('required', 'bool', 'If the field is required or not', false, false);
57 $this->registerArgument('type', 'string', 'The field type, e.g. "text", "email", "url" etc.', false, 'text');
58 }
59
60 /**
61 * Renders the textfield.
62 *
63 * @return string
64 * @api
65 */
66 public function render()
67 {
68 $required = $this->arguments['required'] ?? false;
69 $type = $this->arguments['type'] ?? null;
70
71 $name = $this->getName();
72 $this->registerFieldNameForFormTokenGeneration($name);
73 $this->setRespectSubmittedDataValue(true);
74
75 $this->tag->addAttribute('type', $type);
76 $this->tag->addAttribute('name', $name);
77
78 $value = $this->getValueAttribute();
79
80 if ($value !== null) {
81 $this->tag->addAttribute('value', $value);
82 }
83
84 if ($required !== false) {
85 $this->tag->addAttribute('required', 'required');
86 }
87
88 $this->addAdditionalIdentityPropertiesIfNeeded();
89 $this->setErrorClassAttribute();
90
91 return $this->tag->render();
92 }
93 }