App\Exceptions\Handler

Complexity

Total Complexity

12

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Test Coverage

Coverage

81.82%

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	context()	0	12	2
A	render()	0	11	3
A	report()	0	15	2
A	unauthenticated()	0	11	3

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Auth\AuthenticationException as AuthenticationException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
use Facades\App\Services\WhichPortal;
use Illuminate\Session\TokenMismatchException;
use Illuminate\Support\Facades\Lang;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Request;
use Illuminate\Support\Facades\Auth;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that are not reported.
     *
     * @var array

@var annotation of property \App\Exceptions\Handler::$dontReport does not specify type hint for its items.

     */
    protected $dontReport = [];

    /**
     * A list of the inputs that are never flashed for validation exceptions.
     *
     * @var array

@var annotation of property \App\Exceptions\Handler::$dontFlash does not specify type hint for its items.

     */
    protected $dontFlash = [
        'password',
        'password_confirmation',
        'current_password',
        'new_password',
        'new_password_confirmation',
    ];

    /**
     * OVERRIDE
     * A list of the internal exception types that should not be reported.
     *
     * @var array

@var annotation of property \App\Exceptions\Handler::$internalDontReport does not specify type hint for its items.

     */
    protected $internalDontReport = [
        AuthenticationException::class,
        AuthorizationException::class,
        HttpException::class,

The type App\Exceptions\HttpException was not found. Did you mean HttpException? If so, make sure to prefix the type with \.

        HttpResponseException::class,

The type App\Exceptions\HttpResponseException was not found. Did you mean HttpResponseException? If so, make sure to prefix the type with \.

        ModelNotFoundException::class,
        SuspiciousOperationException::class,
        // TokenMismatchException::class,
        ValidationException::class,
    ];

    /**
     * Report or log an exception.
     *
     * @param  \Exception  $exception

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return void
     */
    public function report(Exception $exception)

Method \App\Exceptions\Handler::report() does not have return type hint for its return value but it should be possible to add it based on @return annotation "void".

    {
        if ($exception instanceof TokenMismatchException) {
            $logData = [
                'requestToken' => request()->header('x-csrf-token'),
                'sessionToken' => session()->token(),
                'session' => session()->all(),
                'user' => request()->user(),
                'requestUrl' => request()->url()
            ];
            $message = '419 CSRF Token Mismatch. ' . collect($logData)->toJson();
            Log::debug($message);
        }

        parent::report($exception);
    }

    /**
     * OVERRIDE
     * Get the default context variables for logging.
     *
     * @return array

@return annotation of method \App\Exceptions\Handler::context() does not specify type hint for items of its traversable return value.

     */
    protected function context()

Method \App\Exceptions\Handler::context() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        try {
            return array_filter([
                'userId' => Auth::id(),
                // 'email' => optional(Auth::user())->email,
                'url' => Request::path(),
                'method' => Request::method(),
                'referer' => Request::header('referer', '')
            ]);
        } catch (Throwable $e) {

The type App\Exceptions\Throwable was not found. Did you mean Throwable? If so, make sure to prefix the type with \.

            return [];
        }
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  \Exception  $exception

Missing parameter comment

Expected 15 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $exception)

Method \App\Exceptions\Handler::render() does not have parameter type hint for its parameter $request but it should be possible to add it based on @param annotation "\Illuminate\Http\Request".

Method \App\Exceptions\Handler::render() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Http\Response".

Type hint "\Illuminate\Http\Request" missing for $request

    {
        if ($exception instanceof AdminException) {
            return $exception->render($request);
        }
        if ($exception instanceof TokenMismatchException) {
            $newMessage = $exception->getMessage() . ' ' . Lang::get('errors.refresh_page');
            $modifiedException = new TokenMismatchException($newMessage, $exception->getCode(), $exception);
            return parent::render($request, $modifiedException);
        }
        return parent::render($request, $exception);
    }

    /**
     * Convert an authentication exception into an unauthenticated response.
     *
     * @param  \Illuminate\Http\Request  $request

Missing parameter comment

Expected 17 spaces after parameter type; 2 found

     * @param  \Illuminate\Auth\AuthenticationException  $exception

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response
     */
    protected function unauthenticated($request, AuthenticationException $exception)

Method \App\Exceptions\Handler::unauthenticated() does not have parameter type hint for its parameter $request but it should be possible to add it based on @param annotation "\Illuminate\Http\Request".

Method \App\Exceptions\Handler::unauthenticated() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Http\Response".

Type hint "\Illuminate\Http\Request" missing for $request

    {
        if ($request->expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
        }
        if (WhichPortal::isManagerPortal()) {
            $loginRoute = route('manager.login');
        } else {
            $loginRoute = route('login');
        }
        return redirect()->guest($loginRoute);
    }

    /**
     * OVERRIDE
     * Render the given HttpException.
     *
     * @param  \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface  $e

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function renderHttpException(HttpExceptionInterface $e)

Method \App\Exceptions\Handler::renderHttpException() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Symfony\Component\HttpFoundation\Response".

    {
        if (!view()->exists("errors.{$e->getStatusCode()}")) {
            return response()->view('errors.default', [
                'exception' => $e,
                'goc' => Lang::get('common/goc'),
                'alert' => Lang::get('common/alert'),
                'error' => [
                    'title' => 'Error'
                ]
            ], $e->getStatusCode(), $e->getHeaders());
        }
        return parent::renderHttpException($e);
    }
}