ConfirmEmailHandler::handle()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 1
1
<?php
2
3
declare (strict_types = 1);
4
5
namespace HMLB\UserBundle\Handler;
6
7
use HMLB\DDD\Message\Command\Command;
8
use HMLB\DDD\Message\Command\Handler;
9
use HMLB\UserBundle\Command\ConfirmEmail;
10
use HMLB\UserBundle\User\User;
11
use HMLB\UserBundle\User\UserRepository;
12
13
class ConfirmEmailHandler implements Handler
14
{
15
    /**
16
     * @var UserRepository
17
     */
18
    private $userRepository;
19
20
    /**
21
     * @param UserRepository $userRepository
22
     */
23
    public function __construct(UserRepository $userRepository)
24
    {
25
        $this->userRepository = $userRepository;
26
    }
27
28
    /**
29
     * @param Command|ConfirmEmail $command
30
     */
31
    public function handle(Command $command)
32
    {
33
        /** @var User $user */
34
        $user = $this->userRepository->get($command->getUserId());
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class HMLB\DDD\Message\Command\Command as the method getUserId() does only exist in the following sub-classes of HMLB\DDD\Message\Command\Command: HMLB\UserBundle\Command\ChangeEmail, HMLB\UserBundle\Command\ChangePassword, HMLB\UserBundle\Command\ConfirmEmail, HMLB\UserBundle\Command\RequestEmailValidation, HMLB\UserBundle\Command\RequestPasswordReset, HMLB\UserBundle\Command\ResetPassword. 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...
35
        $user->confirmEmail($command->getConfirmationToken());
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class HMLB\DDD\Message\Command\Command as the method getConfirmationToken() does only exist in the following sub-classes of HMLB\DDD\Message\Command\Command: HMLB\UserBundle\Command\ConfirmEmail. 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...
36
    }
37
}
38