102 lines
2.4 KiB
PHP
102 lines
2.4 KiB
PHP
<?php
|
|
|
|
namespace App\Exceptions\Api;
|
|
|
|
use App\Enums\Legacy\ApiError;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
/**
|
|
* This would be thrown if any of the case
|
|
* referenced in \App\Enums\ApiError would
|
|
* occur within the dam
|
|
*
|
|
* On the client an ApiErrorException would
|
|
* also be throw with the ApiError corresponding to
|
|
* the situation
|
|
*
|
|
* @package DAMclient
|
|
* @subpackage exceptions
|
|
*/
|
|
class ApiErrorException extends \RuntimeException
|
|
{
|
|
/**
|
|
* Api Error
|
|
* This value makes the error more explicit.
|
|
* Handling these errors are normal as inputs or
|
|
* request may be undesired or refused by the dam.
|
|
*
|
|
* @var \App\Enums\Legacy\ApiError
|
|
*/
|
|
protected $error;
|
|
|
|
/**
|
|
* This is an explicit error message,
|
|
* ou may print this to the front or not depending
|
|
* on $error value
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $message;
|
|
|
|
/**
|
|
* This is the http code returned by the dam.
|
|
* This value could be used to handle errors.
|
|
* But please take in consideration $error first
|
|
*
|
|
* @var integer
|
|
*/
|
|
protected $httpCode;
|
|
|
|
/**
|
|
* Create a new exception base on ApiError enum.
|
|
*
|
|
* @param \App\Enums\Legacy\ApiError $error
|
|
* @param integer $httpCode
|
|
* @param string $message
|
|
* @param \Throwable|null $previous
|
|
*/
|
|
public function __construct(ApiError $error, int $httpCode = 400, string $message = '', \Throwable $previous = null)
|
|
{
|
|
$this->error = $error;
|
|
$this->message = $message;
|
|
$this->httpCode = $httpCode;
|
|
parent::__construct(
|
|
strlen($this->message) ? $this->message : $error->label,
|
|
$error->value,
|
|
$previous
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the Api Error
|
|
*
|
|
* @return \App\Enums\Legacy\ApiError
|
|
*/
|
|
public function getApiError(): ApiError
|
|
{
|
|
return $this->error;
|
|
}
|
|
|
|
/**
|
|
* Get the http code
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getStatusCode(): int
|
|
{
|
|
return $this->httpCode;
|
|
}
|
|
|
|
/**
|
|
* This is used by laravel only.
|
|
* It uses Log class to print the error.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function report()
|
|
{
|
|
// @codeCoverageIgnoreStart
|
|
Log::debug(sprintf('DAM API: %s', $this->getMessage()));
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
}
|