ENH allow stacked messages on FormMessage

silverstripe · Oct 3, 2023 · 8b026c1 · 8b026c1
1 parent 44b1700
commit 8b026c1
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 2 deletions.
diff --git a/src/Forms/Form.php b/src/Forms/Form.php
@@ -494,7 +494,7 @@ public function loadMessagesFrom($result)
                 $owner = $this;
             }
 
-            $owner->setMessage($message['message'], $message['messageType'], $message['messageCast']);
+            $owner->appendMessage($message['message'], $message['messageType'], $message['messageCast']);
         }
         return $this;
     }

diff --git a/src/Forms/FormMessage.php b/src/Forms/FormMessage.php
@@ -31,7 +31,6 @@ trait FormMessage
      */
     protected $messageCast = null;
 
-
     /**
      * Returns the field message, used by form validation.
      *
@@ -92,6 +91,30 @@ public function setMessage(
         return $this;
     }
 
+    /**
+     * Appends a message to the existing message if the types match, overrides if not
+     */
+    public function appendMessage(
+        string $message,
+        string $messageType = ValidationResult::TYPE_ERROR,
+        string $messageCast = ValidationResult::CAST_TEXT,
+    ): static {
+        if (!empty($this->message)) {
+            $canBeMerged = ($messageType === $this->getMessageType() && $messageCast === $this->getMessageCast());
+            // Checks that the exact message string is not already contained before appending
+            if ($canBeMerged && strpos($this->message, $message) === false) {
+                $message = sprintf(
+                    '%s%s%s',
+                    $this->message,
+                    $messageType === ValidationResult::CAST_HTML ? '<br />' : PHP_EOL,
+                    $message
+                );
+            }
+        }
+
+        return $this->setMessage($message, $messageType, $messageCast);
+    }
+
     /**
      * Get casting helper for message cast, or null if not known
      *

diff --git a/tests/php/Forms/FormTest.php b/tests/php/Forms/FormTest.php
@@ -1030,6 +1030,41 @@ public function testFieldMessageEscapeHtml()
         );
     }
 
+    public function testFieldMessageAppend()
+    {
+        $form = $this->getStubForm();
+        $form->appendMessage('Just a string');
+        $parser = new CSSContentParser($form->forTemplate());
+        $messageEls = $parser->getBySelector('.message');
+        $this->assertStringContainsString('Just a string', $messageEls[0]->asXML());
+
+        $form->appendMessage('Certainly different');
+        $parser = new CSSContentParser($form->forTemplate());
+        $messageEls = $parser->getBySelector('.message');
+        $this->assertStringContainsString('Just a string' . PHP_EOL . 'Certainly different', $messageEls[0]->asXML());
+
+        $form->appendMessage('Just a string');
+        $parser = new CSSContentParser($form->forTemplate());
+        $messageEls = $parser->getBySelector('.message');
+        $this->assertStringContainsString('Just a string' . PHP_EOL . 'Certainly different', $messageEls[0]->asXML());
+        $this->assertEquals(1, substr_count($messageEls[0]->asXML(), 'Just a string'), 'Should not append if already present');
+
+        $form->appendMessage('This is a good message', ValidationResult::TYPE_GOOD);
+        $parser = new CSSContentParser($form->forTemplate());
+        $messageEls = $parser->getBySelector('.message');
+        $this->assertStringContainsString('This is a good message', $messageEls[0]->asXML());
+        $this->assertStringNotContainsString('Just a string', $messageEls[0]->asXML());
+        $this->assertStringNotContainsString('Certainly different', $messageEls[0]->asXML());
+
+        $form->appendMessage('HTML is the future of the web', ValidationResult::TYPE_GOOD, ValidationResult::CAST_HTML);
+        $parser = new CSSContentParser($form->forTemplate());
+        $messageEls = $parser->getBySelector('.message');
+        $this->assertStringContainsString('HTML is the future of the web', $messageEls[0]->asXML());
+        $this->assertStringNotContainsString('This is a good message', $messageEls[0]->asXML());
+        $this->assertStringNotContainsString('Just a string', $messageEls[0]->asXML());
+        $this->assertStringNotContainsString('Certainly different', $messageEls[0]->asXML());
+    }
+
     public function testGetExtraFields()
     {
         $form = new FormTest\ExtraFieldsForm(