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

  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\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;
  25. trait LinksHandlerTrait
  26. {
  27.     private ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory;
  29.     /**
  30.      * @return Link[]
  31.      */
  32.     private function getLinks(string $resourceClass, Operation $operation, array $context): array
  33.     {
  34.         $links = $this->getOperationLinks($operation);
  36.         if (!($linkClass = $context['linkClass'] ?? false)) {
  37.             return $links;
  38.         }
  40.         $newLink = null;
  41.         $linkProperty = $context['linkProperty'] ?? null;
  43.         foreach ($links as $link) {
  44.             if ($linkClass === $link->getFromClass() && $linkProperty === $link->getFromProperty()) {
  45.                 $newLink = $link;
  46.                 break;
  47.             }
  48.         }
  50.         if ($newLink) {
  51.             return [$newLink];
  52.         }
  54.         if (!$this->resourceMetadataCollectionFactory) {
  55.             return [];
  56.         }
  58.         // Using GraphQL, it's possible that we won't find a GraphQL Operation of the same type (e.g. it is disabled).
  59.         try {
  60.             $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($linkClass);
  61.             $linkedOperation = $resourceMetadataCollection->getOperation($operation->getName());
  62.         } catch (OperationNotFoundException $e) {
  63.             if (!$operation instanceof GraphQlOperation) {
  64.                 throw $e;
  65.             }
  67.             // Instead, we'll look for the first Query available.
  68.             foreach ($resourceMetadataCollection as $resourceMetadata) {
  69.                 foreach ($resourceMetadata->getGraphQlOperations() as $op) {
  70.                     if ($op instanceof Query) {
  71.                         $linkedOperation = $op;
  72.                     }
  73.                 }
  74.             }
  75.         }
  77.         foreach ($this->getOperationLinks($linkedOperation ?? null) as $link) {
  78.             if ($resourceClass === $link->getToClass() && $linkProperty === $link->getFromProperty()) {
  79.                 $newLink = $link;
  80.                 break;
  81.             }
  82.         }
  84.         if (!$newLink) {
  85.             throw new RuntimeException(sprintf('The class "%s" cannot be retrieved from "%s".', $resourceClass, $linkClass));
  86.         }
  88.         return [$newLink];
  89.     }
  91.     private function getIdentifierValue(array &$identifiers, string $name = null): mixed
  92.     {
  93.         if (isset($identifiers[$name])) {
  94.             $value = $identifiers[$name];
  95.             unset($identifiers[$name]);
  97.             return $value;
  98.         }
  100.         return array_shift($identifiers);
  101.     }
  103.     private function getOperationLinks(Operation $operation = null): array
  104.     {
  105.         if ($operation instanceof GraphQlOperation) {
  106.             return $operation->getLinks() ?? [];
  107.         }
  109.         if ($operation instanceof HttpOperation) {
  110.             return $operation->getUriVariables() ?? [];
  111.         }
  113.         return [];
  114.     }
  115. }