Use filters on nested properties by jazayam · Pull Request #4882 · EasyCorp/EasyAdminBundle

jazayam · 2021-12-09T10:48:46Z

This PR makes filters support properties with dot notation by using a new filter as wrapper.

The NestedConfigurator is able to configure the wrapped filter by (re)invoking the configurators collection and copy configured FormType and options to display the correct wrapped filter view.
The NestedFilter is able to apply required left joins for a given path and delegate query customization to wrapped filter by recreating adapted arguments (like FilterDataDto and EntityDto)

There is no tests for now, but i can add it if you are interested by the purpose.

jazayam · 2021-12-09T10:51:09Z

Closes #4881

npotier · 2021-12-21T08:51:28Z

Thanks @Marcachips for this PR 👍

DylanKas · 2022-02-10T11:29:14Z

This PR is really interesting and can be very useful. Is there any plan to merge it ?
Does it need some adjustment or help ?

Ang3 · 2022-04-20T10:56:13Z

Hi,

Any news about this feature?.. We still cannot use filters on embedded properties...
Please review priorities, I think this is a primary feature, more than light/dark mode or others front enhancements...
Many PR's about it for months and nothing. :(

quentint · 2022-09-20T12:59:39Z

Hey there, currently facing an issue this PR would fix, merging would be really great.

Is there anything I/we can do to help?

25matt12 · 2022-12-19T18:20:00Z

Is there any reason this PR is still not merged ? It would be great to have the possibility to filter on nested properties !

kiler129 · 2023-01-06T21:38:26Z

I think the most important thing here are missing tests - I doubt @javiereguiluz will merge it without them.

tonyellow · 2023-01-14T11:30:18Z

same here, would be nice if it will be merged.

msphn · 2023-01-17T10:09:53Z

@Marcachips will you add tests or do you need help?

jazayam · 2023-01-18T08:30:04Z

I plan to write tests before the end of this week. I don't need help for now, but thanks 👍

tonyellow · 2023-01-21T20:28:10Z

@kiler129 i know but this one doesnt work wost nested entities, like product.category

jazayam · 2023-01-23T09:00:10Z

Tests are pushed !

Snowbaha · 2023-02-28T15:40:06Z

Hello, your PR looks very nice, what are the "blocked point" now?

mathis-ait · 2023-02-28T15:41:19Z

Hello, this PR will be very helpful

b1rdex · 2023-03-01T14:59:08Z

+    /** @var FilterInterface */
+    private $wrappedFilter;
+
+    public static function new(string $propertyName, string $label = null): self


I don't see a reason for this method to be present, it just confuses more. There is no new() method in FilterInterface, so I think this should be removed.

Also, I see a point in renaming wrap() to new() to make it more natural alongside with other filters.

b1rdex · 2023-03-01T15:04:17Z

+/**
+ * @author Brandon Marcachi <brandon.marcachi@gmail.com>
+ */
+final class NestedFilter implements FilterInterface


Could you please elaborate a bit: can this be implemented without adding NestedFilter? Why you chose this way?

For me, it looks much more natural to not have a wrapper for filters – similar to Fields. Just add a dot to filter and you're done... Isn't it?

Hello,

Thank you for the PR and the review. Not sure but I think it's much more complex than just add a dot tbh. Otherwise I really don't understand why this feature is not already implemented. I did a PR for that job and I had to modify much more files to handle all cases due to internal mechanism : #4840

astronati · 2023-07-21T22:11:52Z

Any news about this PR?

fdiedler · 2023-08-06T11:00:25Z

@Marcachips @javiereguiluz Any news for this great feature ?
I need this feature in my current project :)
Thanks

jazayam · 2023-08-16T08:13:22Z

Hello @javiereguiluz !
Can we get visibility into the progress of this Pull Request ?
Do I need to take any additional actions ?

wehostadm · 2023-09-18T09:08:44Z

