From f77d01a373e201c8726f86feb3cacdcfcb2809a5 Mon Sep 17 00:00:00 2001
From: "Abdulmhsen B. A. A" <admin@arabcoders.org>
Date: Fri, 10 Jun 2022 17:33:35 +0300
Subject: [PATCH] Added common response/error objects for inner communication
 between backend clients and their sub actions.

---
 src/Backends/Common/Response.php | 48 ++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 src/Backends/Common/Response.php

diff --git a/src/Backends/Common/Response.php b/src/Backends/Common/Response.php
new file mode 100644
index 00000000..293362e4
--- /dev/null
+++ b/src/Backends/Common/Response.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Backends\Common;
+
+final class Response
+{
+    /**
+     * Wrap Clients responses into easy to consume object.
+     *
+     * @param bool $status Whether the operation is Successful.
+     * @param mixed $response the actual response.
+     * @param Error|null $error If the response has an error, populate it using {@see Error} object.
+     * @param mixed $extra an array that can contain anything.
+     */
+    public function __construct(
+        public readonly bool $status,
+        public readonly mixed $response = null,
+        public readonly Error|null $error = null,
+        public readonly array $extra = [],
+    ) {
+    }
+
+    /**
+     * Does the response contain an error object?
+     */
+    public function hasError(): bool
+    {
+        return null !== $this->error;
+    }
+
+    /**
+     * Return Error response.
+     */
+    public function getError(): Error
+    {
+        return $this->error ?? new Error('No error logged.');
+    }
+
+    /**
+     * Is the Operation Successful?
+     */
+    public function isSuccessful(): bool
+    {
+        return $this->status;
+    }
+}