Failed Conditions
Push — master ( 2ade86...13f838 )
by Jonathan
18s
created

DefaultEntityHydrator   A

Complexity

Total Complexity 25

Size/Duplication

Total Lines 166
Duplicated Lines 2.41 %

Coupling/Cohesion

Components 1
Dependencies 9

Test Coverage

Coverage 94.67%

Importance

Changes 0
Metric Value
wmc 25
lcom 1
cbo 9
dl 4
loc 166
ccs 71
cts 75
cp 0.9467
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 6 1
C loadCacheEntry() 4 48 10
C buildCacheEntry() 0 76 14

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
/*
4
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15
 *
16
 * This software consists of voluntary contributions made by many individuals
17
 * and is licensed under the MIT license. For more information, see
18
 * <http://www.doctrine-project.org>.
19
 */
20
21
namespace Doctrine\ORM\Cache;
22
23
use Doctrine\Common\Util\ClassUtils;
24
25
use Doctrine\ORM\Query;
26
use Doctrine\ORM\Mapping\ClassMetadata;
27
use Doctrine\ORM\EntityManagerInterface;
28
use Doctrine\ORM\Utility\IdentifierFlattener;
29
30
/**
31
 * Default hydrator cache for entities
32
 *
33
 * @since   2.5
34
 * @author  Fabio B. Silva <[email protected]>
35
 */
