[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / TextareaViewHelper.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 * Textarea view helper.
19 * The value of the text area needs to be set via the "value" attribute, as with all other form ViewHelpers.
20 *
21 * = Examples =
22 *
23 * <code title="Example">
24 * <f:form.textarea name="myTextArea" value="This is shown inside the textarea" />
25 * </code>
26 * <output>
27 * <textarea name="myTextArea">This is shown inside the textarea</textarea>
28 * </output>
29 */
30 class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
31 {
32 /**
33 * @var string
34 */
35 protected $tagName = 'textarea';
36
37 /**
38 * Initialize the arguments.
39 */
40 public function initializeArguments()
41 {
42 parent::initializeArguments();
43 $this->registerTagAttribute('autofocus', 'string', 'Specifies that a text area should automatically get focus when the page loads');
44 $this->registerTagAttribute('rows', 'int', 'The number of rows of a text area');
45 $this->registerTagAttribute('cols', 'int', 'The number of columns of a text area');
46 $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
47 $this->registerTagAttribute('placeholder', 'string', 'The placeholder of the textarea');
48 $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
49 $this->registerTagAttribute('readonly', 'string', 'The readonly attribute of the textarea', false);
50 $this->registerArgument('required', 'bool', 'Specifies whether the textarea is required', false, false);
51 $this->registerUniversalTagAttributes();
52 }
53
54 /**
55 * Renders the textarea.
56 *
57 * @return string
58 */
59 public function render()
60 {
61 $required = $this->arguments['required'] ?? false;
62 $name = $this->getName();
63 $this->registerFieldNameForFormTokenGeneration($name);
64 $this->setRespectSubmittedDataValue(true);
65
66 $this->tag->forceClosingTag(true);
67 $this->tag->addAttribute('name', $name);
68 if ($required === true) {
69 $this->tag->addAttribute('required', 'required');
70 }
71 $this->tag->setContent(htmlspecialchars($this->getValueAttribute()));
72 $this->addAdditionalIdentityPropertiesIfNeeded();
73 $this->setErrorClassAttribute();
74
75 return $this->tag->render();
76 }
77 }