vendor/api-platform/core/src/Symfony/Bundle/DataCollector/RequestDataCollector.php line 39

  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\Symfony\Bundle\DataCollector;
  16. use ApiPlatform\Metadata\ApiResource;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\Util\RequestAttributesExtractor;
  19. use PackageVersions\Versions;
  20. use Psr\Container\ContainerInterface;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  24. use Symfony\Component\VarDumper\Cloner\Data;
  26. /**
  27.  * @author Julien DENIAU <julien.deniau@gmail.com>
  28.  * @author Anthony GRASSIOT <antograssiot@free.fr>
  29.  */
  30. final class RequestDataCollector extends DataCollector
  31. {
  32.     public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $metadataFactory, private readonly ContainerInterface $filterLocator)
  33.     {
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function collect(Request $request, Response $response, \Throwable $exception = null): void
  40.     {
  41.         if ($request->attributes->get('_graphql', false)) {
  42.             $resourceClasses = array_keys($request->attributes->get('_graphql_args', []));
  43.         } else {
  44.             $resourceClasses = array_filter([$request->attributes->get('_api_resource_class')]);
  45.         }
  47.         $requestAttributes = RequestAttributesExtractor::extractAttributes($request);
  48.         if (isset($requestAttributes['previous_data'])) {
  49.             $requestAttributes['previous_data'] = $this->cloneVar($requestAttributes['previous_data']);
  50.         }
  52.         $this->data['request_attributes'] = $requestAttributes;
  53.         $this->data['acceptable_content_types'] = $request->getAcceptableContentTypes();
  54.         $this->data['resources'] = array_map(fn (string $resourceClass): DataCollected => $this->collectDataByResource($resourceClass, $request), $resourceClasses);
  55.     }
  57.     private function setFilters(ApiResource $resourceMetadata, int $index, array &$filters, array &$counters): void
  58.     {
  59.         foreach ($resourceMetadata->getFilters() ?? [] as $id) {
  60.             if ($this->filterLocator->has($id)) {
  61.                 $filters[$index][$id] = $this->filterLocator->get($id)::class;
  62.                 continue;
  63.             }
  65.             $filters[$index][$id] = null;
  66.             ++$counters['ignored_filters'];
  67.         }
  68.     }
  70.     public function getVersion(): ?string
  71.     {
  72.         if (!class_exists(Versions::class)) {
  73.             return null;
  74.         }
  76.         $version = Versions::getVersion('api-platform/core');
  77.         preg_match('/^v(.*?)@/', (string) $version, $output);
  79.         return $output[1] ?? strtok($version, '@');
  80.     }
  82.     /**
  83.      * {@inheritdoc}
  84.      */
  85.     public function getName(): string
  86.     {
  87.         return 'api_platform.data_collector.request';
  88.     }
  90.     public function getData(): array|Data
  91.     {
  92.         return $this->data;
  93.     }
  95.     public function getAcceptableContentTypes(): array
  96.     {
  97.         return $this->data['acceptable_content_types'] ?? [];
  98.     }
  100.     public function getRequestAttributes(): array
  101.     {
  102.         return $this->data['request_attributes'] ?? [];
  103.     }
  105.     public function getResources(): array
  106.     {
  107.         return $this->data['resources'] ?? [];
  108.     }
  110.     /**
  111.      * {@inheritdoc}
  112.      */
  113.     public function reset(): void
  114.     {
  115.         $this->data = [];
  116.     }
  118.     private function collectDataByResource(string $resourceClass, Request $request): DataCollected
  119.     {
  120.         $resourceMetadataCollection = $resourceClass ? $this->metadataFactory->create($resourceClass) : [];
  121.         $filters = [];
  122.         $counters = ['ignored_filters' => 0];
  123.         $resourceMetadataCollectionData = [];
  125.         /** @var ApiResource $resourceMetadata */
  126.         foreach ($resourceMetadataCollection as $index => $resourceMetadata) {
  127.             $this->setFilters($resourceMetadata, $index, $filters, $counters);
  128.             $resourceMetadataCollectionData[] = [
  129.                 'resource' => $resourceMetadata,
  130.                 'operations' => null !== $resourceMetadata->getOperations() ? iterator_to_array($resourceMetadata->getOperations()) : [],
  131.             ];
  132.         }
  134.         return new DataCollected(
  135.             $resourceClass,
  136.             $this->cloneVar($resourceMetadataCollectionData),
  137.             $filters,
  138.             $counters
  139.         );
  140.     }
  141. }