Ping of this great feature @javiereguiluz @Marcachips
Hope it will be merged soon :)

Quentin-Sch · 2023-10-16T09:36:25Z

Ping ?

Sa-Lat · 2023-10-18T13:12:38Z

i would also like to have it fixed to get my filter working as intended ♥

MrJuliuss · 2023-12-18T15:03:28Z

Hi, up ?

BrunoJunior · 2024-02-28T14:18:39Z

@javiereguiluz Some news about this PR ? Thanks

d3pendent · 2024-03-19T10:04:48Z

I would also welcome this feature.

JesusRedGar · 2024-05-10T10:59:55Z

No news on this one?

teklakct · 2024-06-09T15:42:53Z

If you cannot wait for this MR please check my naive implementation.
You only need to add 2 files to your source code.

https://gist.github.com/teklakct/ed154ccadc18b1463a139f09d3286355

Works with v4.9.4

PS. I think there is an option to slightly enhance the EasyCorp\Bundle\EasyAdminBundle\Factory\FilterFactory and achieve similar behavior. I will try to check this someday.

ToshY · 2024-12-31T11:57:22Z

Just got notifications that related issues have been automatically closed (#4881 (comment), #4966 (comment)), so I'm not sure if this will get merged anytime soon 🙁.

javiereguiluz · 2024-12-31T11:59:39Z

@ToshY we're closing many old issues automatically ... for PRs, I'll review them manually to see if they are still relevant and if we can reuse parts of them.

ToshY · 2024-12-31T12:10:12Z

@ToshY we're closing many old issues automatically ... for PRs, I'll review them manually to see if they are still relevant and if we can reuse parts of them.

@javiereguiluz Thanks for the clarification. It would still be nice to have a PR like this getting merged.

johndodev · 2025-01-23T16:16:05Z

up, I think it's a must have.
Don't know about the PR but The @teklakct solution is woking well and seems relatively simple :
#4882 (comment)

finnef · 2025-02-03T14:02:45Z

I did not have time to do things properly in a fork and PR, but here is the rerolled patch to apply to EA 4.24 to enable the NestedFilter.

ea-filters-nested-properties.patch

chapterjason · 2025-03-01T22:30:00Z

+        $wrappedFilterDto->setProperty($targetProperty);
+
+        // Apply required left joins and get the alias we have to work with
+        $alias = $this->applyLeftJoins($queryBuilder, $filterDataDto->getEntityAlias(), $propertyPath);


This adds support for embeddables.

Suggested change

$alias = $this->applyLeftJoins($queryBuilder, $filterDataDto->getEntityAlias(), $propertyPath);

if ($entityDto->getFqcn() === $targetClassMetadata->getName()) {

$alias = $filterDataDto->getEntityAlias();

} else {

// Apply required left joins and get the alias we have to work with

$alias = $this->applyLeftJoins($queryBuilder, $filterDataDto->getEntityAlias(), $propertyPath);

}

chapterjason · 2025-03-01T22:31:43Z

+
+        foreach ($segments as $i => $prop) {
+            if (!$metadata->hasField($prop) && !$metadata->hasAssociation($prop)) {
+                self::throwInvalidPropertyPathException($propertyPath, $class);
+            }
+
+            // The target property must be at the end of path
+            if ($i === $lastIndex) {
+                $property = $prop;
+                break;
+            }


This adds support for embeddables.

Suggested change

foreach ($segments as $i => $prop) {

if (!$metadata->hasField($prop) && !$metadata->hasAssociation($prop)) {

self::throwInvalidPropertyPathException($propertyPath, $class);

}

// The target property must be at the end of path

if ($i === $lastIndex) {

$property = $prop;

break;

}

$prefix = '';

foreach ($segments as $i => $prop) {

$prop = $prefix.$prop;

if (!$metadata->hasField($prop) && !$metadata->hasAssociation($prop)) {

self::throwInvalidPropertyPathException($propertyPath, $class);

}

// The target property must be at the end of path

if ($i === $lastIndex) {

$property = $prop;

break;

}

if ($metadata->hasField($prop)) {

$prefix .= $prop.'.';

continue;

}

Crease29 · 2025-09-15T05:55:44Z

I think it would be so great if this could get merged.

Seb33300 · 2026-03-13T14:45:33Z

Duplicate of #7500

javiereguiluz added the feature label Dec 17, 2021

javiereguiluz added this to the 4.x milestone Dec 17, 2021

This was referenced Dec 23, 2021

Fix filters for Doctrine embedded class fields #4840

Closed

Filter by Embedded Doctrine Type #4245

Closed

Ang3 mentioned this pull request Jan 15, 2022

Filter on property of an entity in a many-to-one relation #4966

Closed

jazayam force-pushed the feature/nested-filter branch 2 times, most recently from 79c1acd to cec6ecc Compare January 23, 2023 08:45

Use filters on nested properties

af0bb9f

jazayam force-pushed the feature/nested-filter branch from cec6ecc to af0bb9f Compare January 23, 2023 08:50

kiler129 mentioned this pull request Jan 29, 2023

[RFC] Editing Fields Inline on Lists #5599

Closed

b1rdex reviewed Mar 1, 2023

View reviewed changes

speller mentioned this pull request Nov 13, 2023

Can not add a filter on on embedded field #6014

Closed

chapterjason reviewed Mar 1, 2025

View reviewed changes

Uh oh!

Conversation

jazayam commented Dec 9, 2021

Uh oh!

jazayam commented Dec 9, 2021

Uh oh!

npotier commented Dec 21, 2021

Uh oh!

DylanKas commented Feb 10, 2022

Uh oh!

Ang3 commented Apr 20, 2022

Uh oh!

quentint commented Sep 20, 2022

Uh oh!

25matt12 commented Dec 19, 2022

Uh oh!

kiler129 commented Jan 6, 2023

Uh oh!

tonyellow commented Jan 14, 2023

Uh oh!

msphn commented Jan 17, 2023

Uh oh!

jazayam commented Jan 18, 2023

Uh oh!

tonyellow commented Jan 21, 2023

Uh oh!

jazayam commented Jan 23, 2023

Uh oh!

Snowbaha commented Feb 28, 2023

Uh oh!

mathis-ait commented Feb 28, 2023

Uh oh!

b1rdex Mar 1, 2023

Choose a reason for hiding this comment

Uh oh!

b1rdex Mar 1, 2023

Choose a reason for hiding this comment

Uh oh!

Ang3 Mar 2, 2023

Choose a reason for hiding this comment

Uh oh!

astronati commented Jul 21, 2023

Uh oh!

fdiedler commented Aug 6, 2023

Uh oh!

jazayam commented Aug 16, 2023

Uh oh!

wehostadm commented Sep 18, 2023

Uh oh!

Quentin-Sch commented Oct 16, 2023

Uh oh!

Sa-Lat commented Oct 18, 2023

Uh oh!

MrJuliuss commented Dec 18, 2023

Uh oh!

BrunoJunior commented Feb 28, 2024

Uh oh!

d3pendent commented Mar 19, 2024

Uh oh!

JesusRedGar commented May 10, 2024

Uh oh!

teklakct commented Jun 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ToshY commented Dec 31, 2024

Uh oh!

javiereguiluz commented Dec 31, 2024

Uh oh!

ToshY commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johndodev commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

finnef commented Feb 3, 2025

Uh oh!

chapterjason Mar 1, 2025

Choose a reason for hiding this comment

Uh oh!

chapterjason Mar 1, 2025

teklakct commented Jun 9, 2024 •

edited

Loading

ToshY commented Dec 31, 2024 •

edited

Loading

johndodev commented Jan 23, 2025 •

edited

Loading