Added addErrorMessage method

Author: Daniel Opitz

src/Validation/ValidationMessage.php src/Validation/ErrorMessage.phpsrc/Validation/ValidationMessage.php renamed to src/Validation/ErrorMessage.php

@@ -7,10 +7,10 @@
  *
  * Represents a status and a message.
  */
-class ValidationMessage
+class ErrorMessage
 {
     /**
-     * @var string
+     * @var string|null
      */
     protected $field;
 
@@ -27,15 +27,11 @@ class ValidationMessage
     /**
      * Constructor.
      *
-     * @param string $field The field name
      * @param string $message The Message
-     * @param string|null $code The error code (optional)
      */
-    public function __construct(string $field, string $message, string $code = null)
+    public function __construct(string $message)
     {
-        $this->field = $field;
         $this->message = $message;
-        $this->code = $code;
     }
 
     /**
@@ -48,16 +44,44 @@ public function getMessage(): string
         return $this->message;
     }
 
+    /**
+     * Set the field name.
+     *
+     * @param string $field The field name
+     *
+     * @return $this self
+     */
+    public function setField(string $field)
+    {
+        $this->field = $field;
+
+        return $this;
+    }
+
     /**
      * Returns the field name.
      *
-     * @return string The field name
+     * @return string|null The field name
      */
-    public function getField(): string
+    public function getField()
     {
         return $this->field;
     }
 
+    /**
+     * Set the field name.
+     *
+     * @param mixed $code The error code
+     *
+     * @return $this self
+     */
+    public function setCode($code)
+    {
+        $this->code = $code;
+
+        return $this;
+    }
+
     /**
      * Returns the validation status code.
      *
@@ -76,10 +100,14 @@ public function getCode(): ?string
     public function toArray(): array
     {
         $result = [
-            'field' => $this->getField(),
             'message' => $this->getMessage(),
         ];
 
+        $field = $this->getField();
+        if ($field !== null) {
+            $result['field'] = $field;
+        }
+
         $code = $this->getCode();
         if ($code !== null) {
             $result['code'] = $code;

src/Validation/ValidationResult.php

@@ -31,7 +31,7 @@ class ValidationResult
     /**
      * Get all errors.
      *
-     * @return ValidationMessage[] Errors
+     * @return ErrorMessage[] Errors
      */
     public function getErrors(): array
     {
@@ -41,7 +41,7 @@ public function getErrors(): array
     /**
      * Get first error.
      *
-     * @return ValidationMessage|null Error message
+     * @return ErrorMessage|null Error message
      */
     public function getFirstError()
     {
@@ -133,7 +133,26 @@ public function clear()
     public function addError(string $field, string $message, string $code = null)
     {
         $this->setSuccess(false);
-        $this->errors[] = new ValidationMessage($field, $message, $code);
+
+        $message = new ErrorMessage($message);
+        $message->setField($field)->setCode($code);
+
+        $this->errors[] = $message;
+
+        return $this;
+    }
+
+    /**
+     * Add a message object.
+     *
+     * @param ErrorMessage $errorMessage The message object
+     *
+     * @return $this
+     */
+    public function addErrorMessage(ErrorMessage $errorMessage)
+    {
+        $this->setSuccess(false);
+        $this->errors[] = $errorMessage;
 
         return $this;
     }

tests/ValidationMessageTest.php

@@ -2,25 +2,27 @@
 
 namespace Odan\Validation\Test;
 
-use Odan\Validation\ValidationMessage;
+use Odan\Validation\ErrorMessage;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Tests.
  *
- * @coversDefaultClass \Odan\Validation\ValidationMessage
+ * @coversDefaultClass \Odan\Validation\ErrorMessage
  */
 class ValidationMessageTest extends TestCase
 {
     public function testConstruct()
     {
-        $message = new ValidationMessage('', '');
-        $this->assertInstanceOf(ValidationMessage::class, $message);
+        $message = new ErrorMessage('');
+        $this->assertInstanceOf(ErrorMessage::class, $message);
     }
 
     public function testWithField()
     {
-        $message = new ValidationMessage('email', 'required');
+        $message = new ErrorMessage('required');
+        $message->setField('email');
+
         $this->assertEquals([
             'field' => 'email',
             'message' => 'required',
@@ -29,7 +31,10 @@ public function testWithField()
 
     public function testWithFieldAndCode()
     {
-        $message = new ValidationMessage('email', 'invalid', '5000');
+        $message = new ErrorMessage('invalid');
+        $message->setField('email');
+        $message->setCode('5000');
+
         $this->assertEquals([
             'field' => 'email',
             'message' => 'invalid',

tests/ValidationResultTest.php

@@ -2,6 +2,7 @@
 
 namespace Odan\Validation\Test;
 
+use Odan\Validation\ErrorMessage;
 use Odan\Validation\ValidationResult;
 use PHPUnit\Framework\TestCase;
 
@@ -93,6 +94,27 @@ public function testErrorsWithMessage()
         $this->assertEquals($expected, $val->getFirstError()->toArray());
     }
 
+    /**
+     * Tests addError and success functions.
+     * Tests addError function with null for the second parameter.
+     *
+     * @return void
+     */
+    public function testAddErrorMessage()
+    {
+        $val = new ValidationResult();
+        $message = new ErrorMessage('required');
+        $message->setField('email')->setCode('5000');
+
+        $val->addErrorMessage($message);
+        $result = $val->isFailed();
+        $this->assertTrue($result);
+
+        $expected = ['field' => 'email', 'message' => 'required',  'code' => '5000'];
+
+        $this->assertEquals($expected, $val->getFirstError()->toArray());
+    }
+
     /**
      * Tests success function.
      * Tests for no errors.
@@ -130,7 +152,7 @@ public function testClear()
     {
         $val = new ValidationResult();
         $val->setMessage('Errors');
-        $val->addError('error', 'error');
+        $val->addError('email', 'required');
         $val->clear();
         $result = $val->isFailed();
         $this->assertFalse($result);