[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / TextareaViewHelper.php
index ceccd6f..57e3f90 100644 (file)
@@ -1,15 +1,19 @@
 <?php
 namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 
-/*                                                                        *
- * This script is backported from the FLOW3 package "TYPO3.Fluid".        *
- *                                                                        *
- * It is free software; you can redistribute it and/or modify it under    *
- * the terms of the GNU Lesser General Public License, either version 3   *
- *  of the License, or (at your option) any later version.                *
- *                                                                        *
- * The TYPO3 project - inspiring people to share!                         *
- *                                                                        */
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
 /**
  * Textarea view helper.
  * The value of the text area needs to be set via the "value" attribute, as with all other form ViewHelpers.
@@ -22,48 +26,52 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <textarea name="myTextArea">This is shown inside the textarea</textarea>
  * </output>
- *
- * @api
  */
-class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper {
+class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
+{
+    /**
+     * @var string
+     */
+    protected $tagName = 'textarea';
 
-       /**
-        * @var string
-        */
-       protected $tagName = 'textarea';
+    /**
+     * Initialize the arguments.
+     */
+    public function initializeArguments()
+    {
+        parent::initializeArguments();
+        $this->registerTagAttribute('autofocus', 'string', 'Specifies that a text area should automatically get focus when the page loads');
+        $this->registerTagAttribute('rows', 'int', 'The number of rows of a text area');
+        $this->registerTagAttribute('cols', 'int', 'The number of columns of a text area');
+        $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
+        $this->registerTagAttribute('placeholder', 'string', 'The placeholder of the textarea');
+        $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', false, 'f3-form-error');
+        $this->registerTagAttribute('readonly', 'string', 'The readonly attribute of the textarea', false);
+        $this->registerArgument('required', 'bool', 'Specifies whether the textarea is required', false, false);
+        $this->registerUniversalTagAttributes();
+    }
 
-       /**
-        * Initialize the arguments.
-        *
-        * @return void
-        * @api
-        */
-       public function initializeArguments() {
-               parent::initializeArguments();
-               $this->registerTagAttribute('rows', 'int', 'The number of rows of a text area', TRUE);
-               $this->registerTagAttribute('cols', 'int', 'The number of columns of a text area', TRUE);
-               $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
-               $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this view helper', FALSE, 'f3-form-error');
-               $this->registerUniversalTagAttributes();
-       }
+    /**
+     * Renders the textarea.
+     *
+     * @return string
+     */
+    public function render()
+    {
+        $required = $this->arguments['required'] ?? false;
+        $name = $this->getName();
+        $this->registerFieldNameForFormTokenGeneration($name);
+        $this->setRespectSubmittedDataValue(true);
 
-       /**
-        * Renders the textarea.
-        *
-        * @return string
-        * @api
-        */
-       public function render() {
-               $name = $this->getName();
-               $this->registerFieldNameForFormTokenGeneration($name);
-               $this->tag->forceClosingTag(TRUE);
-               $this->tag->addAttribute('name', $name);
-               $this->tag->setContent(htmlspecialchars($this->getValue()));
-               $this->setErrorClassAttribute();
-               return $this->tag->render();
-       }
+        $this->tag->forceClosingTag(true);
+        $this->tag->addAttribute('name', $name);
+        if ($required === true) {
+            $this->tag->addAttribute('required', 'required');
+        }
+        $this->tag->setContent(htmlspecialchars($this->getValueAttribute()));
+        $this->addAdditionalIdentityPropertiesIfNeeded();
+        $this->setErrorClassAttribute();
 
+        return $this->tag->render();
+    }
 }
-
-
-?>
\ No newline at end of file