Flugg\Responder\Exceptions\HandlesApiErrors

Complexity

Total Complexity

11

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

96.43%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	transformException()	0	6	1
A	transformHttpException()	0	14	4
A	transformEloquentException()	0	10	3
A	transformValidationException()	0	6	2
A	renderApiError()	0	7	1

<?php

namespace Flugg\Responder\Exceptions;

use Exception;
use Flugg\Responder\Exceptions\Http\ApiException;
use Flugg\Responder\Exceptions\Http\PageNotFoundException;
use Flugg\Responder\Exceptions\Http\RelationNotFoundException;
use Flugg\Responder\Exceptions\Http\ResourceNotFoundException;
use Flugg\Responder\Exceptions\Http\UnauthenticatedException;
use Flugg\Responder\Exceptions\Http\UnauthorizedException;
use Flugg\Responder\Exceptions\Http\ValidationFailedException;
use Flugg\Responder\Http\Responses\ErrorResponseBuilder;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\Eloquent\RelationNotFoundException as BaseRelationNotFoundException;
use Illuminate\Http\JsonResponse;
use Illuminate\Validation\ValidationException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * A trait used by exception handlers to handle automatic handling of error responses.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
trait HandlesApiErrors
{
    /**
     * Convert a Laravel exception to an API exception.
     *
     * @param  \Exception $exception
     * @return void
     */
    protected function transformException(Exception $exception)
    {
        $this->transformHttpException($exception);
        $this->transformEloquentException($exception);
        $this->transformValidationException($exception);
    }

    /**
     * Convert a Laravel HTTP exception to an API exception.
     *
     * @param  \Exception $exception
     * @return void
     * @throws \Flugg\Responder\Exceptions\Http\PageNotFoundException
     */
    protected function transformHttpException(Exception $exception)
    {
        if ($exception instanceof AuthenticationException) {
            throw new UnauthenticatedException;
        }

        if ($exception instanceof AuthorizationException) {
            throw new UnauthorizedException;
        }

        if ($exception instanceof NotFoundHttpException) {
            throw new PageNotFoundException;
        }
    }

    /**
     * Convert an Eloquent exception to an API exception.
     *
     * @param  \Exception $exception
     * @return void
     * @throws \Flugg\Responder\Exceptions\Http\ResourceNotFoundException
     * @throws \Flugg\Responder\Exceptions\Http\RelationNotFoundException
     */
    protected function transformEloquentException(Exception $exception)
    {
        if ($exception instanceof ModelNotFoundException) {
            throw new ResourceNotFoundException;
        }

        if ($exception instanceof BaseRelationNotFoundException) {
            throw new RelationNotFoundException;
        }
    }

    /**
     * Convert a Laravel validation exception to an API exception.
     *
     * @param  \Exception $exception
     * @return void
     * @throws \Flugg\Responder\Exceptions\Http\ValidationFailedException
     */
    protected function transformValidationException(Exception $exception)
    {
        if ($exception instanceof ValidationException) {
            throw new ValidationFailedException($exception->validator);
        }
    }

    /**
     * Convert API exceptions to error responses.
     *
     * @param  \Flugg\Responder\Exceptions\Http\ApiException $exception
     * @return \Illuminate\Http\JsonResponse
     */
    protected function renderApiError(ApiException $exception): JsonResponse
    {
        return $this->container->make(ErrorResponseBuilder::class)
            ->error($exception->errorCode(), $exception->message())
            ->data($exception->data())
            ->respond($exception->statusCode());
    }
}