Merge pull request #170 from akeneo/API-629

API-629: Add additional information on exception

Author: fitn

src/Exception/BadRequestHttpException.php

@@ -11,4 +11,8 @@
  */
 class BadRequestHttpException extends ClientErrorHttpException
 {
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#bad-request-exception)';
+    }
 }

src/Exception/ClientErrorHttpException.php

@@ -11,4 +11,8 @@
  */
 class ClientErrorHttpException extends HttpException
 {
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#client-exception)';
+    }
 }

src/Exception/HttpException.php

@@ -22,6 +22,8 @@ class HttpException extends RuntimeException
 
     public function __construct(string $message, RequestInterface $request, ResponseInterface $response, ?\Exception $previous = null)
     {
+        $message .= ' ' . $this->getAdditionalInformationMessage();
+
         parent::__construct($message, $response->getStatusCode(), $previous);
 
         $this->request = $request;
@@ -43,4 +45,9 @@ public function getResponse(): ResponseInterface
     {
         return $this->response;
     }
+
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#http-exception)';
+    }
 }

src/Exception/NotFoundHttpException.php

@@ -11,4 +11,8 @@
  */
 class NotFoundHttpException extends ClientErrorHttpException
 {
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#not-found-exception)';
+    }
 }

src/Exception/ServerErrorHttpException.php

@@ -11,4 +11,8 @@
  */
 class ServerErrorHttpException extends HttpException
 {
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#server-exception)';
+    }
 }

src/Exception/UnauthorizedHttpException.php

@@ -11,4 +11,8 @@
  */
 class UnauthorizedHttpException extends ClientErrorHttpException
 {
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#unauthorized-exception)';
+    }
 }

src/Exception/UnprocessableEntityHttpException.php

@@ -24,4 +24,9 @@ public function getResponseErrors(): array
 
         return isset($decodedBody['errors']) ? $decodedBody['errors'] : [];
     }
+
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#unprocessable-entity-exception)';
+    }
 }