Test Failed
Push — stable ( 1dab66...3c4cff )
by Nuno
03:33
created

ErrorHandler::__construct()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 2
c 0
b 0
f 0
nc 2
nop 1
dl 0
loc 4
rs 10
1
<?php
2
3
namespace LaravelZero\Framework\Providers\ErrorHandler;
4
5
use NunoMaduro\Collision\Provider;
6
use Symfony\Component\Console\Output\OutputInterface;
7
use NunoMaduro\Collision\Contracts\Provider as ProviderContract;
8
use LaravelZero\Framework\Contracts\Providers\ErrorHandler as ErrorHandlerContract;
9
10
/**
11
 * This is the Zero Framework Error Handler class.
12
 *
13
 * @author Nuno Maduro <[email protected]>
14
 */
15
class ErrorHandler implements ErrorHandlerContract
16
{
17
    /**
18
     * @var \NunoMaduro\Collision\Contracts\Provider
19
     */
20
    protected $provider;
21
22
    /**
23
     * Creates a new instance of the class.
24
     *
25
     * @param \NunoMaduro\Collision\Contracts\Provider|null $provider
26
     */
27
    public function __construct(ProviderContract $provider = null)
28
    {
29
        $this->provider = $provider ?: new Provider;
30
    }
31
32
    /**
33
     * {@inheritdoc}
34
     */
35
    public function register(): void
36
    {
37
        $this->provider->register();
38
    }
39
40
    /**
41
     * {@inheritdoc}
42
     */
43
    public function setOutput(OutputInterface $output): void
44
    {
45
        $this->provider->getHandler()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Whoops\Handler\HandlerInterface as the method setOutput() does only exist in the following implementations of said interface: NunoMaduro\Collision\Handler.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
46
            ->setOutput($output);
47
    }
48
}
49