symfony · evgenij-vy · May 18, 2025 · May 18, 2025 · May 18, 2025
diff --git a/...ymfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionAsset/DoctrineFilterInterface.php b/...ymfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionAsset/DoctrineFilterInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionAsset;
+
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Bridge\Doctrine\Attribute\MapEntityCollection;
+use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
+use Symfony\Component\HttpFoundation\Request;
+
+#[AutoconfigureTag]
+interface DoctrineFilterInterface
+{
+    public function applyFilter(
+        QueryBuilder $queryBuilder,
+        MapEntityCollection $attribute,
+        Request $request,
+        ?object $queryStringObject = null,
+    ): void;
+}
diff --git a/src/Symfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionAsset/MappingType.php b/src/Symfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionAsset/MappingType.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionAsset;
+
+enum MappingType: string
+{
+    case IGNORE = 'ignore';
+    case LIMIT = 'limit';
+    case OFFSET = 'offset';
+    case PAGE = 'page';
+    case NULL = 'null';
+    case NOT_NULL = 'notNull';
+    case CURRENT_USER_EXPRESSION = 'currentUserExpression';
+}
diff --git a/src/Symfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionResolver.php b/src/Symfony/Bridge/Doctrine/ArgumentResolver/EntityCollectionResolver.php
@@ -0,0 +1,213 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Bridge\Doctrine\ArgumentResolver;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Tools\Pagination\Paginator;
+use Doctrine\Persistence\ManagerRegistry;
+use LogicException;
+use Psr\Container\ContainerInterface;
+use Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionAsset\DoctrineFilterInterface;
+use Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionAsset\MappingType;
+use Symfony\Bridge\Doctrine\Attribute\MapEntityCollection;
+use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\ExpressionLanguage\Expression;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\AsTargetedValueResolver;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+
+#[AsTargetedValueResolver]
+class EntityCollectionResolver implements ValueResolverInterface
+{
+    public const QUERY_ROOT_ALIAS = 'ecr';
+
+    public function __construct(
+        private ManagerRegistry $registry,
+        private TokenInterface $token,
+        #[AutowireLocator(DoctrineFilterInterface::class)]
+        private ContainerInterface $container,
+        private PropertyInfoExtractorInterface $propertyInfoExtractor,
+        private PropertyAccessorInterface $propertyAccessor
+    )
+    {
+    }
+
+    public function resolve(Request $request, ArgumentMetadata $argument): iterable
+    {
+        return $argument->getAttributesOfType(MapEntityCollection::class, ArgumentMetadata::IS_INSTANCEOF);
+    }
+
+    #[AsEventListener(priority: -10)]
+    public function mapEntityCollection(ControllerArgumentsEvent $event): void
+    {
+        $arguments = $event->getArguments();
+        foreach ($arguments as $key => $argument) {
+            if ($argument instanceof MapEntityCollection) {
+                $arguments[$key] = $this->doResolve($argument, $event);
+                $event->setArguments($arguments);
+                break;
+            }
+        }
+    }
+
+    private function doResolve(MapEntityCollection $attribute, ControllerArgumentsEvent $event): object|iterable
+    {
+        $objectManager = $this->registry->getManagerForClass($attribute->getClass());
+
+        if (!$objectManager instanceof EntityManagerInterface) {
+            throw new \RuntimeException(sprintf('No manager found for class "%s".', $attribute->getClass()));
+        }
+
+        $queryBuilder = $objectManager
+            ->getRepository($attribute->getClass())
+            ->createQueryBuilder(self::QUERY_ROOT_ALIAS);
+
+        $this->doctrineParameterProcessing($queryBuilder, $attribute->getDoctrineParameters(), $event);
+
+        $queryStringObject = $attribute->getQueryString() ?
+            $event->getNamedArguments()[$attribute->getQueryString()] : null;
+
+        foreach ($attribute->getFilters() as $filter) {
+            /** @var DoctrineFilterInterface $queryFilter */
+            $queryFilter = $this->container->get($filter);
+            $queryFilter->applyFilter($queryBuilder, $attribute, $event->getRequest(), $queryStringObject);
+        }
+
+        if ($queryStringObject) {
+            $limit = null;
+            $offset = null;
+            $page = null;
+            foreach ($this->propertyInfoExtractor->getProperties($queryStringObject) as $property) {
+                $propertyMapping = $attribute->getQueryMapping()[$property] ?? null;
+                $value = $this->propertyAccessor->getValue($queryStringObject, $property);
+
+                switch ($propertyMapping) {
+                    case MappingType::LIMIT:
+                        $limit = $value;
+                        break;
+                    case MappingType::OFFSET:
+                        $offset = $value;
+                        break;
+                    case MappingType::PAGE:
+                        $page = $value;
+                        break;
+                    case MappingType::IGNORE:
+                        break;
+                    default:
+                        $this->addCondition($queryBuilder, $property, $value);
+                }
+            }
+
+            if (null !== $page || null !== $offset) {
+                if (!$limit) {
+                    throw new UnprocessableEntityHttpException(
+                        'The "limit" parameter is required when using "page" or "offset".'
+                    );
+                }
+
+                $queryBuilder
+                    ->setMaxResults($limit)
+                    ->setFirstResult($offset ? $offset : ($page - 1) * $limit);
+            }
+        }
+
+        if (!$queryBuilder->getDQLPart('orderBy')) {
+            foreach ($attribute->getDefaultOrdering() as $property => $direction) {
+                $queryBuilder->addOrderBy(
+                    $this->getQueryProperty(
+                        $attribute->getNameConverter() ?
+                            $attribute->getNameConverter()->denormalize($property) : $property
+                    ),
+                    $direction->value
+                );
+            }
+        }
+
+        return $attribute->isReturnPaginator() ? new Paginator($queryBuilder) : $queryBuilder->getQuery()->getResult();
+    }
+
+    /**
+     * @param array<string, mixed> $parameters
+     */
+    private function doctrineParameterProcessing(
+        QueryBuilder $queryBuilder,
+        array $parameters,
+        ControllerArgumentsEvent $event
+    ): void
+    {
+        foreach ($parameters as $key => $value) {
+            if (in_array($value, [MappingType::LIMIT, MappingType::PAGE, MappingType::OFFSET], true)) {
+                throw new LogicException(sprintf('Doctrine parameter "%s" is not supported.', $value));
+            }
+
+            $this->addCondition(
+                queryBuilder: $queryBuilder,
+                propertyName: $key,
+                value: $this->buildValue($value, $event->getRequest()->attributes->all())
+            );
+        }
+    }
+
+    private function addCondition(QueryBuilder $queryBuilder, string $propertyName, mixed $value): void
+    {
+        if (MappingType::IGNORE === $value) {
+            return;
+        }
+
+        $expr = $queryBuilder->expr();
+        $queryPropertyAlias = $this->getQueryProperty($propertyName);
+
+        if (MappingType::NULL === $value) {
+            $expression = $expr->isNull($queryPropertyAlias);
+        } elseif (MappingType::NOT_NULL) {
+            $expression = $expr->isNotNull($queryPropertyAlias);
+        } elseif (is_array($value)) {
+            $expression = $expr->in($queryPropertyAlias, $value);
+        } else {
+            $expression = $expr->eq($queryPropertyAlias, $value);
+        }
+
+        $queryBuilder->andWhere($expression);
+    }
+
+    /**
+     * @param array<string, mixed> $additionalData
+     */
+    private function buildValue(mixed $value, array $additionalData = []): mixed
+    {
+        if (is_string($value) && isset($additionalData[$value])) {
+            return $additionalData[$value];
+        }
+
+        if ($value instanceof Expression) {
+            return (new ExpressionLanguage())->evaluate($value, ['user' => $this->token->getUser()]);
+        }
+
+        return $value;
+    }
+
+    private function getQueryProperty(string $property): string
+    {
+        return sprintf('%s.%s', self::QUERY_ROOT_ALIAS, $property);
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Attribute/MapEntityCollection.php b/src/Symfony/Bridge/Doctrine/Attribute/MapEntityCollection.php
@@ -0,0 +1,101 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Bridge\Doctrine\Attribute;
+
+use Attribute;
+use Doctrine\Common\Collections\Order;
+use Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionAsset\DoctrineFilterInterface;
+use Symfony\Bridge\Doctrine\ArgumentResolver\EntityCollectionResolver;
+use Symfony\Component\HttpKernel\Attribute\ValueResolver;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+class MapEntityCollection extends ValueResolver
+{
+    /**
+     * @param class-string $class
+     * @param array<string, string> $queryMapping
+     * @param array<string, mixed> $doctrineParameters
+     * @param class-string<DoctrineFilterInterface>[] $filters
+     * @param array<string, Order> $defaultOrdering
+     */
+    public function __construct(
+        private readonly string $class,
+        private readonly ?string $queryString = null,
+        private readonly array $queryMapping = [],
+        private readonly array $doctrineParameters = [],
+        private readonly array $filters = [],
+        private readonly array $defaultOrdering = [],
+        private readonly bool $returnPaginator = true,
+        private readonly ?NameConverterInterface $nameConverter = null,
+    )
+    {
+        parent::__construct(EntityCollectionResolver::class);
+    }
+
+    /**
+     * @return class-string
+     */
+    public function getClass(): string
+    {
+        return $this->class;
+    }
+
+    public function getQueryString(): ?string
+    {
+        return $this->queryString;
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getQueryMapping(): array
+    {
+        return $this->queryMapping;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getDoctrineParameters(): array
+    {
+        return $this->doctrineParameters;
+    }
+
+    /**
+     * @return class-string<DoctrineFilterInterface>[]
+     */
+    public function getFilters(): array
+    {
+        return $this->filters;
+    }
+
+    /**
+     * @return array<string, Order>
+     */
+    public function getDefaultOrdering(): array
+    {
+        return $this->defaultOrdering;
+    }
+
+    public function isReturnPaginator(): bool
+    {
+        return $this->returnPaginator;
+    }
+
+    public function getNameConverter(): ?NameConverterInterface
+    {
+        return $this->nameConverter;
+    }
+}