36
class DefaultEntityHydrator implements EntityHydrator
37
{
38
    /**
39
     * @var \Doctrine\ORM\EntityManagerInterface
40
     */
41
    private $em;
42
43
    /**
44
     * @var \Doctrine\ORM\UnitOfWork
45
     */
46
    private $uow;
47
48
    /**
49
     * The IdentifierFlattener used for manipulating identifiers
50
     *
51
     * @var \Doctrine\ORM\Utility\IdentifierFlattener
52
     */
53
    private $identifierFlattener;
54
55
    /**
56
     * @var array
57
     */
58
    private static $hints = [Query::HINT_CACHE_ENABLED => true];
59
60
    /**
61
     * @param \Doctrine\ORM\EntityManagerInterface $em The entity manager.
62
     */
63 215
    public function __construct(EntityManagerInterface $em)
64
    {
65 215
        $this->em   = $em;
66 215
        $this->uow  = $em->getUnitOfWork();
67 215
        $this->identifierFlattener = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
68 215
    }
69
70
    /**
71
     * {@inheritdoc}
72
     */
73 117
    public function buildCacheEntry(ClassMetadata $metadata, EntityCacheKey $key, $entity)
74
    {
75 117
        $data = $this->uow->getOriginalEntityData($entity);
76 117
        $data = array_merge($data, $metadata->getIdentifierValues($entity)); // why update has no identifier values ?
77
78 117
        foreach ($metadata->associationMappings as $name => $assoc) {
79 71
            if ( ! isset($data[$name])) {
80 26
                continue;
81
            }
82
83 70
            if ( ! ($assoc['type'] & ClassMetadata::TO_ONE)) {
84 59
                unset($data[$name]);
85
86 59
                continue;
87
            }
88
89 69
            if ( ! isset($assoc['cache'])) {
90 5
                $targetClassMetadata = $this->em->getClassMetadata($assoc['targetEntity']);
91 5
                $owningAssociation   = ( ! $assoc['isOwningSide'])
92 1
                    ? $targetClassMetadata->associationMappings[$assoc['mappedBy']]
0 ignored issues
show
Bug introduced by
Accessing associationMappings on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
93 5
                    : $assoc;
94 5
                $associationIds      = $this->identifierFlattener->flattenIdentifier(
95 5
                    $targetClassMetadata,
0 ignored issues
show
Compatibility introduced by
$targetClassMetadata of type object<Doctrine\Common\P...\Mapping\ClassMetadata> is not a sub-type of object<Doctrine\ORM\Mapping\ClassMetadata>. It seems like you assume a concrete implementation of the interface Doctrine\Common\Persistence\Mapping\ClassMetadata to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
96 5
                    $targetClassMetadata->getIdentifierValues($data[$name])
97
                );
98
99 5
                unset($data[$name]);
100
101 5
                foreach ($associationIds as $fieldName => $fieldValue) {
102 5
                    if (isset($targetClassMetadata->fieldMappings[$fieldName])) {
0 ignored issues
show
Bug introduced by
Accessing fieldMappings on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
103 5
                        $fieldMapping = $targetClassMetadata->fieldMappings[$fieldName];
0 ignored issues
show
Bug introduced by
Accessing fieldMappings on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
104
105 5
                        $data[$owningAssociation['targetToSourceKeyColumns'][$fieldMapping['columnName']]] = $fieldValue;
106
107 5
                        continue;
108
                    }
109
110 1
                    $targetAssoc = $targetClassMetadata->associationMappings[$fieldName];
0 ignored issues
show
Bug introduced by
Accessing associationMappings on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
111
112 1
                    foreach($assoc['targetToSourceKeyColumns'] as $referencedColumn => $localColumn) {
113 1
                        if (isset($targetAssoc['sourceToTargetKeyColumns'][$referencedColumn])) {
114 1
                            $data[$localColumn] = $fieldValue;
115
                        }
116
                    }
117
                }
118
119 5
                continue;
120
            }
121
122 65
            if ( ! isset($assoc['id'])) {
123 64
                $targetClass = ClassUtils::getClass($data[$name]);
124 64
                $targetId    = $this->uow->getEntityIdentifier($data[$name]);
125 64
                $data[$name] = new AssociationCacheEntry($targetClass, $targetId);
126
127 64
                continue;
128
            }
129
130
            // handle association identifier
131 5
            $targetId = is_object($data[$name]) && $this->uow->isInIdentityMap($data[$name])
132 5
                ? $this->uow->getEntityIdentifier($data[$name])
133 5
                : $data[$name];
134
135
            // @TODO - fix it !
136
            // handle UnitOfWork#createEntity hash generation
137 5
            if ( ! is_array($targetId)) {
138
                $data[reset($assoc['joinColumnFieldNames'])] = $targetId;
139
140
                $targetEntity = $this->em->getClassMetadata($assoc['targetEntity']);
141
                $targetId     = [$targetEntity->identifier[0] => $targetId];
0 ignored issues
show
Bug introduced by
Accessing identifier on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
142
            }
143
144 5
            $data[$name] = new AssociationCacheEntry($assoc['targetEntity'], $targetId);
145
        }
146
147 117
        return new EntityCacheEntry($metadata->name, $data);
148
    }
149
150
    /**
151
     * {@inheritdoc}
152
     */
153 41
    public function loadCacheEntry(ClassMetadata $metadata, EntityCacheKey $key, EntityCacheEntry $entry, $entity = null)
154
    {
155 41
        $data  = $entry->data;
156 41
        $hints = self::$hints;
157
158 41 View Code Duplication
        if ($entity !== null) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
159 6
            $hints[Query::HINT_REFRESH]         = true;
160 6
            $hints[Query::HINT_REFRESH_ENTITY]  = $entity;
161
        }
162
163 41
        foreach ($metadata->associationMappings as $name => $assoc) {
164 34
            if ( ! isset($assoc['cache']) ||  ! isset($data[$name])) {
165 27
                continue;
166
            }
167
168 28
            $assocClass     = $data[$name]->class;
169 28
            $assocId        = $data[$name]->identifier;
170 28
            $isEagerLoad    = ($assoc['fetch'] === ClassMetadata::FETCH_EAGER || ($assoc['type'] === ClassMetadata::ONE_TO_ONE && ! $assoc['isOwningSide']));
171
172 28
            if ( ! $isEagerLoad) {
173 26
                $data[$name] = $this->em->getReference($assocClass, $assocId);
174
175 26
                continue;
176
            }
177
178 3
            $assocMetadata  = $this->em->getClassMetadata($assoc['targetEntity']);
179 3
            $assocKey       = new EntityCacheKey($assocMetadata->rootEntityName, $assocId);
0 ignored issues
show
Bug introduced by
Accessing rootEntityName on the interface Doctrine\Common\Persistence\Mapping\ClassMetadata suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
180 3
            $assocPersister = $this->uow->getEntityPersister($assoc['targetEntity']);
181 3
            $assocRegion    = $assocPersister->getCacheRegion();
182 3
            $assocEntry     = $assocRegion->get($assocKey);
183
184 3
            if ($assocEntry === null) {
185
                return null;
186
            }
187
188 3
            $data[$name] = $this->uow->createEntity($assocEntry->class, $assocEntry->resolveAssociationEntries($this->em), $hints);
189
        }
190
191 41
        if ($entity !== null) {
192 6
            $this->uow->registerManaged($entity, $key->identifier, $data);
193
        }
194
195 41
        $result = $this->uow->createEntity($entry->class, $data, $hints);
196
197 41
        $this->uow->hydrationComplete();
198
199 41
        return $result;
200
    }
201
}
202