Fix filter query when using "OR" conditions

[phansys]

Subject

Fix filter query when using "OR" conditions.

I am targeting this branch, because these changes respect BC.

Rework of #925, keeping BC.
Fixes sonata-project/SonataAdminBundle#2850.
Fixes sonata-project/SonataAdminBundle#3368.
Fixes sonata-project/SonataAdminBundle#5569.

Changelog

### Fixed
- Resulting `WHERE` clause from `Filter::applyWhere()` when using `OR` conditions on queries that already have previous conditions.

To do

• Find a way to tell the filter it must add the AND WHERE clause for first time without using a static variable;
• Add tests.

[phansys]

We could evaluate if in the next major, we could provide the Xor expression used for the search from the datagrid at the AdminBundle.
By now, I think we could rely in this workaround.
@VincentLanglet, since you was experiencing this issue, could you please test these changes in a real project?

[VincentLanglet]

If I understand correctly.

If you've add a where(Foo) is the configure query.
And you're using a filter1 with AND, a filter3 with OR, a filter2 with AND and a filter4 with OR.

You will get where Foo AND filter1,
then where Foo AND filter1 AND (filter3)
then where Foo AND filter1 AND (filter3) AND filter2
then where Foo AND filter1 AND (filter3 OR filter4) AND filter2

So what you're calling a root filter condition, could more related to the Or. getOrFilterCondition ? Same for the marker.

Would it be possible to add test unit ?

[phansys]

So what you're calling a root filter condition, could more related to the Or. getOrFilterCondition ? Same for the marker.

Let's say you have the following datagrid query:

SELECT ...
FROM model m
WHERE
    m.enabled = true
    AND m.updated_at IS NULL
;

The changes introduced in this PR will perform these actions:

1. Add an AND condition inside the WHERE clause, using what I called, a marker, enclosed with parentheses:

SELECT ...
FROM model m
WHERE
    m.enabled = true
    AND m.updated_at IS NULL
    AND (
        "sonata_admin.datagrid.filter_query.marker" IS NULL
    )
;

2. This marker is used later for all the filters to identify the AND group where the OR conditions must be placed:

SELECT ...
FROM model m
WHERE
    m.enabled = true
    AND m.updated_at IS NULL
    AND (
        "sonata_admin.datagrid.filter_query.marker" IS NULL
        OR m.name LIKE "%my search criteria%"
        OR m.lastname LIKE "%my search criteria%"
    )
;

Would it be possible to add test unit ?

Yes, that's in my To Do list, but I'd like to confirm if the results are the expected in other real project before spending time on them. In my case, it is working fine, but please let me know if you have chance to check it on your side.
Thank you in advance.

[VincentLanglet]

Yes, so the method getRootCondition is returning the part

    (
        "sonata_admin.datagrid.filter_query.marker" IS NULL
        OR m.name LIKE "%my search criteria"
        OR m.lastname LIKE "%my search criteria"
    )

I don't consider this as the root condition, but only the one related to OrFilter.

[phansys]

I don't consider this as the root condition, but only the one related to OrFilter.

Since getRootCondition() is declared in the class Filter, I feel naming it getOrFilterCondition() like a redundancy, but I have no problem with that change. My main concern is about the behavior and how it's working.

[VincentLanglet]

My main concern is about the behavior and how it's working.

I will try to use this in the week, but since we've overridden the default search behavior I need some work/time.

[phansys]

@sonata-project/contributors, could you please review?
I'd like to make a release including this fix.

[VincentLanglet]

I still didn't find time to try this.

Does someone did ?

[phansys]

Even if we usually will use the admin code which a filter belongs to as value for this option, I think we could use a more agnostic name, since this option has no actual relation with an admin code; it's just a grouping identifier used to know which filters must share the same condition.
WDYT about "group" or something similar?