[TASK] Initialize validator messages before validation

This allows more flexibility for the messages initialization; for instance you can dynamically build the messages list in the method `initializeObject()` of your validator, then they will be processed just before the validation actually runs.
romm · Aug 11, 2017 · 0be97eb · 0be97eb
1 parent 2c4763f
commit 0be97eb
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/Classes/Validation/Validator/AbstractValidator.php b/Classes/Validation/Validator/AbstractValidator.php
@@ -20,6 +20,7 @@
 use Romm\Formz\Form\FormInterface;
 use Romm\Formz\Service\MessageService;
 use Romm\Formz\Validation\DataObject\ValidatorDataObject;
+use TYPO3\CMS\Extbase\Error\Result;
 
 abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
 {
@@ -96,11 +97,31 @@ final public function __construct(array $options = [], ValidatorDataObject $data
 
         $this->dataObject = $dataObject;
         $this->form = $dataObject->getFormObject()->getForm();
+    }
+
+    /**
+     * @param mixed $value
+     * @return Result
+     */
+    public function validate($value)
+    {
+        /*
+         * Messages are initialized just before the validation actually runs,
+         * and not in the constructor.
+         *
+         * This allows more flexibility for the messages initialization; for
+         * instance you can dynamically build the messages list in the method
+         * `initializeObject()` of your validator (and not only in the class
+         * variable declaration), then the messages will be processed just
+         * below.
+         */
         $this->messages = MessageService::get()->filterMessages(
             $this->dataObject->getValidation()->getMessages(),
             $this->supportedMessages,
             (bool)$this->supportsAllMessages
         );
+
+        return parent::validate($value);
     }
 
     /**

diff --git a/Tests/Fixture/Validation/Validator/DummyValidator.php b/Tests/Fixture/Validation/Validator/DummyValidator.php
@@ -6,6 +6,7 @@
 class DummyValidator extends AbstractValidator
 {
     const MESSAGE_1 = 'message1';
+    const DYNAMIC_MESSAGE = 'dynamic_message';
 
     /**
      * @var array
@@ -26,6 +27,16 @@ class DummyValidator extends AbstractValidator
      */
     protected $callback;
 
+    /**
+     * Dynamically assigns a message to the list of supported messages.
+     *
+     * @see \Romm\Formz\Tests\Unit\Validation\Validator\AbstractValidatorTest::runValidatorDataProvider #9
+     */
+    public function initializeObject()
+    {
+        $this->supportedMessages[self::DYNAMIC_MESSAGE]['value'] = 'dynamic message';
+    }
+
     /**
      * @param mixed $value
      */

diff --git a/Tests/Unit/Validation/Validator/AbstractValidatorTest.php b/Tests/Unit/Validation/Validator/AbstractValidatorTest.php
@@ -32,6 +32,8 @@ public function runValidator($value, array $messages, $callback, $finalCallback,
         $validatorDataObject = new ValidatorDataObject($this->getDefaultFormObject(), $validation);
 
         $validator = new DummyValidator([], $validatorDataObject);
+        $validator->initializeObject();
+
         if (is_callable($callback)) {
             $validator->setCallBack($callback);
         }
@@ -205,6 +207,27 @@ public function runValidatorDataProvider()
                     $this->assertEquals(42, $message->getCode());
                     $this->assertEquals('baz', $message->getTitle());
                 }
+            ],
+            /*
+             * #9
+             *
+             * Messages can be assigned dynamically (outside of the variable
+             * declaration scope). The code below will test that a dynamic
+             * message can be retrieved after the validation process.
+             */
+            [
+                'value'    => 'foo',
+                'messages' => [],
+                'callback' => function (DummyValidator $validator) {
+                    $validator->addNewError(DummyValidator::DYNAMIC_MESSAGE, 42, [], 'foo');
+                },
+                'final'    => function (Result $result) {
+                    $this->assertTrue($result->hasErrors());
+                    $message = $result->getFirstError();
+                    $this->assertEquals('dynamic message', $message->getMessage());
+                    $this->assertEquals(42, $message->getCode());
+                    $this->assertEquals('foo', $message->getTitle());
+                }
             ]
         ];
     }