doctrine /
orm
| Total Complexity | 64 |
| Total Lines | 434 |
| Duplicated Lines | 0 % |
| Coverage | 98.93% |
| Changes | 5 | ||
| Bugs | 0 | Features | 0 |
Complex classes like DefaultQueryCache often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use DefaultQueryCache, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 41 | class DefaultQueryCache implements QueryCache |
||
| 42 | { |
||
| 43 | /** |
||
| 44 | * @var \Doctrine\ORM\EntityManagerInterface |
||
| 45 | */ |
||
| 46 | private $em; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * @var \Doctrine\ORM\UnitOfWork |
||
| 50 | */ |
||
| 51 | private $uow; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var \Doctrine\ORM\Cache\Region |
||
| 55 | */ |
||
| 56 | private $region; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var \Doctrine\ORM\Cache\QueryCacheValidator |
||
| 60 | */ |
||
| 61 | private $validator; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var \Doctrine\ORM\Cache\Logging\CacheLogger |
||
| 65 | */ |
||
| 66 | protected $cacheLogger; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var array |
||
| 70 | */ |
||
| 71 | private static $hints = [Query::HINT_CACHE_ENABLED => true]; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @param \Doctrine\ORM\EntityManagerInterface $em The entity manager. |
||
| 75 | * @param \Doctrine\ORM\Cache\Region $region The query region. |
||
| 76 | */ |
||
| 77 | 87 | public function __construct(EntityManagerInterface $em, Region $region) |
|
| 86 | 87 | } |
|
| 87 | |||
| 88 | /** |
||
| 89 | * {@inheritdoc} |
||
| 90 | */ |
||
| 91 | 53 | public function get(QueryCacheKey $key, ResultSetMapping $rsm, array $hints = []) |
|
| 92 | { |
||
| 93 | 53 | if ( ! ($key->cacheMode & Cache::MODE_GET)) { |
|
| 94 | 3 | return null; |
|
| 95 | } |
||
| 96 | |||
| 97 | 52 | $cacheEntry = $this->region->get($key); |
|
| 98 | |||
| 99 | 52 | if ( ! $cacheEntry instanceof QueryCacheEntry) { |
|
| 100 | 47 | return null; |
|
| 101 | } |
||
| 102 | |||
| 103 | 39 | if ( ! $this->validator->isValid($key, $cacheEntry)) { |
|
| 104 | 8 | $this->region->evict($key); |
|
| 105 | |||
| 106 | 8 | return null; |
|
| 107 | } |
||
| 108 | |||
| 109 | 34 | $result = []; |
|
| 110 | 34 | $entityName = reset($rsm->aliasMap); |
|
| 111 | 34 | $hasRelation = ! empty($rsm->relationMap); |
|
| 112 | 34 | $persister = $this->uow->getEntityPersister($entityName); |
|
| 113 | 34 | assert($persister instanceof CachedEntityPersister); |
|
| 114 | |||
| 115 | 34 | $region = $persister->getCacheRegion(); |
|
| 116 | 34 | $regionName = $region->getName(); |
|
| 117 | |||
| 118 | 34 | $cm = $this->em->getClassMetadata($entityName); |
|
| 119 | |||
| 120 | 34 | $generateKeys = static function (array $entry) use ($cm): EntityCacheKey { |
|
| 121 | 34 | return new EntityCacheKey($cm->rootEntityName, $entry['identifier']); |
|
|
Bug
introduced
by
|
|||
| 122 | 34 | }; |
|
| 123 | |||
| 124 | 34 | $cacheKeys = new CollectionCacheEntry(array_map($generateKeys, $cacheEntry->result)); |
|
| 125 | 34 | $entries = $region->getMultiple($cacheKeys) ?? []; |
|
| 126 | |||
| 127 | // @TODO - move to cache hydration component |
||
| 128 | 34 | foreach ($cacheEntry->result as $index => $entry) { |
|
| 129 | 34 | $entityEntry = $entries[$index] ?? null; |
|
| 130 | |||
| 131 | 34 | if (! $entityEntry instanceof EntityCacheEntry) { |
|
| 132 | 3 | if ($this->cacheLogger !== null) { |
|
| 133 | 1 | $this->cacheLogger->entityCacheMiss($regionName, $cacheKeys->identifiers[$index]); |
|
| 134 | } |
||
| 135 | |||
| 136 | 3 | return null; |
|
| 137 | } |
||
| 138 | |||
| 139 | 32 | if ($this->cacheLogger !== null) { |
|
| 140 | 29 | $this->cacheLogger->entityCacheHit($regionName, $cacheKeys->identifiers[$index]); |
|
| 141 | } |
||
| 142 | |||
| 143 | 32 | if ( ! $hasRelation) { |
|
| 144 | 23 | $result[$index] = $this->uow->createEntity($entityEntry->class, $entityEntry->resolveAssociationEntries($this->em), self::$hints); |
|
| 145 | |||
| 146 | 23 | continue; |
|
| 147 | } |
||
| 148 | |||
| 149 | 9 | $data = $entityEntry->data; |
|
| 150 | |||
| 151 | 9 | foreach ($entry['associations'] as $name => $assoc) { |
|
| 152 | 9 | $assocPersister = $this->uow->getEntityPersister($assoc['targetEntity']); |
|
| 153 | 9 | $assocRegion = $assocPersister->getCacheRegion(); |
|
| 154 | 9 | $assocMetadata = $this->em->getClassMetadata($assoc['targetEntity']); |
|
| 155 | |||
| 156 | 9 | if ($assoc['type'] & ClassMetadata::TO_ONE) { |
|
| 157 | |||
| 158 | 5 | if (($assocEntry = $assocRegion->get($assocKey = new EntityCacheKey($assocMetadata->rootEntityName, $assoc['identifier']))) === null) { |
|
| 159 | |||
| 160 | 1 | if ($this->cacheLogger !== null) { |
|
| 161 | 1 | $this->cacheLogger->entityCacheMiss($assocRegion->getName(), $assocKey); |
|
| 162 | } |
||
| 163 | |||
| 164 | 1 | $this->uow->hydrationComplete(); |
|
| 165 | |||
| 166 | 1 | return null; |
|
| 167 | } |
||
| 168 | |||
| 169 | 4 | $data[$name] = $this->uow->createEntity($assocEntry->class, $assocEntry->resolveAssociationEntries($this->em), self::$hints); |
|
| 170 | |||
| 171 | 4 | if ($this->cacheLogger !== null) { |
|
| 172 | 4 | $this->cacheLogger->entityCacheHit($assocRegion->getName(), $assocKey); |
|
| 173 | } |
||
| 174 | |||
| 175 | 4 | continue; |
|
| 176 | } |
||
| 177 | |||
| 178 | 4 | if ( ! isset($assoc['list']) || empty($assoc['list'])) { |
|
| 179 | continue; |
||
| 180 | } |
||
| 181 | |||
| 182 | 4 | $generateKeys = function ($id) use ($assocMetadata): EntityCacheKey { |
|
| 183 | 4 | return new EntityCacheKey($assocMetadata->rootEntityName, $id); |
|
| 184 | 4 | }; |
|
| 185 | |||
| 186 | 4 | $collection = new PersistentCollection($this->em, $assocMetadata, new ArrayCollection()); |
|
| 187 | 4 | $assocKeys = new CollectionCacheEntry(array_map($generateKeys, $assoc['list'])); |
|
| 188 | 4 | $assocEntries = $assocRegion->getMultiple($assocKeys); |
|
| 189 | |||
| 190 | 4 | foreach ($assoc['list'] as $assocIndex => $assocId) { |
|
| 191 | 4 | $assocEntry = is_array($assocEntries) && array_key_exists($assocIndex, $assocEntries) ? $assocEntries[$assocIndex] : null; |
|
| 192 | |||
| 193 | 4 | if ($assocEntry === null) { |
|
| 194 | 1 | if ($this->cacheLogger !== null) { |
|
| 195 | 1 | $this->cacheLogger->entityCacheMiss($assocRegion->getName(), $assocKeys->identifiers[$assocIndex]); |
|
| 196 | } |
||
| 197 | |||
| 198 | 1 | $this->uow->hydrationComplete(); |
|
| 199 | |||
| 200 | 1 | return null; |
|
| 201 | } |
||
| 202 | |||
| 203 | 3 | $element = $this->uow->createEntity($assocEntry->class, $assocEntry->resolveAssociationEntries($this->em), self::$hints); |
|
| 204 | |||
| 205 | 3 | $collection->hydrateSet($assocIndex, $element); |
|
| 206 | |||
| 207 | 3 | if ($this->cacheLogger !== null) { |
|
| 208 | 3 | $this->cacheLogger->entityCacheHit($assocRegion->getName(), $assocKeys->identifiers[$assocIndex]); |
|
| 209 | } |
||
| 210 | } |
||
| 211 | |||
| 212 | 3 | $data[$name] = $collection; |
|
| 213 | |||
| 214 | 3 | $collection->setInitialized(true); |
|
| 215 | } |
||
| 216 | |||
| 217 | 7 | foreach ($data as $fieldName => $unCachedAssociationData) { |
|
| 218 | // In some scenarios, such as EAGER+ASSOCIATION+ID+CACHE, the |
||
| 219 | // cache key information in `$cacheEntry` will not contain details |
||
| 220 | // for fields that are associations. |
||
| 221 | // |
||
| 222 | // This means that `$data` keys for some associations that may |
||
| 223 | // actually not be cached will not be converted to actual association |
||
| 224 | // data, yet they contain L2 cache AssociationCacheEntry objects. |
||
| 225 | // |
||
| 226 | // We need to unwrap those associations into proxy references, |
||
| 227 | // since we don't have actual data for them except for identifiers. |
||
| 228 | 7 | if ($unCachedAssociationData instanceof AssociationCacheEntry) { |
|
| 229 | 4 | $data[$fieldName] = $this->em->getReference( |
|
| 230 | 4 | $unCachedAssociationData->class, |
|
| 231 | 7 | $unCachedAssociationData->identifier |
|
| 232 | ); |
||
| 233 | } |
||
| 234 | } |
||
| 235 | |||
| 236 | 7 | $result[$index] = $this->uow->createEntity($entityEntry->class, $data, self::$hints); |
|
| 237 | } |
||
| 238 | |||
| 239 | 29 | $this->uow->hydrationComplete(); |
|
| 240 | |||
| 241 | 29 | return $result; |
|
| 242 | } |
||
| 243 | |||
| 244 | /** |
||
| 245 | * {@inheritdoc} |
||
| 246 | */ |
||
| 247 | 58 | public function put(QueryCacheKey $key, ResultSetMapping $rsm, $result, array $hints = []) |
|
| 248 | { |
||
| 249 | 58 | if ($rsm->scalarMappings) { |
|
| 250 | 1 | throw new CacheException("Second level cache does not support scalar results."); |
|
| 251 | } |
||
| 252 | |||
| 253 | 57 | if (count($rsm->entityMappings) > 1) { |
|
| 254 | 1 | throw new CacheException("Second level cache does not support multiple root entities."); |
|
| 255 | } |
||
| 256 | |||
| 257 | 56 | if ( ! $rsm->isSelect) { |
|
| 258 | 2 | throw new CacheException("Second-level cache query supports only select statements."); |
|
| 259 | } |
||
| 260 | |||
| 261 | 54 | if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD]) && $hints[Query::HINT_FORCE_PARTIAL_LOAD]) { |
|
| 262 | 1 | throw new CacheException("Second level cache does not support partial entities."); |
|
| 263 | } |
||
| 264 | |||
| 265 | 53 | if ( ! ($key->cacheMode & Cache::MODE_PUT)) { |
|
| 266 | 3 | return false; |
|
| 267 | } |
||
| 268 | |||
| 269 | 52 | $data = []; |
|
| 270 | 52 | $entityName = reset($rsm->aliasMap); |
|
| 271 | 52 | $rootAlias = key($rsm->aliasMap); |
|
| 272 | 52 | $persister = $this->uow->getEntityPersister($entityName); |
|
| 273 | |||
| 274 | 52 | if (! $persister instanceof CachedEntityPersister) { |
|
| 275 | 1 | throw CacheException::nonCacheableEntity($entityName); |
|
| 276 | } |
||
| 277 | |||
| 278 | 51 | $region = $persister->getCacheRegion(); |
|
| 279 | |||
| 280 | 51 | foreach ($result as $index => $entity) { |
|
| 281 | 51 | $identifier = $this->uow->getEntityIdentifier($entity); |
|
| 282 | 51 | $entityKey = new EntityCacheKey($entityName, $identifier); |
|
| 283 | |||
| 284 | 51 | if (($key->cacheMode & Cache::MODE_REFRESH) || ! $region->contains($entityKey)) { |
|
| 285 | // Cancel put result if entity put fail |
||
| 286 | 36 | if ( ! $persister->storeEntityCache($entity, $entityKey)) { |
|
| 287 | 1 | return false; |
|
| 288 | } |
||
| 289 | } |
||
| 290 | |||
| 291 | 50 | $data[$index]['identifier'] = $identifier; |
|
| 292 | 50 | $data[$index]['associations'] = []; |
|
| 293 | |||
| 294 | // @TODO - move to cache hydration components |
||
| 295 | 50 | foreach ($rsm->relationMap as $alias => $name) { |
|
| 296 | 15 | $parentAlias = $rsm->parentAliasMap[$alias]; |
|
| 297 | 15 | $parentClass = $rsm->aliasMap[$parentAlias]; |
|
| 298 | 15 | $metadata = $this->em->getClassMetadata($parentClass); |
|
| 299 | 15 | $assoc = $metadata->associationMappings[$name]; |
|
| 300 | 15 | $assocValue = $this->getAssociationValue($rsm, $alias, $entity); |
|
| 301 | |||
| 302 | 15 | if ($assocValue === null) { |
|
| 303 | 1 | continue; |
|
| 304 | } |
||
| 305 | |||
| 306 | // root entity association |
||
| 307 | 14 | if ($rootAlias === $parentAlias) { |
|
| 308 | // Cancel put result if association put fail |
||
| 309 | 14 | if ( ($assocInfo = $this->storeAssociationCache($key, $assoc, $assocValue)) === null) { |
|
| 310 | 2 | return false; |
|
| 311 | } |
||
| 312 | |||
| 313 | 12 | $data[$index]['associations'][$name] = $assocInfo; |
|
| 314 | |||
| 315 | 12 | continue; |
|
| 316 | } |
||
| 317 | |||
| 318 | // store single nested association |
||
| 319 | 2 | if ( ! is_array($assocValue)) { |
|
| 320 | // Cancel put result if association put fail |
||
| 321 | 1 | if ($this->storeAssociationCache($key, $assoc, $assocValue) === null) { |
|
| 322 | return false; |
||
| 323 | } |
||
| 324 | |||
| 325 | 1 | continue; |
|
| 326 | } |
||
| 327 | |||
| 328 | // store array of nested association |
||
| 329 | 1 | foreach ($assocValue as $aVal) { |
|
| 330 | // Cancel put result if association put fail |
||
| 331 | 1 | if ($this->storeAssociationCache($key, $assoc, $aVal) === null) { |
|
| 332 | 48 | return false; |
|
| 333 | } |
||
| 334 | } |
||
| 335 | } |
||
| 336 | } |
||
| 337 | |||
| 338 | 48 | return $this->region->put($key, new QueryCacheEntry($data)); |
|
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * @param \Doctrine\ORM\Cache\QueryCacheKey $key |
||
| 343 | * @param array $assoc |
||
| 344 | * @param mixed $assocValue |
||
| 345 | * |
||
| 346 | * @return array|null |
||
| 347 | */ |
||
| 348 | 14 | private function storeAssociationCache(QueryCacheKey $key, array $assoc, $assocValue) |
|
| 394 | ]; |
||
| 395 | } |
||
| 396 | |||
| 397 | /** |
||
| 398 | * @param \Doctrine\ORM\Query\ResultSetMapping $rsm |
||
| 399 | * @param string $assocAlias |
||
| 400 | * @param object $entity |
||
| 401 | * |
||
| 402 | * @return array|object |
||
| 403 | */ |
||
| 404 | 16 | private function getAssociationValue(ResultSetMapping $rsm, $assocAlias, $entity) |
|
| 405 | { |
||
| 406 | 16 | $path = []; |
|
| 407 | 16 | $alias = $assocAlias; |
|
| 408 | |||
| 409 | 16 | while (isset($rsm->parentAliasMap[$alias])) { |
|
| 410 | 16 | $parent = $rsm->parentAliasMap[$alias]; |
|
| 411 | 16 | $field = $rsm->relationMap[$alias]; |
|
| 412 | 16 | $class = $rsm->aliasMap[$parent]; |
|
| 413 | |||
| 414 | 16 | array_unshift($path, [ |
|
| 415 | 16 | 'field' => $field, |
|
| 416 | 16 | 'class' => $class |
|
| 417 | ] |
||
| 418 | ); |
||
| 419 | |||
| 420 | 16 | $alias = $parent; |
|
| 421 | } |
||
| 422 | |||
| 423 | 16 | return $this->getAssociationPathValue($entity, $path); |
|
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * @param mixed $value |
||
| 428 | * @param array $path |
||
| 429 | * |
||
| 430 | * @return array|object|null |
||
| 431 | */ |
||
| 432 | 16 | private function getAssociationPathValue($value, array $path) |
|
| 433 | { |
||
| 434 | 16 | $mapping = array_shift($path); |
|
| 435 | 16 | $metadata = $this->em->getClassMetadata($mapping['class']); |
|
| 436 | 16 | $assoc = $metadata->associationMappings[$mapping['field']]; |
|
| 437 | 16 | $value = $metadata->getFieldValue($value, $mapping['field']); |
|
| 438 | |||
| 439 | 16 | if ($value === null) { |
|
| 440 | 1 | return null; |
|
| 441 | } |
||
| 442 | |||
| 443 | 15 | if (empty($path)) { |
|
| 444 | 15 | return $value; |
|
| 445 | } |
||
| 446 | |||
| 447 | // Handle *-to-one associations |
||
| 448 | 3 | if ($assoc['type'] & ClassMetadata::TO_ONE) { |
|
| 449 | 1 | return $this->getAssociationPathValue($value, $path); |
|
| 450 | } |
||
| 451 | |||
| 452 | 2 | $values = []; |
|
| 453 | |||
| 454 | 2 | foreach ($value as $item) { |
|
| 455 | 2 | $values[] = $this->getAssociationPathValue($item, $path); |
|
| 456 | } |
||
| 457 | |||
| 458 | 2 | return $values; |
|
| 459 | } |
||
| 460 | |||
| 461 | /** |
||
| 462 | * {@inheritdoc} |
||
| 463 | */ |
||
| 464 | 48 | public function clear() |
|
| 467 | } |
||
| 468 | |||
| 469 | /** |
||
| 470 | * {@inheritdoc} |
||
| 471 | */ |
||
| 472 | 28 | public function getRegion() |
|
| 475 | } |
||
| 476 | } |
||
| 477 |
Loading history...
