Issues in ErrorHandler.php - All Issues - Inspection of "Adjust PHPUnit version" - byjg/restserver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9e8dbe...382c30 )

by Joao

created 2019-02-10 00:04 UTC

src/ErrorHandler.php (3 issues)

Labels

Severity

Minor 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace ByJG\RestServer;

use ByJG\DesignPattern\Singleton;
use ByJG\RestServer\Whoops\PlainResponseHandler;
use Whoops\Handler\Handler;
use Whoops\Run;

class ErrorHandler
{

    use Singleton;

    /**
     *
     * @var Run
     */
    protected $whoops = null;

    /**
     *
     * @var Handler
     */
    protected $handler = null;

    protected function __construct()
    {
        $this->whoops = new Run();
        $this->setHandler(new PlainResponseHandler());
    }

    /**
     * Set the proper Error Handler based on the Output of the page
     *
     * @param \Whoops\Handler\Handler $handler
     */
    public function setHandler(Handler $handler)
    {
        $this->whoops->popHandler();
        $this->handler = $handler;
        $this->whoops->pushHandler($this->handler);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * Set Whoops as the default error and exception handler used by PHP:
     */
    public function register()
    {
        $this->whoops->register();
    }

    /**
     * Disable Whoops as the default error and exception handler used by PHP:
     */
    public function unregister()
    {
        $this->whoops->unregister();
    }

    /**
     * Added extra information for debug purposes on the error handler screen
     *
     * @param string $name
     * @param string $value
     */
    public function addExtraInfo($name, $value)
    {
        if (method_exists($this->handler, 'addDataTable')) {
            $data = $this->handler->getDataTable();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->handler->addDataTable('Info #' . (count($data) + 1), array($name => $value));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }
}


1			<?php
2
3			namespace ByJG\RestServer;
4
5			use ByJG\DesignPattern\Singleton;
6			use ByJG\RestServer\Whoops\PlainResponseHandler;
7			use Whoops\Handler\Handler;
8			use Whoops\Run;
9
10			class ErrorHandler
11			{
12
13			use Singleton;
14
15			/**
16			*
17			* @var Run
18			*/
19			protected $whoops = null;
20
21			/**
22			*
23			* @var Handler
24			*/
25			protected $handler = null;
26
27			protected function __construct()
28			{
29			$this->whoops = new Run();
30			$this->setHandler(new PlainResponseHandler());
31			}
32
33			/**
34			* Set the proper Error Handler based on the Output of the page
35			*
36			* @param \Whoops\Handler\Handler $handler
37			*/
38			public function setHandler(Handler $handler)
39			{
40			$this->whoops->popHandler();
41			$this->handler = $handler;
42			$this->whoops->pushHandler($this->handler);
			0 ignored issues – show Documentation introduced 2018-01-30 14:24 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$this->handler` is of type `object<Whoops\Handler\Handler>`, 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...
43			}
44
45			/**
46			* Set Whoops as the default error and exception handler used by PHP:
47			*/
48			public function register()
49			{
50			$this->whoops->register();
51			}
52
53			/**
54			* Disable Whoops as the default error and exception handler used by PHP:
55			*/
56			public function unregister()
57			{
58			$this->whoops->unregister();
59			}
60
61			/**
62			* Added extra information for debug purposes on the error handler screen
63			*
64			* @param string $name
65			* @param string $value
66			*/
67			public function addExtraInfo($name, $value)
68			{
69			if (method_exists($this->handler, 'addDataTable')) {
70			$data = $this->handler->getDataTable();
			0 ignored issues – show Bug introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `Whoops\Handler\Handler` as the method `getDataTable()` does only exist in the following sub-classes of `Whoops\Handler\Handler`: `ByJG\RestServer\Whoops\JsonResponseHandler`, `ByJG\RestServer\Whoops\PlainResponseHandler`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
71			$this->handler->addDataTable('Info #' . (count($data) + 1), array($name => $value));
			0 ignored issues – show Bug introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `Whoops\Handler\Handler` as the method `addDataTable()` does only exist in the following sub-classes of `Whoops\Handler\Handler`: `ByJG\RestServer\Whoops\JsonResponseHandler`, `ByJG\RestServer\Whoops\PlainResponseHandler`, `Whoops\Handler\PrettyPageHandler`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
72			}
73			}
74			}
75

byjg / restserver

Push — master ( 9e8dbe...382c30 )

src/ErrorHandler.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like