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

  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;
  29.     private array $localIsResourceClassCache = [];
  30.     private array $localMostSpecificResourceClassCache = [];
  32.     public function __construct(private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory)
  33.     {
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function getResourceClass(mixed $value, string $resourceClass = null, bool $strict = false): string
  40.     {
  41.         if ($strict && null === $resourceClass) {
  42.             throw new InvalidArgumentException('Strict checking is only possible when resource class is specified.');
  43.         }
  45.         $objectClass = \is_object($value) ? $this->getObjectClass($value) : null;
  46.         $actualClass = ($objectClass && (!$value instanceof \Traversable || $this->isResourceClass($objectClass))) ? $this->getObjectClass($value) : null;
  48.         if (null === $actualClass && null === $resourceClass) {
  49.             throw new InvalidArgumentException('Resource type could not be determined. Resource class must be specified.');
  50.         }
  52.         if (null !== $actualClass && !$this->isResourceClass($actualClass)) {
  53.             throw new InvalidArgumentException(sprintf('No resource class found for object of type "%s".', $actualClass));
  54.         }
  56.         if (null !== $resourceClass && !$this->isResourceClass($resourceClass)) {
  57.             throw new InvalidArgumentException(sprintf('Specified class "%s" is not a resource class.', $resourceClass));
  58.         }
  60.         if ($strict && null !== $actualClass && !is_a($actualClass, $resourceClass, true)) {
  61.             throw new InvalidArgumentException(sprintf('Object of type "%s" does not match "%s" resource class.', $actualClass, $resourceClass));
  62.         }
  64.         $targetClass = $actualClass ?? $resourceClass;
  66.         if (isset($this->localMostSpecificResourceClassCache[$targetClass])) {
  67.             return $this->localMostSpecificResourceClassCache[$targetClass];
  68.         }
  70.         $mostSpecificResourceClass = null;
  72.         foreach ($this->resourceNameCollectionFactory->create() as $resourceClassName) {
  73.             if (!is_a($targetClass, $resourceClassName, true)) {
  74.                 continue;
  75.             }
  77.             if (null === $mostSpecificResourceClass || is_subclass_of($resourceClassName, $mostSpecificResourceClass)) {
  78.                 $mostSpecificResourceClass = $resourceClassName;
  79.             }
  80.         }
  82.         if (null === $mostSpecificResourceClass) {
  83.             throw new \LogicException('Unexpected execution flow.');
  84.         }
  86.         $this->localMostSpecificResourceClassCache[$targetClass] = $mostSpecificResourceClass;
  88.         return $mostSpecificResourceClass;
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function isResourceClass(string $type): bool
  95.     {
  96.         if (isset($this->localIsResourceClassCache[$type])) {
  97.             return $this->localIsResourceClassCache[$type];
  98.         }
  100.         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  101.             if (is_a($type, $resourceClass, true)) {
  102.                 return $this->localIsResourceClassCache[$type] = true;
  103.             }
  104.         }
  106.         return $this->localIsResourceClassCache[$type] = false;
  107.     }
  108. }