From 00177a134e6236b83f61d90d0a978c369e14ac4b Mon Sep 17 00:00:00 2001
From: Leonid Nikitin <i@kor-elf.net>
Date: Wed, 28 Jun 2023 14:36:51 +0600
Subject: [PATCH] Introduced ServiceResult and ServiceResultError interfaces,
 and respective classes with related methods. These changes were necessary to
 add and handle service results throughout the app. We now have a standard way
 to return and handle both successes and errors from our services. This leads
 to cleaner, clearer, and more maintainable code.

---
 app/Contracts/ServiceResult.php           |  9 +++++
 app/Contracts/ServiceResultError.php      | 12 +++++++
 app/ServiceResults/ServiceResult.php      | 15 +++++++++
 app/ServiceResults/ServiceResultArray.php | 16 +++++++++
 app/ServiceResults/ServiceResultError.php | 40 +++++++++++++++++++++++
 5 files changed, 92 insertions(+)
 create mode 100644 app/Contracts/ServiceResult.php
 create mode 100644 app/Contracts/ServiceResultError.php
 create mode 100644 app/ServiceResults/ServiceResult.php
 create mode 100644 app/ServiceResults/ServiceResultArray.php
 create mode 100644 app/ServiceResults/ServiceResultError.php

diff --git a/app/Contracts/ServiceResult.php b/app/Contracts/ServiceResult.php
new file mode 100644
index 0000000..87f87f6
--- /dev/null
+++ b/app/Contracts/ServiceResult.php
@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Contracts;
+
+interface ServiceResult
+{
+    public function isSuccess(): bool;
+}
diff --git a/app/Contracts/ServiceResultError.php b/app/Contracts/ServiceResultError.php
new file mode 100644
index 0000000..95bdbf2
--- /dev/null
+++ b/app/Contracts/ServiceResultError.php
@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Contracts;
+
+interface ServiceResultError
+{
+    public function getCode(): ?int;
+    public function getMessage(): string;
+    public function getErrors(): array;
+    public function getData(): array;
+}
diff --git a/app/ServiceResults/ServiceResult.php b/app/ServiceResults/ServiceResult.php
new file mode 100644
index 0000000..826d3a0
--- /dev/null
+++ b/app/ServiceResults/ServiceResult.php
@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace App\ServiceResults;
+
+use App\Contracts\ServiceResult as ServiceResultContract;
+use App\Contracts\ServiceResultError as ServiceResultErrorContract;
+
+abstract class ServiceResult implements ServiceResultContract
+{
+    public function isSuccess(): bool
+    {
+        return $this instanceof ServiceResultErrorContract !== true;
+    }
+}
diff --git a/app/ServiceResults/ServiceResultArray.php b/app/ServiceResults/ServiceResultArray.php
new file mode 100644
index 0000000..59971e4
--- /dev/null
+++ b/app/ServiceResults/ServiceResultArray.php
@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace App\ServiceResults;
+
+final class ServiceResultArray extends ServiceResult
+{
+    public function __construct(
+        private readonly array $data,
+    ) { }
+
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}
diff --git a/app/ServiceResults/ServiceResultError.php b/app/ServiceResults/ServiceResultError.php
new file mode 100644
index 0000000..26f310f
--- /dev/null
+++ b/app/ServiceResults/ServiceResultError.php
@@ -0,0 +1,40 @@
+<?php
+declare(strict_types=1);
+
+namespace App\ServiceResults;
+
+use App\Contracts\ServiceResultError as ServiceResultErrorContract;
+
+final class ServiceResultError extends ServiceResult implements ServiceResultErrorContract
+{
+    public function __construct(
+        private readonly string $message,
+        private readonly array $errors = [],
+        private readonly ?int $code = null,
+    ) {
+
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    public function getCode(): ?int
+    {
+        return $this->code;
+    }
+
+    public function getErrors(): array
+    {
+        return $this->errors;
+    }
+
+    public function getData(): array
+    {
+        return [
+            'message' => $this->getMessage(),
+            'errors' => $this->errors
+        ];
+    }
+}