vendor/api-platform/core/src/Symfony/EventListener/JsonApi/TransformFieldsetsParametersListener.php line 44

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\Symfony\EventListener\JsonApi;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
  20. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. /**
  23.  * @see http://jsonapi.org/format/#fetching-sparse-fieldsets
  24.  * @see https://api-platform.com/docs/core/filters#property-filter
  25.  *
  26.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  27.  */
  28. final class TransformFieldsetsParametersListener
  29. {
  30.     /**
  31.      * @var ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface
  32.      */
  33.     private $resourceMetadataFactory;
  35.     public function __construct($resourceMetadataFactory)
  36.     {
  37.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  39.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  40.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  41.         }
  42.     }
  44.     public function onKernelRequest(RequestEvent $event): void
  45.     {
  46.         $request = $event->getRequest();
  48.         $queryParameters = $request->query->all();
  49.         $includeParameter = $queryParameters['include'] ?? null;
  50.         $fieldsParameter = $queryParameters['fields'] ?? null;
  52.         if (
  53.             (!$fieldsParameter && !$includeParameter) ||
  54.             ($fieldsParameter && !\is_array($fieldsParameter)) ||
  55.             (!\is_string($includeParameter)) ||
  56.             'jsonapi' !== $request->getRequestFormat() ||
  57.             !($resourceClass = $request->attributes->get('_api_resource_class'))
  58.         ) {
  59.             return;
  60.         }
  62.         $includeParameter = explode(',', $includeParameter);
  63.         if (!$fieldsParameter) {
  64.             $request->attributes->set('_api_included', $includeParameter);
  66.             return;
  67.         }
  69.         /** @var ResourceMetadata|ResourceMetadataCollection */
  70.         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  71.         $resourceShortName = $resourceMetadata instanceof ResourceMetadata ? $resourceMetadata->getShortName() : $resourceMetadata->getOperation()->getShortName();
  73.         $properties = [];
  74.         foreach ($fieldsParameter as $resourceType => $fields) {
  75.             $fields = explode(',', $fields);
  77.             if ($resourceShortName === $resourceType) {
  78.                 $properties = array_merge($properties, $fields);
  79.             } elseif (\in_array($resourceType, $includeParameter, true)) {
  80.                 $properties[$resourceType] = $fields;
  82.                 $request->attributes->set('_api_included', array_merge($request->attributes->get('_api_included', []), [$resourceType]));
  83.             } else {
  84.                 $properties[$resourceType] = $fields;
  85.             }
  86.         }
  88.         $request->attributes->set('_api_filter_property', $properties);
  89.     }
  90. }
  92. class_alias(TransformFieldsetsParametersListener::class, \ApiPlatform\Core\JsonApi\EventListener\TransformFieldsetsParametersListener::class);