feat: new ErrorBag class for manipulate validation errors

chipslays · Feb 16, 2023 · 3b7794f · 3b7794f
1 parent db184cf
commit 3b7794f
Show file tree

Hide file tree

Showing 5 changed files with 192 additions and 10 deletions.
diff --git a/examples/basic-events/events/hello-to.php b/examples/basic-events/events/hello-to.php
@@ -13,11 +13,18 @@
         'username' => ['stringType', ['length', [4, 18]]],
     ];
 
+    protected array $messages = [
+        'username' => [
+            'stringType' => 'Property %prop% must be a string.',
+            'length' => 'Length of %prop% must be 4-18 chars.',
+        ],
+    ];
+
     public function handle(Connection $connection, Payload $payload, Server $server)
     {
         if (!$this->validate()) {
-            return $this->reply('bad request', ['errors' => $this->errors]);
-        }
+            return $this->reply('errors', $this->errorBag()->all());
+        };
 
         $username = $this->payload->data['username'];
         $this->reply(data: ['message' => "Hello, {$username}!"]);

diff --git a/examples/simple-chat/chat.html b/examples/simple-chat/chat.html
@@ -8,7 +8,7 @@
 
     <script src="https://cdn.tailwindcss.com"></script>
 
-    <title>Chat</title>
+    <title>Simple Chat</title>
 </head>
 
 <body class="bg-gray-50">
@@ -18,7 +18,6 @@
                 Users: <span id="usersCount">0</span>
             </div>
             <div id="chat" class="flex flex-col divide-y border rounded-md h-96 overflow-y-auto"></div>
-
             <div class="mt-4">
                 <input id="message" class="focus:outline-none outline-none px-3 py-2 rounded-lg focus:shadow-sm bg-gray-50 focus:bg-transparent border text-sm w-full" type="text" placeholder="Text message (Enter)">
             </div>
@@ -57,6 +56,10 @@
             document.getElementById('usersCount').innerHTML = payload.data.count;
         });
 
+        client.on('errors', payload => {
+            console.log('errors:', payload.data);
+        });
+
         client.listen();
     </script>
 </body>

diff --git a/examples/simple-chat/events/chat-message.php b/examples/simple-chat/events/chat-message.php
@@ -13,9 +13,18 @@
         'message' => ['stringType', ['length', [1, 256]]],
     ];
 
+    protected array $messages = [
+        'message' => [
+            'stringType' => 'Property %prop% must be a string.',
+            'length' => 'Length of %prop% must be 1-256 chars.',
+        ],
+    ];
+
     public function handle(Connection $connection, Payload $payload, Server $server)
     {
-        if (!$this->validate()) return;
+        if (!$this->validate()) {
+            return $this->reply('errors', [$this->errorBag()->first('message')]);
+        };
 
         $this->broadcast($payload->type, data: [
             'nickname' => $connection->nickname,

diff --git a/src/Events/AbstractEvent.php b/src/Events/AbstractEvent.php
@@ -58,11 +58,18 @@ abstract class AbstractEvent
     protected array $rules = [];
 
     /**
-     * Array of validate errors.
+     * Array of validation custom messages.
      *
      * @var array
      */
-    public array $errors = [];
+    protected array $messages = [];
+
+    /**
+     * Errors bag for validation.
+     *
+     * @var ErrorBag
+     */
+    public ErrorBag $errorBag;
 
     /**
      * Short cut for payload data (as &link).
@@ -84,6 +91,7 @@ public function boot(Connection $connection, Payload $payload): self
         $this->payload = $payload;
         $this->server = Server::getInstance();
         $this->data = &$this->payload->data;
+        $this->errorBag = new ErrorBag;
 
         $this->setMagicalVariables();
 
@@ -200,28 +208,46 @@ public function validator(): Validator
      * @param array $rules Pass custom rules. Default use $rules class attribute.
      * @return bool Returns False if has errors.
      */
-    protected function validate(array $rules = null): bool
+    public function validate(array $rules = null): bool
     {
         foreach ($rules ?? $this->rules as $property => $rules) {
             foreach ($rules as $rule) {
                 if (!$this->payload->is($rule, $property)) {
+                    // get a rule name
                     $rule = ((array) $rule)[0];
-                    $this->errors[$property][$rule] = "{$property} failed validation: {$rule}";
+
+                    // get a message
+                    $message = @$this->messages[$property][$rule]
+                        ?  str_replace(['%prop%', '%property%'], $property, $this->messages[$property][$rule])
+                        : "Property {$property} failed validation {$rule} rule.";
+
+                    // add error to errors bag
+                    $this->errorBag()->add($property, $rule, $message);
                 }
             }
         }
 
         return !$this->hasErrors();
     }
 
+    /**
+     * Get a errors bag.
+     *
+     * @return ErrorBag
+     */
+    public function errorBag(): ErrorBag
+    {
+        return $this->errorBag;
+    }
+
     /**
      * Returns `true` if has errors on validate payload data.
      *
      * @return bool
      */
     public function hasErrors(): bool
     {
-        return count($this->errors) > 0;
+        return $this->errorBag()->any();
     }
 
     /**

diff --git a/src/Events/ErrorBag.php b/src/Events/ErrorBag.php
@@ -0,0 +1,137 @@
+<?php
+
+namespace Porter\Events;
+
+use Porter\Support\Collection;
+
+/**
+ * A class for store and manipulate validation errors.
+ */
+class ErrorBag
+{
+    /**
+     * Contain errors by property.
+     *
+     * @var Collection
+     */
+    protected Collection $errors;
+
+    /**
+     * Constructor.
+     *
+     * @param array $errors
+     */
+    public function __construct(array $errors = [])
+    {
+        $this->errors = new Collection($errors);
+    }
+
+    /**
+     * Get a errors by property.
+     *
+     * @param string $property
+     * @return array|null
+     */
+    public function get(string $property): ?array
+    {
+        return $this->errors->get($property);
+    }
+
+    /**
+     * Property has any errors.
+     *
+     * @param string $property
+     * @return boolean
+     */
+    public function has(string $property): bool
+    {
+        return $this->errors->has($property);
+    }
+
+    /**
+     * Remove property from errors bag.
+     *
+     * @param string $property
+     * @return self
+     */
+    public function remove(string $property): self
+    {
+        $this->errors->remove($property);
+
+        return $this;
+    }
+
+    /**
+     * Get a first error message of property.
+     *
+     * @param string $property
+     * @return string|null
+     */
+    public function first(string $property): ?string
+    {
+        $messages = $this->get($property);
+
+        if (is_array($messages) && count($messages) > 0) {
+            return array_values($messages)[0];
+        }
+
+        return null;
+    }
+
+    /**
+     * Add new error to errors bag.
+     *
+     * @param string $property
+     * @param string $rule
+     * @param string $message
+     * @return self
+     */
+    public function add(string $property, string $rule, string $message): self
+    {
+        $this->errors->set("{$property}.{$rule}", $message);
+
+        return $this;
+    }
+
+    /**
+     * Get all errors as array.
+     *
+     * @return array
+     */
+    public function all(): array
+    {
+        return $this->errors->all();
+    }
+
+    /**
+     * Get count of errors.
+     *
+     * @return integer
+     */
+    public function count(): int
+    {
+        return $this->errors->count();
+    }
+
+    /**
+     * Has any erorrs.
+     *
+     * @return boolean
+     */
+    public function any(): bool
+    {
+        return $this->errors->count() > 0;
+    }
+
+    /**
+     * Clear errors bag.
+     *
+     * @return self
+     */
+    public function clear(): self
+    {
+        $this->errors = new Collection;
+
+        return $this;
+    }
+}