Merge pull request #14 from homeappcorporate/task/PHP-1167

[php-1167] Рефактор JsonApi Exceptions
homeappcorporate · Feb 23, 2021 · db957a5 · db957a5
2 parents c56a1d4 + e59464a
commit db957a5
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 45 deletions.
diff --git a/HomeappData/Registry/Dto/RealtyImage/Relationships.php b/HomeappData/Registry/Dto/RealtyImage/Relationships.php
@@ -18,8 +18,17 @@ class Relationships implements RelationshipsInterface
      */
     public RelationshipsBlockSingle $image;
 
-    public function __construct(ResourceIdentifierObject $image)
+    /**
+     * НЕ обязательное, для обратной совместмости пакета. Нужно будет потом сделать обязательным.
+     * @var RelationshipsBlockSingle|null
+     * @Serializer\Type("Homeapp\JsonApi\Relationships\RelationshipsBlockSingle")
+     * @Serializer\Groups({"API"})
+     */
+    public ?RelationshipsBlockSingle $realty = null;
+
+    public function __construct(ResourceIdentifierObject $image, ?ResourceIdentifierObject $realty = null)
     {
         $this->image = new RelationshipsBlockSingle($image);
+        $this->realty = new RelationshipsBlockSingle($realty);
     }
 }
diff --git a/JsonApi/Exception/JsonApiBadRequestException.php b/JsonApi/Exception/JsonApiBadRequestException.php
@@ -5,25 +5,10 @@
 use Symfony\Component\Asset\Exception\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\Response;
 
-class JsonApiBadRequestException extends InvalidArgumentException
+class JsonApiBadRequestException extends JsonApiBaseException
 {
-    private string $parameter;
-
-    public static function create(string $message, string $parameter): self
-    {
-        $exception = new self();
-        $exception->message = $message;
-        $exception->parameter = $parameter;
-        $exception->code = Response::HTTP_BAD_REQUEST;
-
-        return $exception;
-    }
-
-    /**
-     * @return string
-     */
-    public function getParameter(): string
+    protected static function getHttpCode(): int
     {
-        return $this->parameter;
+        return Response::HTTP_BAD_REQUEST;
     }
-}
+}
diff --git a/JsonApi/Exception/JsonApiBaseException.php b/JsonApi/Exception/JsonApiBaseException.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+namespace Homeapp\JsonApi\Exception;
+
+use Symfony\Component\Asset\Exception\InvalidArgumentException;
+use Symfony\Component\HttpFoundation\Response;
+
+abstract class JsonApiBaseException extends InvalidArgumentException
+{
+    protected ?string $parameter = null;
+    protected ?string $pointer = null;
+
+    public static function create(string $message, ?string $parameter = null): self
+    {
+        $exception = new static();
+        $exception->message = $message;
+        $exception->parameter = $parameter;
+        $exception->code = static::getHttpCode();
+
+        return $exception;
+    }
+
+    public static function createWithPointer(string $message, string $pointer): self
+    {
+        $exception = new static();
+        $exception->message = $message;
+        $exception->pointer = $pointer;
+        $exception->code = static::getHttpCode();
+
+        return $exception;
+    }
+
+    abstract protected static function getHttpCode(): int;
+
+    public function getParameter(): ?string
+    {
+        return $this->parameter;
+    }
+
+    public function getPointer(): ?string
+    {
+        return $this->pointer;
+    }
+}
diff --git a/JsonApi/Exception/JsonApiConflictException.php b/JsonApi/Exception/JsonApiConflictException.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+namespace Homeapp\JsonApi\Exception;
+
+use Symfony\Component\Asset\Exception\InvalidArgumentException;
+use Symfony\Component\HttpFoundation\Response;
+
+class JsonApiConflictException extends JsonApiBaseException
+{
+    protected static function getHttpCode(): int
+    {
+        return Response::HTTP_CONFLICT;
+    }
+}
diff --git a/JsonApi/Exception/JsonApiNotAcceptableException.php b/JsonApi/Exception/JsonApiNotAcceptableException.php
@@ -5,14 +5,10 @@
 use Symfony\Component\Asset\Exception\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\Response;
 
-class JsonApiNotAcceptableException extends InvalidArgumentException
+class JsonApiNotAcceptableException extends JsonApiBaseException
 {
-    public static function create(string $message): self
+    protected static function getHttpCode(): int
     {
-        $exception = new self();
-        $exception->message = $message;
-        $exception->code = Response::HTTP_NOT_ACCEPTABLE;
-
-        return $exception;
+        return Response::HTTP_NOT_ACCEPTABLE;
     }
-}
+}
diff --git a/JsonApi/Exception/JsonApiNotFoundException.php b/JsonApi/Exception/JsonApiNotFoundException.php
@@ -1,18 +1,16 @@
-<?php 
+<?php
+
 declare(strict_types=1);
 namespace Homeapp\JsonApi\Exception;
 
 use Symfony\Component\Asset\Exception\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\Response;
 
-class JsonApiNotFoundException extends InvalidArgumentException
+class JsonApiNotFoundException extends JsonApiBaseException
 {
-    public static function create(string $message): self
+    protected static function getHttpCode(): int
     {
-        $exception = new self();
-        $exception->message = $message;
-        $exception->code = Response::HTTP_NOT_FOUND;
-
-        return $exception;
+        return Response::HTTP_NOT_FOUND;
     }
 }
+
diff --git a/JsonApi/Exception/JsonApiServerException.php b/JsonApi/Exception/JsonApiServerException.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+namespace Homeapp\JsonApi\Exception;
+
+use Symfony\Component\Asset\Exception\InvalidArgumentException;
+use Symfony\Component\HttpFoundation\Response;
+
+class JsonApiServerException extends JsonApiBaseException
+{
+    protected static function getHttpCode(): int
+    {
+        return Response::HTTP_INTERNAL_SERVER_ERROR;
+    }
+}
+
diff --git a/JsonApi/Exception/JsonApiUnsupportedMediaTypeException.php b/JsonApi/Exception/JsonApiUnsupportedMediaTypeException.php
@@ -1,18 +1,15 @@
-<?php 
+<?php
+
 declare(strict_types=1);
 namespace Homeapp\JsonApi\Exception;
 
 use Symfony\Component\Asset\Exception\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\Response;
 
-class JsonApiUnsupportedMediaTypeException extends InvalidArgumentException
+class JsonApiUnsupportedMediaTypeException extends JsonApiBaseException
 {
-    public static function create(string $message): self
+    protected static function getHttpCode(): int
     {
-        $exception = new self();
-        $exception->message = $message;
-        $exception->code = Response::HTTP_UNSUPPORTED_MEDIA_TYPE;
-
-        return $exception;
+        return Response::HTTP_UNSUPPORTED_MEDIA_TYPE;
     }
-}
+}