Add to textarea stringable and array of strings value support (#360)

yiisoft · Aug 23, 2024 · 0e34d0e · 0e34d0e
1 parent 16fefb3
commit 0e34d0e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
     "require": {
         "php": "^8.1",
         "yiisoft/friendly-exception": "^1.0",
-        "yiisoft/html": "^3.5",
+        "yiisoft/html": "^3.6",
         "yiisoft/widget": "^2.2"
     },
     "require-dev": {

diff --git a/src/Field/Textarea.php b/src/Field/Textarea.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\Form\Field;
 
 use InvalidArgumentException;
+use Stringable;
 use Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesInterface;
 use Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesTrait;
 use Yiisoft\Form\Field\Base\InputField;
@@ -228,8 +229,15 @@ protected function generateInput(): string
     {
         $value = $this->getValue();
 
-        if (!is_string($value) && $value !== null) {
-            throw new InvalidArgumentException('Textarea field requires a string or null value.');
+        if (!(
+            is_string($value)
+            || is_array($value)
+            || $value instanceof Stringable
+            || $value === null
+        )) {
+            throw new InvalidArgumentException(
+                'Textarea field requires a string, a stringable object, an array of strings or null value.'
+            );
         }
 
         /** @psalm-suppress MixedArgument We guess that enrichment contain correct values. */
@@ -238,6 +246,9 @@ protected function generateInput(): string
             $this->getInputAttributes()
         );
 
+        /**
+         * @var string|string[]|Stringable|null $value We guess that array value is array of strings.
+         */
         return Html::textarea($this->getName(), $value, $textareaAttributes)->render();
     }
 

diff --git a/tests/Field/TextareaTest.php b/tests/Field/TextareaTest.php
@@ -11,6 +11,7 @@
 use Yiisoft\Form\PureField\InputData;
 use Yiisoft\Form\Tests\Support\NullValidationRulesEnricher;
 use Yiisoft\Form\Tests\Support\RequiredValidationRulesEnricher;
+use Yiisoft\Form\Tests\Support\StringableObject;
 use Yiisoft\Form\Tests\Support\StubValidationRulesEnricher;
 use Yiisoft\Form\Theme\ThemeContainer;
 
@@ -34,6 +35,24 @@ public static function dataBase(): array
                 HTML,
                 new InputData('desc', id: 'test-id', label: 'Description'),
             ],
+            'stringable-value' => [
+                <<<HTML
+                <div>
+                <textarea name="desc">test</textarea>
+                </div>
+                HTML,
+                new InputData('desc', new StringableObject('test')),
+            ],
+            'array-of-strings-value' => [
+                <<<HTML
+                <div>
+                <textarea name="desc">a
+                b
+                c</textarea>
+                </div>
+                HTML,
+                new InputData('desc', ['a', 'b', 'c']),
+            ],
             'input-valid-class' => [
                 <<<HTML
                 <div>
@@ -299,7 +318,9 @@ public function testInvalidValue(): void
         $widget = Textarea::widget()->value(7);
 
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Textarea field requires a string or null value.');
+        $this->expectExceptionMessage(
+            'Textarea field requires a string, a stringable object, an array of strings or null value.'
+        );
         $widget->render();
     }