Add ErrorSummary::onlyCommonErrors() (#268)

yiisoft · Nov 15, 2023 · f9c79fa · f9c79fa
1 parent 52f2024
commit f9c79fa
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/src/Field/ErrorSummary.php b/src/Field/ErrorSummary.php
@@ -65,6 +65,16 @@ public function onlyAttributes(string ...$names): self
         return $new;
     }
 
+    /**
+     * Use only common errors when rendering the error summary.
+     */
+    public function onlyCommonErrors(): self
+    {
+        $new = clone $this;
+        $new->onlyAttributes = [''];
+        return $new;
+    }
+
     /**
      * Set the footer text for the error summary
      */

diff --git a/tests/Field/ErrorSummaryTest.php b/tests/Field/ErrorSummaryTest.php
@@ -89,6 +89,32 @@ public function testShowAllErrors(): void
         $this->assertSame($expected, $result);
     }
 
+    public function testOnlyCommonErrors(): void
+    {
+        $form = ErrorSummaryForm::validated();
+        $form->getValidationResult()
+            ->addError('Common error 1')
+            ->addError('Common error 2');
+
+        $result = ErrorSummary::widget()
+            ->formModel($form)
+            ->onlyCommonErrors()
+            ->showAllErrors()
+            ->render();
+
+        $expected = <<<HTML
+            <div>
+            <p>Please fix the following errors:</p>
+            <ul>
+            <li>Common error 1</li>
+            <li>Common error 2</li>
+            </ul>
+            </div>
+            HTML;
+
+        $this->assertSame($expected, $result);
+    }
+
     public function testFooter(): void
     {
         $result = ErrorSummary::widget()
@@ -149,6 +175,7 @@ public function testImmutability(): void
         $this->assertNotSame($field, $field->encode(false));
         $this->assertNotSame($field, $field->showAllErrors());
         $this->assertNotSame($field, $field->onlyAttributes());
+        $this->assertNotSame($field, $field->onlyCommonErrors());
         $this->assertNotSame($field, $field->header(''));
         $this->assertNotSame($field, $field->headerAttributes([]));
         $this->assertNotSame($field, $field->footer(''));