vendor/api-platform/core/src/Core/Api/CachedIdentifiersExtractor.php line 39

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Api;
  16. use ApiPlatform\Util\ResourceClassInfoTrait;
  17. use Psr\Cache\CacheException;
  18. use Psr\Cache\CacheItemPoolInterface;
  19. use Symfony\Component\PropertyAccess\PropertyAccess;
  20. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  22. /**
  23. * {@inheritdoc}
  24. *
  25. * @author Antoine Bluchet <soyuka@gmail.com>
  26. */
  27. final class CachedIdentifiersExtractor implements IdentifiersExtractorInterface
  28. {
  29. use ResourceClassInfoTrait;
  31. public const CACHE_KEY_PREFIX = 'iri_identifiers';
  33. private $cacheItemPool;
  34. private $propertyAccessor;
  35. private $decorated;
  36. private $localCache = [];
  37. private $localResourceCache = [];
  39. public function __construct(CacheItemPoolInterface $cacheItemPool, IdentifiersExtractorInterface $decorated, PropertyAccessorInterface $propertyAccessor = null, ResourceClassResolverInterface $resourceClassResolver = null)
  40. {
  41. $this->cacheItemPool = $cacheItemPool;
  42. $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  43. $this->decorated = $decorated;
  44. $this->resourceClassResolver = $resourceClassResolver;
  46. if (null === $this->resourceClassResolver) {
  47. @trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
  48. }
  49. }
  51. /**
  52. * {@inheritdoc}
  53. */
  54. public function getIdentifiersFromResourceClass(string $resourceClass): array
  55. {
  56. if (isset($this->localResourceCache[$resourceClass])) {
  57. return $this->localResourceCache[$resourceClass];
  58. }
  60. return $this->localResourceCache[$resourceClass] = $this->decorated->getIdentifiersFromResourceClass($resourceClass);
  61. }
  63. /**
  64. * {@inheritdoc}
  65. */
  66. public function getIdentifiersFromItem($item): array
  67. {
  68. $keys = $this->getKeys($item, function ($item) use (&$identifiers) {
  69. return $identifiers = $this->decorated->getIdentifiersFromItem($item);
  70. });
  72. if (null !== $identifiers) {
  73. return $identifiers;
  74. }
  76. $identifiers = [];
  77. foreach ($keys as $propertyName) {
  78. $identifiers[$propertyName] = $this->propertyAccessor->getValue($item, $propertyName);
  80. if (!\is_object($identifiers[$propertyName])) {
  81. continue;
  82. }
  84. if (null === $relatedResourceClass = $this->getResourceClass($identifiers[$propertyName])) {
  85. continue;
  86. }
  88. if (!$relatedIdentifiers = $this->localCache[$relatedResourceClass] ?? false) {
  89. $relatedCacheKey = self::CACHE_KEY_PREFIX.md5($relatedResourceClass);
  90. try {
  91. $relatedCacheItem = $this->cacheItemPool->getItem($relatedCacheKey);
  92. if (!$relatedCacheItem->isHit()) {
  93. return $this->decorated->getIdentifiersFromItem($item);
  94. }
  95. } catch (CacheException $e) {
  96. return $this->decorated->getIdentifiersFromItem($item);
  97. }
  99. $relatedIdentifiers = $relatedCacheItem->get();
  100. }
  102. $identifiers[$propertyName] = $this->propertyAccessor->getValue($identifiers[$propertyName], $relatedIdentifiers[0]);
  103. }
  105. return $identifiers;
  106. }
  108. private function getKeys($item, callable $retriever): array
  109. {
  110. $resourceClass = $this->getObjectClass($item);
  111. if (isset($this->localCache[$resourceClass])) {
  112. return $this->localCache[$resourceClass];
  113. }
  115. try {
  116. $cacheItem = $this->cacheItemPool->getItem(self::CACHE_KEY_PREFIX.md5($resourceClass));
  117. } catch (CacheException $e) {
  118. return $this->localCache[$resourceClass] = array_keys($retriever($item));
  119. }
  121. if ($cacheItem->isHit()) {
  122. return $this->localCache[$resourceClass] = $cacheItem->get();
  123. }
  125. $keys = array_keys($retriever($item));
  127. $cacheItem->set($keys);
  128. $this->cacheItemPool->save($cacheItem);
  130. return $this->localCache[$resourceClass] = $keys;
  131. }
  132. }