Completed
Pull Request — develop (#11)
by Quentin
07:46 queued 04:57
created

AccountLoader   A

Complexity

Total Complexity 1

Size/Duplication

Total Lines 20
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 0%

Importance

Changes 1
Bugs 0 Features 1
Metric Value
wmc 1
c 1
b 0
f 1
lcom 1
cbo 2
dl 0
loc 20
ccs 0
cts 12
cp 0
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
A retrieveOnApplicationByUsername() 0 12 1
1
<?php
2
3
namespace Majora\Component\OAuth\Loader\ORM;
4
5
use Majora\Component\OAuth\Loader\AccountLoaderInterface;
6
use Majora\Component\OAuth\Model\ApplicationInterface;
7
use Majora\Framework\Loader\Bridge\Doctrine\AbstractDoctrineLoader;
8
use Majora\Framework\Loader\Bridge\Doctrine\DoctrineLoaderTrait;
9
10
/**
11
 * ORM Account loading.
12
 */
13
class AccountLoader extends AbstractDoctrineLoader implements AccountLoaderInterface
14
{
15
    use DoctrineLoaderTrait;
16
17
    /**
18
     * @inheritdoc
19
     */
20
    public function retrieveOnApplicationByUsername(ApplicationInterface $application, $username)
21
    {
22
        return $this->entityRepository
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Majora\Framework\Repository\RepositoryInterface as the method createQueryBuilder() does only exist in the following implementations of said interface: Majora\Component\OAuth\R...M\AccessTokenRepository, Majora\Component\OAuth\R...y\ORM\AccountRepository, Majora\Component\OAuth\R...M\ApplicationRepository, Majora\Component\OAuth\R...\RefreshTokenRepository.

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...
23
                    ->createQueryBuilder('ac')
24
                    ->innerJoin('ac.applications', 'app')
25
                    ->where('ac.username = :username')
26
                    ->andWhere('app.id = :application')
27
                    ->setParameter('application', $application->getId())
28
                    ->setParameter('username', $username)
29
                    ->getQuery()
30
                    ->getOneOrNullResult();
31
    }
32
}