vendor/api-platform/core/src/Api/ResourceClassResolver.php line 42

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\Api;
  16. use ApiPlatform\Exception\InvalidArgumentException;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  18. use ApiPlatform\Util\ClassInfoTrait;
  20. /**
  21. * {@inheritdoc}
  22. *
  23. * @author Kévin Dunglas <dunglas@gmail.com>
  24. * @author Samuel ROZE <samuel.roze@gmail.com>
  25. */
  26. final class ResourceClassResolver implements ResourceClassResolverInterface
  27. {
  28. use ClassInfoTrait;
  30. private $resourceNameCollectionFactory;
  31. private $localIsResourceClassCache = [];
  32. private $localMostSpecificResourceClassCache = [];
  34. public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory)
  35. {
  36. $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  37. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. public function getResourceClass($value, string $resourceClass = null, bool $strict = false): string
  43. {
  44. if ($strict && null === $resourceClass) {
  45. throw new InvalidArgumentException('Strict checking is only possible when resource class is specified.');
  46. }
  48. $objectClass = \is_object($value) ? $this->getObjectClass($value) : null;
  49. $actualClass = ($objectClass && (!$value instanceof \Traversable || $this->isResourceClass($objectClass))) ? $this->getObjectClass($value) : null;
  51. if (null === $actualClass && null === $resourceClass) {
  52. throw new InvalidArgumentException('Resource type could not be determined. Resource class must be specified.');
  53. }
  55. if (null !== $actualClass && !$this->isResourceClass($actualClass)) {
  56. throw new InvalidArgumentException(sprintf('No resource class found for object of type "%s".', $actualClass));
  57. }
  59. if (null !== $resourceClass && !$this->isResourceClass($resourceClass)) {
  60. throw new InvalidArgumentException(sprintf('Specified class "%s" is not a resource class.', $resourceClass));
  61. }
  63. if ($strict && null !== $actualClass && !is_a($actualClass, $resourceClass, true)) {
  64. throw new InvalidArgumentException(sprintf('Object of type "%s" does not match "%s" resource class.', $actualClass, $resourceClass));
  65. }
  67. $targetClass = $actualClass ?? $resourceClass;
  69. if (isset($this->localMostSpecificResourceClassCache[$targetClass])) {
  70. return $this->localMostSpecificResourceClassCache[$targetClass];
  71. }
  73. $mostSpecificResourceClass = null;
  75. foreach ($this->resourceNameCollectionFactory->create() as $resourceClassName) {
  76. if (!is_a($targetClass, $resourceClassName, true)) {
  77. continue;
  78. }
  80. if (null === $mostSpecificResourceClass || is_subclass_of($resourceClassName, $mostSpecificResourceClass)) {
  81. $mostSpecificResourceClass = $resourceClassName;
  82. }
  83. }
  85. if (null === $mostSpecificResourceClass) {
  86. throw new \LogicException('Unexpected execution flow.');
  87. }
  89. $this->localMostSpecificResourceClassCache[$targetClass] = $mostSpecificResourceClass;
  91. return $mostSpecificResourceClass;
  92. }
  94. /**
  95. * {@inheritdoc}
  96. */
  97. public function isResourceClass(string $type): bool
  98. {
  99. if (isset($this->localIsResourceClassCache[$type])) {
  100. return $this->localIsResourceClassCache[$type];
  101. }
  103. foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  104. if (is_a($type, $resourceClass, true)) {
  105. return $this->localIsResourceClassCache[$type] = true;
  106. }
  107. }
  109. return $this->localIsResourceClassCache[$type] = false;
  110. }
  111. }
  113. class_alias(ResourceClassResolver::class, \ApiPlatform\Core\Api\ResourceClassResolver::class);