Add input validation classes (#204)

yiisoft · Jun 7, 2022 · 86ce1f0 · 86ce1f0
1 parent 94344ca
commit 86ce1f0
Show file tree

Hide file tree

Showing 18 changed files with 241 additions and 9 deletions.
diff --git a/src/Field/Base/DateTimeInputField.php b/src/Field/Base/DateTimeInputField.php
@@ -183,4 +183,15 @@ protected function prepareContainerAttributes(array &$attributes): void
             );
         }
     }
+
+    protected function prepareInputAttributes(array &$attributes): void
+    {
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
+    }
 }
diff --git a/src/Field/Base/ValidationClass/ValidationClassInterface.php b/src/Field/Base/ValidationClass/ValidationClassInterface.php
@@ -6,7 +6,11 @@
 
 interface ValidationClassInterface
 {
-    public function invalidClass(string $class): self;
+    public function invalidClass(?string $class): self;
 
-    public function validClass(string $class): self;
+    public function validClass(?string $class): self;
+
+    public function inputInvalidClass(?string $class): self;
+
+    public function inputValidClass(?string $class): self;
 }
diff --git a/src/Field/Base/ValidationClass/ValidationClassTrait.php b/src/Field/Base/ValidationClass/ValidationClassTrait.php
@@ -8,12 +8,14 @@
 use Yiisoft\Html\Html;
 
 /**
- * @psalm-require-extends \Yiisoft\Form\Field\Base\BaseField
+ * @psalm-require-extends \Yiisoft\Form\Field\Base\PartsField
  */
 trait ValidationClassTrait
 {
     private ?string $invalidClass = null;
     private ?string $validClass = null;
+    private ?string $inputInvalidClass = null;
+    private ?string $inputValidClass = null;
 
     /**
      * Set invalid CSS class.
@@ -35,23 +37,73 @@ public function validClass(?string $class): self
         return $new;
     }
 
+    /**
+     * Set invalid CSS class for input tag.
+     */
+    public function inputInvalidClass(?string $class): self
+    {
+        $new = clone $this;
+        $new->inputInvalidClass = $class;
+        return $new;
+    }
+
+    /**
+     * Set valid CSS class for input tag.
+     */
+    public function inputValidClass(?string $class): self
+    {
+        $new = clone $this;
+        $new->inputValidClass = $class;
+        return $new;
+    }
+
     protected function addValidationClassToAttributes(
         array &$attributes,
         FormModelInterface $formModel,
         string $attributeName,
+    ): void {
+        $this->addClassesToAttributes(
+            $attributes,
+            $formModel,
+            $attributeName,
+            $this->invalidClass,
+            $this->validClass,
+        );
+    }
+
+    protected function addInputValidationClassToAttributes(
+        array &$attributes,
+        FormModelInterface $formModel,
+        string $attributeName,
+    ): void {
+        $this->addClassesToAttributes(
+            $attributes,
+            $formModel,
+            $attributeName,
+            $this->inputInvalidClass,
+            $this->inputValidClass,
+        );
+    }
+
+    private function addClassesToAttributes(
+        array &$attributes,
+        FormModelInterface $formModel,
+        string $attributeName,
+        ?string $invalidClass,
+        ?string $validClass,
     ): void {
         if (!$formModel->isValidated()) {
             return;
         }
 
         $hasErrors = $formModel->getFormErrors()->hasErrors($attributeName);
 
-        if ($hasErrors && $this->invalidClass !== null) {
-            Html::addCssClass($attributes, $this->invalidClass);
+        if ($hasErrors && $invalidClass !== null) {
+            Html::addCssClass($attributes, $invalidClass);
         }
 
-        if (!$hasErrors && $this->validClass !== null) {
-            Html::addCssClass($attributes, $this->validClass);
+        if (!$hasErrors && $validClass !== null) {
+            Html::addCssClass($attributes, $validClass);
         }
     }
 }
diff --git a/src/Field/Checkbox.php b/src/Field/Checkbox.php
@@ -289,4 +289,15 @@ protected function prepareContainerAttributes(array &$attributes): void
             );
         }
     }
+
+    protected function prepareInputAttributes(array &$attributes): void
+    {
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
+    }
 }
diff --git a/src/Field/Email.php b/src/Field/Email.php
@@ -260,5 +260,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/File.php b/src/Field/File.php
@@ -204,4 +204,15 @@ protected function prepareContainerAttributes(array &$attributes): void
             );
         }
     }
+
+    protected function prepareInputAttributes(array &$attributes): void
+    {
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
+    }
 }
diff --git a/src/Field/Number.php b/src/Field/Number.php
@@ -212,5 +212,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/Password.php b/src/Field/Password.php
@@ -251,5 +251,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/Range.php b/src/Field/Range.php
@@ -242,4 +242,15 @@ protected function prepareContainerAttributes(array &$attributes): void
             );
         }
     }
+
+    protected function prepareInputAttributes(array &$attributes): void
+    {
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
+    }
 }
