BaseVoter   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 32
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 0

Importance

Changes 0
Metric Value
wmc 6
c 0
b 0
f 0
lcom 0
cbo 0
dl 0
loc 32
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 3
A vote() 0 4 1
A getAssets() 0 4 1
A setAssets() 0 6 1
1
<?php
2
3
namespace Hongliang\Defender\Voter;
4
5
class BaseVoter implements VoterInterface
6
{
7
    protected $assets = null;
8
    protected $target = null;
9
10
    public function __construct()
11
    {
12
        if (method_exists($this, 'setDefaultTarget')) {
13
            $this->setDefaultTarget();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Hongliang\Defender\Voter\BaseVoter as the method setDefaultTarget() does only exist in the following sub-classes of Hongliang\Defender\Voter\BaseVoter: Hongliang\Defender\Voter\IpRangeVoter, Hongliang\Defender\Voter\UriKeywordVoter. 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...
14
        }
15
        if (method_exists($this, 'getDefaultAssets')) {
16
            $this->assets = $this->getDefaultAssets();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Hongliang\Defender\Voter\BaseVoter as the method getDefaultAssets() does only exist in the following sub-classes of Hongliang\Defender\Voter\BaseVoter: Hongliang\Defender\Voter\IpRangeVoter, Hongliang\Defender\Voter\SpiderVoter, Hongliang\Defender\Voter\UriKeywordVoter. 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...
17
        }
18
    }
19
20
    public function vote($key = null)
21
    {
22
        throw new \Exception('The vote method must be implemented in '.static::class);
23
    }
24
25
    protected function getAssets()
26
    {
27
        return $this->assets;
28
    }
29
30
    public function setAssets($assets)
31
    {
32
        $this->assets = $assets;
33
34
        return $this;
35
    }
36
}
37