Failed Conditions
Push — master ( 6560de...8483ce )
by Florent
05:17
created

InvalidClaimException::getClaim()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * The MIT License (MIT)
7
 *
8
 * Copyright (c) 2014-2017 Spomky-Labs
9
 *
10
 * This software may be modified and distributed under the terms
11
 * of the MIT license.  See the LICENSE file for details.
12
 */
13
14
namespace Jose\Component\Checker;
15
16
/**
17
 * Class InvalidClaimException.
18
 */
19
final class InvalidClaimException extends \Error
20
{
21
    /**
22
     * @var string
23
     */
24
    private $claim;
25
26
    /**
27
     * @var mixed
28
     */
29
    private $value;
30
31
    /**
32
     * InvalidClaimException constructor.
33
     * @param string $message
34
     * @param string $claim
35
     * @param mixed  $value
36
     */
37
    public function __construct(string $message, string $claim, $value)
38
    {
39
        parent::__construct($message);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Error as the method __construct() does only exist in the following sub-classes of Error: Jose\Component\Checker\InvalidClaimException, Jose\Component\Checker\InvalidHeaderException, TypeError. 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...
40
41
        $this->claim = $claim;
42
        $this->value = $value;
43
    }
44
45
    /**
46
     * @return string
47
     */
48
    public function getClaim(): string
49
    {
50
        return $this->claim;
51
    }
52
53
    /**
54
     * @return mixed
55
     */
56
    public function getValue()
57
    {
58
        return $this->value;
59
    }
60
}
61