diff --git a/src/Field/Select.php b/src/Field/Select.php
@@ -303,4 +303,15 @@ protected function prepareContainerAttributes(array &$attributes): void
             );
         }
     }
+
+    protected function prepareInputAttributes(array &$attributes): void
+    {
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
+    }
 }
diff --git a/src/Field/Telephone.php b/src/Field/Telephone.php
@@ -246,5 +246,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/Text.php b/src/Field/Text.php
@@ -262,5 +262,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/Textarea.php b/src/Field/Textarea.php
@@ -268,5 +268,12 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 }
diff --git a/src/Field/Url.php b/src/Field/Url.php
@@ -260,6 +260,13 @@ protected function prepareContainerAttributes(array &$attributes): void
     protected function prepareInputAttributes(array &$attributes): void
     {
         $this->preparePlaceholderInInputAttributes($attributes);
+        if ($this->hasFormModelAndAttribute()) {
+            $this->addInputValidationClassToAttributes(
+                $attributes,
+                $this->getFormModel(),
+                $this->getFormAttributeName(),
+            );
+        }
     }
 
     private function generateSchemePattern(string $scheme): string

diff --git a/src/FieldFactory.php b/src/FieldFactory.php
@@ -66,6 +66,8 @@ public function __construct(
         private ?bool $usePlaceholder = null,
         private ?string $validClass = null,
         private ?string $invalidClass = null,
+        private ?string $inputValidClass = null,
+        private ?string $inputInvalidClass = null,
         private ?bool $enrichmentFromRules = null,
         private array $fieldConfigs = [],
     ) {
@@ -358,6 +360,12 @@ private function makeFieldConfig(string $class): array
             if ($this->invalidClass !== null) {
                 $config['invalidClass()'] = [$this->invalidClass];
             }
+            if ($this->inputValidClass !== null) {
+                $config['inputValidClass()'] = [$this->inputValidClass];
+            }
+            if ($this->inputInvalidClass !== null) {
+                $config['inputInvalidClass()'] = [$this->inputInvalidClass];
+            }
         }
 
         return $config;

diff --git a/tests/Field/TextTest.php b/tests/Field/TextTest.php
@@ -616,6 +616,43 @@ public function testValidClass(): void
         $this->assertSame($expected, $result);
     }
 
+    public function testInputInvalidClass(): void
+    {
+        $expected = <<<'HTML'
+        <div>
+        <label for="textform-company">Company</label>
+        <input type="text" id="textform-company" class="invalid" name="TextForm[company]" value>
+        <div>Value cannot be blank.</div>
+        </div>
+        HTML;
+
+        $result = Text::widget()
+            ->inputInvalidClass('invalid')
+            ->inputValidClass('valid')
+            ->formAttribute(TextForm::validated(), 'company')
+            ->render();
+
+        $this->assertSame($expected, $result);
+    }
+
+    public function testInputValidClass(): void
+    {
+        $expected = <<<'HTML'
+        <div>
+        <label for="textform-job">Job</label>
+        <input type="text" id="textform-job" class="valid" name="TextForm[job]" value>
+        </div>
+        HTML;
+
+        $result = Text::widget()
+            ->inputInvalidClass('invalid')
+            ->inputValidClass('valid')
+            ->formAttribute(TextForm::validated(), 'job')
+            ->render();
+
+        $this->assertSame($expected, $result);
+    }
+
     public function dataEnrichmentFromRules(): array
     {
         return [

diff --git a/tests/FieldFactoryTest.php b/tests/FieldFactoryTest.php
@@ -234,6 +234,33 @@ public function dataText(): array
                 ],
                 'company',
             ],
+            [
+                <<<'HTML'
+                <div class="wrapper">
+                <label for="textform-job">Job</label>
+                <input type="text" id="textform-job" class="valid" name="TextForm[job]" value>
+                </div>
+                HTML,
+                [
+                    'inputValidClass' => 'valid',
+                    'containerAttributes' => ['class' => 'wrapper'],
+                ],
+                'job',
+            ],
+            [
+                <<<'HTML'
+                <div class="wrapper">
+                <label for="textform-company">Company</label>
+                <input type="text" id="textform-company" class="invalid" name="TextForm[company]" value>
+                <div>Value cannot be blank.</div>
+                </div>
+                HTML,
+                [
+                    'inputInvalidClass' => 'invalid',
+                    'containerAttributes' => ['class' => 'wrapper'],
+                ],
+                'company',
+            ],
             [
                 <<<'HTML'
                 <div>

diff --git a/tests/Support/StubPartsField.php b/tests/Support/StubPartsField.php
@@ -8,7 +8,7 @@
 
 final class StubPartsField extends PartsField
 {
-    private string $inputHtml = '';
+    private ?string $inputHtml = null;
 
     public function setInputHtml(string $html): self
     {
@@ -18,6 +18,6 @@ public function setInputHtml(string $html): self
 
     protected function generateInput(): string
     {
-        return $this->inputHtml;
+        return $this->inputHtml ?? parent::generateInput();
     }
 }