vendor/api-platform/core/src/Doctrine/Common/State/LinksHandlerTrait.php line 105

  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\Doctrine\Common\State;
  16. use ApiPlatform\Exception\OperationNotFoundException;
  17. use ApiPlatform\Metadata\Exception\RuntimeException;
  18. use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
  19. use ApiPlatform\Metadata\GraphQl\Query;
  20. use ApiPlatform\Metadata\HttpOperation;
  21. use ApiPlatform\Metadata\Link;
  22. use ApiPlatform\Metadata\Operation;
  23. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  24. use Psr\Container\ContainerInterface;
  26. trait LinksHandlerTrait
  27. {
  28.     private ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory;
  29.     private ?ContainerInterface $handleLinksLocator;
  31.     /**
  32.      * @return Link[]
  33.      */
  34.     private function getLinks(string $resourceClass, Operation $operation, array $context): array
  35.     {
  36.         $links = $this->getOperationLinks($operation);
  38.         if (!($linkClass = $context['linkClass'] ?? false)) {
  39.             return $links;
  40.         }
  42.         $newLink = null;
  43.         $linkProperty = $context['linkProperty'] ?? null;
  45.         foreach ($links as $link) {
  46.             if ($linkClass === $link->getFromClass() && $linkProperty === $link->getFromProperty()) {
  47.                 $newLink = $link;
  48.                 break;
  49.             }
  50.         }
  52.         if ($newLink) {
  53.             return [$newLink];
  54.         }
  56.         if (!$this->resourceMetadataCollectionFactory) {
  57.             return [];
  58.         }
  60.         // Using GraphQL, it's possible that we won't find a GraphQL Operation of the same type (e.g. it is disabled).
  61.         try {
  62.             $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($linkClass);
  63.             $linkedOperation = $resourceMetadataCollection->getOperation($operation->getName());
  64.         } catch (OperationNotFoundException $e) {
  65.             if (!$operation instanceof GraphQlOperation) {
  66.                 throw $e;
  67.             }
  69.             // Instead, we'll look for the first Query available.
  70.             foreach ($resourceMetadataCollection as $resourceMetadata) {
  71.                 foreach ($resourceMetadata->getGraphQlOperations() as $op) {
  72.                     if ($op instanceof Query) {
  73.                         $linkedOperation = $op;
  74.                     }
  75.                 }
  76.             }
  77.         }
  79.         foreach ($this->getOperationLinks($linkedOperation ?? null) as $link) {
  80.             if ($resourceClass === $link->getToClass() && $linkProperty === $link->getFromProperty()) {
  81.                 $newLink = $link;
  82.                 break;
  83.             }
  84.         }
  86.         if (!$newLink) {
  87.             throw new RuntimeException(sprintf('The class "%s" cannot be retrieved from "%s".', $resourceClass, $linkClass));
  88.         }
  90.         return [$newLink];
  91.     }
  93.     private function getIdentifierValue(array &$identifiers, string $name = null): mixed
  94.     {
  95.         if (isset($identifiers[$name])) {
  96.             $value = $identifiers[$name];
  97.             unset($identifiers[$name]);
  99.             return $value;
  100.         }
  102.         return array_shift($identifiers);
  103.     }
  105.     private function getOperationLinks(Operation $operation = null): array
  106.     {
  107.         if ($operation instanceof GraphQlOperation) {
  108.             return $operation->getLinks() ?? [];
  109.         }
  111.         if ($operation instanceof HttpOperation) {
  112.             return $operation->getUriVariables() ?? [];
  113.         }
  115.         return [];
  116.     }
  118.     private function getLinksHandler(Operation $operation): ?callable
  119.     {
  120.         if (!($options = $operation->getStateOptions()) || !method_exists($options, 'getHandleLinks') || null === $options->getHandleLinks()) {
  121.             return null;
  122.         }
  124.         $handleLinks = $options->getHandleLinks(); // @phpstan-ignore-line method_exists called above
  125.         if (\is_callable($handleLinks)) {
  126.             return $handleLinks;
  127.         }
  129.         if ($this->handleLinksLocator && \is_string($handleLinks) && $this->handleLinksLocator->has($handleLinks)) {
  130.             return [$this->handleLinksLocator->get($handleLinks), 'handleLinks'];
  131.         }
  133.         throw new RuntimeException(sprintf('Could not find handleLinks service "%s"', $handleLinks));
  134.     }
  135. }