Completed
Pull Request — master (#15)
by Pavel
19:37
created

LoadingReferenceProvider::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 0
cts 4
cp 0
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
crap 2
1
<?php
2
3
namespace ScayTrase\Api\Cruds;
4
5
use Doctrine\Common\Persistence\ManagerRegistry;
6
7
final class LoadingReferenceProvider implements ReferenceProviderInterface
8
{
9
    /**
10
     * @var ManagerRegistry
11
     */
12
    private $registry;
13
14
    /**
15
     * PartialReferenceProvider constructor.
16
     *
17
     * @param ManagerRegistry $registry
18
     */
19
    public function __construct(ManagerRegistry $registry)
20
    {
21
        $this->registry = $registry;
22
    }
23
24
    /** {@inheritdoc} */
25
    public function getEntityReference($fqcn, $property, $identifier)
26
    {
27
        $metadata = $this->registry->getManagerForClass($fqcn)->getClassMetadata($fqcn);
28
29
        if (!$metadata->hasAssociation($property)) {
30
            return $identifier;
31
        }
32
33
        $target = $metadata->getAssociationTargetClass($property);
34
35
        return $this->registry->getManagerForClass($fqcn)->getPartialReference($target, $identifier);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getPartialReference() does only exist in the following implementations of said interface: Doctrine\ORM\Decorator\EntityManagerDecorator, Doctrine\ORM\EntityManager.

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...
36
    }
37
}
38