NotFoundException   A
last analyzed

Complexity

Total Complexity 3

Size/Duplication

Total Lines 30
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 0

Importance

Changes 0
Metric Value
wmc 3
lcom 0
cbo 0
dl 0
loc 30
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A __toString() 0 4 1
A __wakeup() 0 4 1
1
<?php
2
3
namespace Darkgoldblade01\Dnd5eApi;
4
5
use Throwable;
6
7
/**
8
 * Class NotFoundException
9
 * @package Darkgoldblade01\Dnd5eApi
10
 */
11
class NotFoundException extends \Exception
12
{
13
    /**
14
     * NotFoundException constructor.
15
     * @param string $message
16
     * @param int $code
17
     * @param Throwable|null $previous
18
     */
19
    public function __construct($message = "", $code = 0, Throwable $previous = null)
20
    {
21
        parent::__construct($message, $code, $previous);
22
    }
23
24
    /**
25
     * @return string|void
26
     */
27
    public function __toString()
28
    {
29
        parent::__toString();
30
    }
31
32
    /**
33
     *
34
     */
35
    public function __wakeup()
36
    {
37
        parent::__wakeup();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Exception as the method __wakeup() does only exist in the following sub-classes of Exception: Darkgoldblade01\Dnd5eApi\NotFoundException. 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

  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 parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
38
    }
39
40
}