vendor/api-platform/core/src/Serializer/SerializerFilterContextBuilder.php line 35

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\Serializer;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Exception\RuntimeException;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Serializer\Filter\FilterInterface;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use Psr\Container\ContainerInterface;
  22. use Symfony\Component\HttpFoundation\Request;
  24. /**
  25.  * {@inheritdoc}
  26.  *
  27.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  28.  */
  29. final class SerializerFilterContextBuilder implements SerializerContextBuilderInterface
  30. {
  31.     private $decorated;
  32.     private $filterLocator;
  33.     private $resourceMetadataFactory;
  35.     public function __construct($resourceMetadataFactory, ContainerInterface $filterLocator, SerializerContextBuilderInterface $decorated)
  36.     {
  37.         $this->decorated = $decorated;
  38.         $this->filterLocator = $filterLocator;
  39.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  40.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  41.         }
  43.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      */
  49.     public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
  50.     {
  51.         if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
  52.             throw new RuntimeException('Request attributes are not valid.');
  53.         }
  55.         $context = $this->decorated->createFromRequest($request, $normalization, $attributes);
  57.         // TODO: remove in 3.0
  58.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  59.             $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  60.             $resourceFilters = $resourceMetadata->getOperationAttribute($attributes, 'filters', [], true);
  61.         } else {
  62.             $resourceFilters = $this->resourceMetadataFactory->create($attributes['resource_class'])->getOperation($attributes['operation_name'] ?? null)->getFilters();
  63.         }
  65.         if (!$resourceFilters) {
  66.             return $context;
  67.         }
  69.         foreach ($resourceFilters as $filterId) {
  70.             if ($this->filterLocator->has($filterId) && ($filter = $this->filterLocator->get($filterId)) instanceof FilterInterface) {
  71.                 $filter->apply($request, $normalization, $attributes, $context);
  72.             }
  73.         }
  75.         return $context;
  76.     }
  77. }
  79. class_alias(SerializerFilterContextBuilder::class, \ApiPlatform\Core\Serializer\SerializerFilterContextBuilder::class);