Added ValidationException

Author: Daniel Opitz

src/Validation/ServiceResult.php

@@ -2,21 +2,81 @@
 
 namespace Odan\Validation;
 
+use JsonSerializable;
+
 /**
- * ServiceResult.
+ * Encapsulates the state of model binding to a property of an action-method argument, or to the argument itself.
  */
-class ServiceResult extends ValidationResult
+class ServiceResult implements JsonSerializable
 {
     /**
-     * @var mixed|null
+     * @var bool Success
      */
-    protected $result;
+    protected $success = true;
+
+    /**
+     * @var string|null
+     */
+    protected $message = null;
 
     /**
      * @var mixed|null Code
      */
     protected $code = null;
 
+    /**
+     * @var mixed|null
+     */
+    protected $result;
+
+    /**
+     * Get message.
+     *
+     * @return string|null
+     */
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    /**
+     * Set the default success message.
+     *
+     * @param string $message The default success message
+     *
+     * @return $this
+     */
+    public function setMessage(string $message)
+    {
+        $this->message = $message;
+
+        return $this;
+    }
+
+    /**
+     * Set the success status.
+     *
+     * @param bool $success The success status
+     *
+     * @return $this self
+     */
+    public function setSuccess(bool $success)
+    {
+        $this->success = $success;
+
+        return $this;
+    }
+
+    /**
+     * Returns the success of the validation.
+     *
+     * @return bool true if validation was successful; otherwise, false
+     */
+    public function isSuccess(): bool
+    {
+        return $this->success;
+    }
+
     /**
      * Get the code.
      *
@@ -42,7 +102,7 @@ public function setCode($code)
     }
 
     /**
-     * Get the result.
+     * Returns the value that was being bound during model binding.
      *
      * @return mixed The result data
      */
@@ -52,7 +112,7 @@ public function getResult()
     }
 
     /**
-     * Set the result.
+     * Set the result data.
      *
      * @param mixed $result The result data
      *
@@ -72,7 +132,14 @@ public function setResult($result)
      */
     public function toArray(): array
     {
-        $data = parent::toArray();
+        $data = [
+            'success' => $this->isSuccess(),
+        ];
+
+        $message = $this->getMessage();
+        if ($message !== null) {
+            $data['message'] = $message;
+        }
 
         $code = $this->getCode();
         if ($code !== null) {
@@ -86,4 +153,14 @@ public function toArray(): array
 
         return $data;
     }
+
+    /**
+     * Serializes the object to a value that can be serialized natively by json_encode().
+     *
+     * @return array|mixed
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
 }

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

@@ -7,7 +7,7 @@
  *
  * Represents a status and a message.
  */
-class ErrorMessage
+class ValidationError
 {
     /**
      * @var string|null

src/Validation/ValidationException.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Odan\Validation;
+
+use DomainException;
+use Throwable;
+
+/**
+ * Class ValidationException.
+ */
+class ValidationException extends DomainException
+{
+    /**
+     * @var ValidationResult
+     */
+    protected $validationResult;
+
+    /**
+     * Construct the exception.
+     *
+     * @param ValidationResult $validationResult The validation result object
+     * @param string $message [optional] The Exception message to throw
+     * @param int $code [optional] The Exception code
+     * @param Throwable|null $previous [optional] The previous throwable used for the exception chaining
+     */
+    public function __construct(ValidationResult $validationResult, string $message = '', int $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+
+        $this->validationResult = $validationResult;
+    }
+
+    /**
+     * @return ValidationResult
+     */
+    public function getValidation(): ValidationResult
+    {
+        return $this->validationResult;
+    }
+}

src/Validation/ValidationResult.php

@@ -2,6 +2,8 @@
 
 namespace Odan\Validation;
 
+use JsonSerializable;
+
 /**
  * Validation Result.
  *
@@ -11,13 +13,8 @@
  *
  * https://martinfowler.com/articles/replaceThrowWithNotification.html
  */
-class ValidationResult
+class ValidationResult implements JsonSerializable
 {
-    /**
-     * @var bool Success
-     */
-    protected $success = true;
-
     /**
      * @var array
      */
@@ -31,7 +28,7 @@ class ValidationResult
     /**
      * Get all errors.
      *
-     * @return ErrorMessage[] Errors
+     * @return ValidationError[] Errors
      */
     public function getErrors(): array
     {
@@ -41,7 +38,7 @@ public function getErrors(): array
     /**
      * Get first error.
      *
-     * @return ErrorMessage|null Error message
+     * @return ValidationError|null Error message
      */
     public function getFirstError()
     {
@@ -72,28 +69,14 @@ public function setMessage(string $message)
         return $this;
     }
 
-    /**
-     * Set the success status.
-     *
-     * @param bool $success The success status
-     *
-     * @return $this self
-     */
-    public function setSuccess(bool $success)
-    {
-        $this->success = $success;
-
-        return $this;
-    }
-
     /**
      * Returns the success of the validation.
      *
      * @return bool true if validation was successful; otherwise, false
      */
     public function isSuccess(): bool
     {
-        return $this->success;
+        return empty($this->errors);
     }
 
     /**
@@ -115,7 +98,6 @@ public function clear()
     {
         $this->message = null;
         $this->errors = [];
-        $this->success = true;
 
         return $this;
     }
@@ -132,9 +114,7 @@ public function clear()
      */
     public function addError(string $field, string $message, string $code = null)
     {
-        $this->setSuccess(false);
-
-        $message = new ErrorMessage($message);
+        $message = new ValidationError($message);
         $message->setField($field)->setCode($code);
 
         $this->errors[] = $message;
@@ -143,16 +123,15 @@ public function addError(string $field, string $message, string $code = null)
     }
 
     /**
-     * Add a message object.
+     * Add a validation error object.
      *
-     * @param ErrorMessage $errorMessage The message object
+     * @param ValidationError $validationError The error object
      *
      * @return $this
      */
-    public function addErrorMessage(ErrorMessage $errorMessage)
+    public function addValidationError(ValidationError $validationError)
     {
-        $this->setSuccess(false);
-        $this->errors[] = $errorMessage;
+        $this->errors[] = $validationError;
 
         return $this;
     }
@@ -182,4 +161,14 @@ public function toArray(): array
 
         return $result;
     }
+
+    /**
+     * Serializes the object to a value that can be serialized natively by json_encode().
+     *
+     * @return array|mixed
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
 }

tests/ServiceResultTest.php

@@ -5,7 +5,7 @@
 use Odan\Validation\ServiceResult;
 
 /**
- * ValidationResult tests.
+ * Tests.
  *
  * @coversDefaultClass \Odan\Validation\ServiceResultTest
  */

tests/TestService.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Odan\Validation\Test;
+
+use Odan\Validation\ServiceResult;
+use Odan\Validation\ValidationException;
+use Odan\Validation\ValidationResult;
+
+/**
+ * Test service.
+ */
+class TestService
+{
+    /**
+     * Process.
+     *
+     * @param int $id ID
+     *
+     * @throws ValidationException
+     *
+     * @return ServiceResult Result data
+     */
+    public function process(int $id): ServiceResult
+    {
+        $validation = new ValidationResult();
+
+        if ($id < 1) {
+            $validation->addError('id', 'invalid');
+        }
+
+        if ($validation->isFailed()) {
+            $validation->setMessage('Please check your input');
+
+            throw new ValidationException($validation);
+        }
+
+        $result = new ServiceResult();
+        $result->setSuccess(true);
+        $result->setMessage('Successfully');
+        $result->setCode(0);
+        $result->setResult(['foo' => 'value']);
+
+        return $result;
+    }
+}