Handler::render() - Code Metrics - Inspection of "Improve errors page" - LaravelRUS/laravel.ru - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.0 ( a6bd12...a1f142 )

by Kirill

created 2017-03-13 02:31 UTC

Handler::render() B

↳ Parent: Handler

Complexity

Conditions	5
Paths	6

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	10
nc	6
nop	2
dl	0
loc	19
rs	8.8571
c	0
b	0
f	0

<?php

/**
 * This file is part of laravel.su package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace App\Exceptions;

use Illuminate\Http\Response;
use Illuminate\Http\RedirectResponse;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Whoops\Handler\PrettyPageHandler;
use Whoops\Run;

/**
 * Class Handler.
 * Класс обработки всех исключений в нашем приложении.
 * Тут мы их будем обрабатывать и отображать ошибки, в случае проблем.
 */
class Handler extends ExceptionHandler
{
    /**
     * Список исключений, которые являются частью нормальной работы приложения
     * и которые не надо как-то обрабатывать. Например, "ошибка 404" и прочие.
     * @var array
     */
    protected $dontReport = [
        \Illuminate\Auth\AuthenticationException::class,
        \Illuminate\Auth\Access\AuthorizationException::class,
        \Symfony\Component\HttpKernel\Exception\HttpException::class,
        \Illuminate\Database\Eloquent\ModelNotFoundException::class,
        \Illuminate\Session\TokenMismatchException::class,
        \Illuminate\Validation\ValidationException::class,
    ];

    /**
     * Метод, куда прилетают все наши исключения для обработки.
     * Отличное место для отправки оных в Sentry, Bugsnag, и проч.
     * @param  \Exception $exception
     * @throws \Exception
     */
    public function report(\Exception $exception): void
    {
        if ($this->shouldReport($exception) && app('app')->bound('sentry')) {
            app('sentry')->captureException($exception);
        }

        parent::report($exception);
    }

