Skip to content

Commit 4823239

Browse files
Seb33300Seb33300
committed
Fix filters on nested associations and embedded properties
1 parent 640e870 commit 4823239

4 files changed

Lines changed: 103 additions & 65 deletions

File tree

‎config/services.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,7 @@
330330

331331
->set(EntityFilterConfigurator::class)
332332
->arg(0, new Reference(AdminUrlGenerator::class))
333+
->arg(1, service(EntityRepository::class))
333334

334335
->set(LanguageFilterConfigurator::class)
335336

‎src/Dto/FilterDataDto.php‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
final class FilterDataDto
99
{
1010
private int $index;
11-
private string $entityAlias;
11+
/** @var array{entity_dto: EntityDto, entity_alias: string, property_name: string} */
12+
private array $resolvedProperty;
1213
private FilterDto $filterDto;
1314
/** @var string */
1415
private $comparison;
@@ -20,14 +21,15 @@ private function __construct()
2021
}
2122

2223
/**
23-
* @param array{comparison: string, value: mixed, value2?: mixed} $formData
24+
* @param array{comparison: string, value: mixed, value2?: mixed} $formData
25+
* @param array{entity_dto: EntityDto, entity_alias: string, property_name: string} $resolvedProperty
2426
*/
25-
public static function new(int $index, FilterDto $filterDto, string $entityAlias, array $formData): self
27+
public static function new(int $index, FilterDto $filterDto, array $resolvedProperty, array $formData): self
2628
{
2729
$filterData = new self();
2830
$filterData->index = $index;
2931
$filterData->filterDto = $filterDto;
30-
$filterData->entityAlias = $entityAlias;
32+
$filterData->resolvedProperty = $resolvedProperty;
3133
$filterData->comparison = $formData['comparison'];
3234
$filterData->value = $formData['value'];
3335
$filterData->value2 = $formData['value2'] ?? null;
@@ -37,12 +39,12 @@ public static function new(int $index, FilterDto $filterDto, string $entityAlias
3739

3840
public function getEntityAlias(): string
3941
{
40-
return $this->entityAlias;
42+
return $this->resolvedProperty['entity_alias'];
4143
}
4244

4345
public function getProperty(): string
4446
{
45-
return $this->filterDto->getProperty();
47+
return $this->resolvedProperty['property_name'];
4648
}
4749

4850
public function getFormTypeOption(string $optionName): mixed
@@ -67,11 +69,11 @@ public function getValue2(): mixed
6769

6870
public function getParameterName(): string
6971
{
70-
return sprintf('%s_%d', str_replace('.', '_', $this->getProperty()), $this->index);
72+
return sprintf('%s_%d', str_replace('.', '_', $this->filterDto->getProperty()), $this->index);
7173
}
7274

7375
public function getParameter2Name(): string
7476
{
75-
return sprintf('%s_%d', str_replace('.', '_', $this->getProperty()), $this->index + 1);
77+
return sprintf('%s_%d', str_replace('.', '_', $this->filterDto->getProperty()), $this->index + 1);
7678
}
7779
}

‎src/Filter/Configurator/EntityConfigurator.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterDto;
1111
use EasyCorp\Bundle\EasyAdminBundle\Filter\EntityFilter;
1212
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\CrudAutocompleteType;
13+
use EasyCorp\Bundle\EasyAdminBundle\Orm\EntityRepository;
1314
use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGeneratorInterface;
1415

1516
/**
@@ -20,6 +21,7 @@ final class EntityConfigurator implements FilterConfiguratorInterface
2021
{
2122
public function __construct(
2223
private AdminUrlGeneratorInterface $adminUrlGenerator,
24+
private EntityRepository $entityRepository,
2325
) {
2426
}
2527

@@ -30,13 +32,12 @@ public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $e
3032

3133
public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): void
3234
{
33-
$propertyName = $filterDto->getProperty();
34-
if (!$entityDto->getClassMetadata()->hasAssociation($propertyName)) {
35-
return;
36-
}
35+
$resolvedProperty = $this->entityRepository->resolveNestedAssociations(null, $entityDto, $filterDto->getProperty(), true);
36+
$entityDto = $resolvedProperty['entity_dto'];
37+
$propertyName = $resolvedProperty['property_name'];
3738

3839
// TODO: add the 'em' form type option too?
39-
$filterDto->setFormTypeOptionIfNotSet('value_type_options.class', $entityDto->getClassMetadata()->getAssociationTargetClass($propertyName));
40+
$filterDto->setFormTypeOptionIfNotSet('value_type_options.class', $entityDto->getFqcn());
4041
$filterDto->setFormTypeOptionIfNotSet('value_type_options.multiple', $entityDto->getClassMetadata()->isCollectionValuedAssociation($propertyName));
4142
$filterDto->setFormTypeOptionIfNotSet('value_type_options.attr.data-ea-widget', 'ea-autocomplete');
4243

‎src/Orm/EntityRepository.php‎

Lines changed: 86 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
2222
use EasyCorp\Bundle\EasyAdminBundle\Factory\FormFactory;
2323
use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
24+
use EasyCorp\Bundle\EasyAdminBundle\Filter\EntityFilter;
2425
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\ComparisonType;
2526
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\FiltersFormType;
2627
use Symfony\Component\Uid\Ulid;
@@ -30,14 +31,17 @@
3031
/**
3132
* @author Javier Eguiluz <javier.eguiluz@gmail.com>
3233
*/
33-
final readonly class EntityRepository implements EntityRepositoryInterface
34+
final class EntityRepository implements EntityRepositoryInterface
3435
{
36+
/** @var array<string, string> */
37+
private array $associationAlreadyJoined = [];
38+
3539
public function __construct(
36-
private AdminContextProviderInterface $adminContextProvider,
37-
private ManagerRegistry $doctrine,
38-
private EntityFactory $entityFactory,
39-
private FormFactory $formFactory,
40-
private EventDispatcherInterface $eventDispatcher,
40+
private readonly AdminContextProviderInterface $adminContextProvider,
41+
private readonly ManagerRegistry $doctrine,
42+
private readonly EntityFactory $entityFactory,
43+
private readonly FormFactory $formFactory,
44+
private readonly EventDispatcherInterface $eventDispatcher,
4145
) {
4246
}
4347

@@ -232,10 +236,18 @@ private function addFilterClause(QueryBuilder $queryBuilder, SearchDto $searchDt
232236
];
233237
}
234238

235-
/** @var string $rootAlias */
236-
$rootAlias = current($queryBuilder->getRootAliases());
239+
try {
240+
$resolvedProperty = $this->resolveNestedAssociations($queryBuilder, $entityDto, $originalPropertyName, EntityFilter::class === $filter->getFqcn());
241+
} catch(\InvalidArgumentException) {
242+
// Fallback to support custom filters with unmapped property names
243+
$resolvedProperty = [
244+
'entity_dto' => $entityDto,
245+
'entity_alias' => current($queryBuilder->getRootAliases()),
246+
'property_name' => $originalPropertyName,
247+
];
248+
}
237249

238-
$filterDataDto = FilterDataDto::new($i, $filter, $rootAlias, $submittedData);
250+
$filterDataDto = FilterDataDto::new($i, $filter, $resolvedProperty, $submittedData);
239251
$filter->apply($queryBuilder, $filterDataDto, $fields->getByProperty($originalPropertyName), $entityDto);
240252

241253
++$i;
@@ -263,47 +275,11 @@ private function getSearchablePropertiesConfig(QueryBuilder $queryBuilder, Searc
263275
$configuredSearchableProperties = $searchDto->getSearchableProperties();
264276
$searchableProperties = (null === $configuredSearchableProperties || 0 === \count($configuredSearchableProperties)) ? $entityDto->getClassMetadata()->getFieldNames() : $configuredSearchableProperties;
265277

266-
$entitiesAlreadyJoined = [];
267278
foreach ($searchableProperties as $searchableProperty) {
268-
// support arbitrarily nested associations (e.g. foo.bar.baz.qux)
269-
$associatedProperties = explode('.', $searchableProperty);
270-
$numAssociatedProperties = \count($associatedProperties);
271-
$parentEntityDto = $entityDto;
272-
$parentEntityAlias = 'entity';
273-
$fullPropertyName = $parentPropertyName = $associatedPropertyName = '';
274-
275-
for ($i = 0; $i < $numAssociatedProperties; ++$i) {
276-
$associatedPropertyName = $associatedProperties[$i];
277-
$fullPropertyName = trim($fullPropertyName.'.'.$associatedPropertyName, '.');
278-
279-
if ($this->isAssociation($parentEntityDto, $associatedPropertyName)) {
280-
if ($i === $numAssociatedProperties - 1) {
281-
throw new \InvalidArgumentException(sprintf('The "%s" property included in the setSearchFields() method is not a valid search field. When using associated properties in search, you must also define the exact field used in the search (e.g. \'%s.id\', \'%s.name\', etc.)', $searchableProperty, $searchableProperty, $searchableProperty));
282-
}
283-
284-
$associatedEntityDto = $this->entityFactory->create($parentEntityDto->getClassMetadata()->getAssociationTargetClass($associatedPropertyName));
285-
286-
if (!isset($entitiesAlreadyJoined[$fullPropertyName])) {
287-
$aliasIndex = \count($entitiesAlreadyJoined);
288-
$entitiesAlreadyJoined[$fullPropertyName] ??= Escaper::escapeDqlAlias($associatedPropertyName.(0 === $aliasIndex ? '' : $aliasIndex));
289-
$queryBuilder->leftJoin(Escaper::escapeDqlAlias($parentEntityAlias).'.'.$associatedPropertyName, $entitiesAlreadyJoined[$fullPropertyName]);
290-
}
291-
292-
$parentEntityDto = $associatedEntityDto;
293-
$parentEntityAlias = $entitiesAlreadyJoined[$fullPropertyName];
294-
$parentPropertyName = '';
295-
} else {
296-
// Normal & Embedded class properties
297-
$associatedPropertyName = $parentPropertyName = trim($parentPropertyName.'.'.$associatedPropertyName, '.');
298-
}
299-
}
300-
301-
if (!isset($parentEntityDto->getClassMetadata()->fieldMappings[$associatedPropertyName])) {
302-
throw new \InvalidArgumentException(sprintf('The "%s" property included in the setSearchFields() method is not a valid search field. The field "%s" does not exist in "%s".', $searchableProperty, $associatedPropertyName, $searchableProperty));
303-
}
279+
$resolvedProperty = $this->resolveNestedAssociations($queryBuilder, $entityDto, $searchableProperty);
304280

305281
// In Doctrine ORM 3.x, FieldMapping implements \ArrayAccess; in 4.x it's an object with properties
306-
$fieldMapping = $parentEntityDto->getClassMetadata()->getFieldMapping($associatedPropertyName);
282+
$fieldMapping = $resolvedProperty['entity_dto']->getClassMetadata()->getFieldMapping($resolvedProperty['property_name']);
307283
// In Doctrine ORM 2.x, getFieldMapping() returns an array
308284
/** @phpstan-ignore-next-line function.impossibleType */
309285
if (\is_array($fieldMapping)) {
@@ -332,16 +308,16 @@ private function getSearchablePropertiesConfig(QueryBuilder $queryBuilder, Searc
332308
&& !$isUlidProperty
333309
&& !$isJsonProperty
334310
) {
335-
$entityFqcn = $parentEntityDto->getFqcn();
311+
$entityFqcn = $resolvedProperty['entity_dto']->getFqcn();
336312

337313
/** @var \ReflectionNamedType|\ReflectionUnionType|null $idClassType */
338314
$idClassType = null;
339315
$reflectionClass = new \ReflectionClass($entityFqcn);
340316

341317
// this is needed to handle inherited properties
342318
while (false !== $reflectionClass) {
343-
if ($reflectionClass->hasProperty($associatedPropertyName)) {
344-
$reflection = $reflectionClass->getProperty($associatedPropertyName);
319+
if ($reflectionClass->hasProperty($resolvedProperty['property_name'])) {
320+
$reflection = $reflectionClass->getProperty($resolvedProperty['property_name']);
345321
$idClassType = $reflection->getType();
346322
break;
347323
}
@@ -360,9 +336,9 @@ private function getSearchablePropertiesConfig(QueryBuilder $queryBuilder, Searc
360336
}
361337

362338
$searchablePropertiesConfig[] = [
363-
'entity_name' => $parentEntityAlias,
339+
'entity_name' => $resolvedProperty['entity_alias'],
364340
'property_data_type' => $propertyDataType,
365-
'property_name' => $associatedPropertyName,
341+
'property_name' => $resolvedProperty['property_name'],
366342
'is_boolean' => $isBoolean,
367343
'is_small_integer' => $isSmallIntegerProperty,
368344
'is_integer' => $isIntegerProperty,
@@ -377,6 +353,64 @@ private function getSearchablePropertiesConfig(QueryBuilder $queryBuilder, Searc
377353
return $searchablePropertiesConfig;
378354
}
379355

356+
/**
357+
* Support arbitrarily nested associations (e.g. foo.bar.baz.qux).
358+
*
359+
* @return array{
360+
* entity_dto: EntityDto,
361+
* entity_alias: string,
362+
* property_name: string,
363+
* }
364+
*/
365+
public function resolveNestedAssociations(?QueryBuilder $queryBuilder, EntityDto $rootEntityDto, string $propertyName, bool $mustEndWithAssociation = false): array
366+
{
367+
$associatedProperties = explode('.', $propertyName);
368+
$numAssociatedProperties = \count($associatedProperties);
369+
$resolvedEntityDto = $rootEntityDto;
370+
$parentEntityAlias = 'entity';
371+
$fullPropertyName = $compoundPropertyName = $resolvedPropertyName = '';
372+
373+
for ($i = 0; $i < $numAssociatedProperties; ++$i) {
374+
$resolvedPropertyName = trim($compoundPropertyName.'.'.$associatedProperties[$i], '.');
375+
$fullPropertyName = trim($fullPropertyName.'.'.$resolvedPropertyName, '.');
376+
377+
if ($this->isAssociation($resolvedEntityDto, $resolvedPropertyName)) {
378+
$resolvedEntityDto = $this->entityFactory->create($resolvedEntityDto->getClassMetadata()->getAssociationTargetClass($resolvedPropertyName));
379+
380+
if ($i === $numAssociatedProperties - 1) {
381+
if (!$mustEndWithAssociation) {
382+
throw new \InvalidArgumentException(sprintf('The "%s" property is not valid. When using associated properties, you must also define the exact field to target (e.g. "%s.id", "%s.name", etc.)', $propertyName, $propertyName, $propertyName));
383+
}
384+
385+
// Skip join when the last property is an association
386+
continue;
387+
}
388+
389+
if (isset($queryBuilder) && !isset($this->associationAlreadyJoined[$fullPropertyName])) {
390+
$aliasIndex = \count($this->associationAlreadyJoined);
391+
$this->associationAlreadyJoined[$fullPropertyName] ??= Escaper::escapeDqlAlias($resolvedPropertyName.(0 === $aliasIndex ? '' : $aliasIndex));
392+
$queryBuilder->leftJoin(Escaper::escapeDqlAlias($parentEntityAlias).'.'.$resolvedPropertyName, $this->associationAlreadyJoined[$fullPropertyName]);
393+
}
394+
395+
$parentEntityAlias = $this->associationAlreadyJoined[$fullPropertyName] ?? null;
396+
$compoundPropertyName = '';
397+
} else {
398+
// Normal & Embedded class properties
399+
$compoundPropertyName = $resolvedPropertyName;
400+
}
401+
}
402+
403+
if (!$mustEndWithAssociation && !isset($resolvedEntityDto->getClassMetadata()->fieldMappings[$resolvedPropertyName])) {
404+
throw new \InvalidArgumentException(sprintf('The "%s" property is not valid. The field "%s" does not exist in "%s".', $propertyName, $resolvedPropertyName, $propertyName));
405+
}
406+
407+
return [
408+
'entity_dto' => $resolvedEntityDto,
409+
'entity_alias' => $parentEntityAlias,
410+
'property_name' => $resolvedPropertyName,
411+
];
412+
}
413+
380414
private function isAssociation(EntityDto $entityDto, string $propertyName): bool
381415
{
382416
$propertyNameParts = explode('.', $propertyName, 2);

0 commit comments

Comments
 (0)