    /**
     * Отображение наших необработанных ошибок.
     * @param \Illuminate\Http\Request $request
     * @param \Exception $exception
     * @return string|\Symfony\Component\HttpFoundation\Response
     * @throws \Throwable
     * @throws \InvalidArgumentException
     */
    public function render($request, \Exception $exception)
    {
        $exception = $this->prepareException($exception);

        $htmlAccepted = ! $request->ajax() && $request->acceptsHtml();

        if ($htmlAccepted && ! config('app.debug')) {
            $whoops = new Run();
            $whoops->pushHandler(new PrettyPageHandler());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            return $whoops->handleException($exception);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if (!$this->isHttpException($exception)) {
            $exception = new HttpException(500, 'Be right back.', $exception);
        }

        return response($this->getErrorView($exception)->render(), $exception->getStatusCode());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * @param HttpException $exception
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    private function getErrorView(HttpException $exception)
    {
        return view('layout.error', [
            'message' => Response::$statusTexts[$exception->getStatusCode()],
            'code'    => $exception->getStatusCode(),
            'error'   => $exception,
        ]);
    }

    /**
     * Преобразовываем ошибки аутентификации в разлогинивающий ответ.
     * @param  \Illuminate\Http\Request $request
     * @param  \Illuminate\Auth\AuthenticationException $exception
     * @return Response|RedirectResponse
     */
    protected function unauthenticated($request, AuthenticationException $exception)
    {
        if ($request->expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return redirect()->guest('login')
            ->withException($exception);
    }
}


1			<?php
2
3			/**
4			* This file is part of laravel.su package.
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8			declare(strict_types=1);
9
10			namespace App\Exceptions;
11
12			use Illuminate\Http\Response;
13			use Illuminate\Http\RedirectResponse;
14			use Illuminate\Auth\AuthenticationException;
15			use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
16			use Symfony\Component\HttpKernel\Exception\HttpException;
17			use Whoops\Handler\PrettyPageHandler;
18			use Whoops\Run;
19
20			/**
21			* Class Handler.
22			* Класс обработки всех исключений в нашем приложении.
23			* Тут мы их будем обрабатывать и отображать ошибки, в случае проблем.
24			*/
25			class Handler extends ExceptionHandler
26			{
27			/**
28			* Список исключений, которые являются частью нормальной работы приложения
29			* и которые не надо как-то обрабатывать. Например, "ошибка 404" и прочие.
30			* @var array
31			*/
32			protected $dontReport = [
33			\Illuminate\Auth\AuthenticationException::class,
34			\Illuminate\Auth\Access\AuthorizationException::class,
35			\Symfony\Component\HttpKernel\Exception\HttpException::class,
36			\Illuminate\Database\Eloquent\ModelNotFoundException::class,
37			\Illuminate\Session\TokenMismatchException::class,
38			\Illuminate\Validation\ValidationException::class,
39			];
40
41			/**
42			* Метод, куда прилетают все наши исключения для обработки.
43			* Отличное место для отправки оных в Sentry, Bugsnag, и проч.
44			* @param \Exception $exception
45			* @throws \Exception
46			*/
47			public function report(\Exception $exception): void
48			{
49			if ($this->shouldReport($exception) && app('app')->bound('sentry')) {
50			app('sentry')->captureException($exception);
51			}
52
53			parent::report($exception);
54			}
55
56			/**
57			* Отображение наших необработанных ошибок.
58			* @param \Illuminate\Http\Request $request
59			* @param \Exception $exception
60			* @return string\|\Symfony\Component\HttpFoundation\Response
61			* @throws \Throwable
62			* @throws \InvalidArgumentException
63			*/
64			public function render($request, \Exception $exception)
65			{
66			$exception = $this->prepareException($exception);
67
68			$htmlAccepted = ! $request->ajax() && $request->acceptsHtml();
69
70			if ($htmlAccepted && ! config('app.debug')) {
71			$whoops = new Run();
72			$whoops->pushHandler(new PrettyPageHandler());
			0 ignored issues – show Documentation introduced 2017-03-13 01:06 UTC by Report Bug Copy Issue Report `new \Whoops\Handler\PrettyPageHandler()` is of type `object<Whoops\Handler\PrettyPageHandler>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
73
74			return $whoops->handleException($exception);
			0 ignored issues – show Documentation introduced 2017-03-13 01:06 UTC by Report Bug Copy Issue Report `$exception` is of type `object<Exception>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug Best Practice introduced 2017-03-13 01:06 UTC by Report Bug Copy Issue Report The return type of `return $whoops->handleException($exception);` (`string\|false`) is incompatible with the return type declared by the interface `Illuminate\Contracts\Deb...xceptionHandler::render` of type `Symfony\Component\HttpFoundation\Response`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
75			}
76
77			if (!$this->isHttpException($exception)) {
78			$exception = new HttpException(500, 'Be right back.', $exception);
79			}
80
81			return response($this->getErrorView($exception)->render(), $exception->getStatusCode());
			0 ignored issues – show Compatibility introduced 2017-03-13 02:33 UTC by Report Bug Copy Issue Report `$exception` of type `object<Exception>` is not a sub-type of `object<Symfony\Component...xception\HttpException>`. It seems like you assume a child class of the class `Exception` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history... Bug introduced 2017-03-13 02:33 UTC by Report Bug Copy Issue Report The method `render` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
82			}
83
84			/**
85			* @param HttpException $exception
86			* @return \Illuminate\Contracts\View\Factory\|\Illuminate\View\View
87			*/
88			private function getErrorView(HttpException $exception)
89			{
90			return view('layout.error', [
91			'message' => Response::$statusTexts[$exception->getStatusCode()],
92			'code' => $exception->getStatusCode(),
93			'error' => $exception,
94			]);
95			}
96
97			/**
98			* Преобразовываем ошибки аутентификации в разлогинивающий ответ.
99			* @param \Illuminate\Http\Request $request
100			* @param \Illuminate\Auth\AuthenticationException $exception
101			* @return Response\|RedirectResponse
102			*/
103			protected function unauthenticated($request, AuthenticationException $exception)
104			{
105			if ($request->expectsJson()) {
106			return response()->json(['error' => 'Unauthenticated.'], 401);
			0 ignored issues – show Bug Best Practice introduced 2017-02-21 17:31 UTC by Report Bug Copy Issue Report The return type of `return response()->json(...authenticated.'), 401);` (`Illuminate\Http\JsonResponse`) is incompatible with the return type documented by `App\Exceptions\Handler::unauthenticated` of type `Illuminate\Http\Response...e\Http\RedirectResponse`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
107			}
108
109			return redirect()->guest('login')
110			->withException($exception);
111			}
112			}
113

LaravelRUS / laravel.ru

Push — 2.0 ( a6bd12...a1f142 )

Handler::render() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like