Show matching filters in search results

[phansys]

Subject

Show matching filters in search results.

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

The search results are using the Admin::toString() method to show a representation of the model matching the search criteria, but in cases where the value of the field matching a filter is not present on that string, is hard to understand why that result is presented as a match.
These changes add the name of the filters that produced the model match in each search result.
Here is an example:

Changelog

### Added
- Information about the matching filters in the search results.

To do

• Improve the UI;
• Check if we can provide the same feature for filters using a deeper property path (IE sub.model.property).

If someone with good CSS skills wants to get rid of the required work to provide a better UI, please be free to suggest any change.

[VincentLanglet]

If someone with good CSS skills wants to get rid of the required work to provide a better UI, please be free to suggest any change.

label-primary instead of default in order to have some colors ?

[phansys]

@core23, @VincentLanglet; could you please bring a new review?

[VincentLanglet]

It's not clear to me when we can update the code.
The PR: sonata-project/SonataDoctrineORMAdminBundle#1395 is already merged.
And the Admin bundle should be aware about the issues from persistence bundles.

[VincentLanglet]

Plus if we rename the option in the persistence bundle, this won't work.
The AdminBundle shouldn't rely on the persistence bundle code

[phansys]

The AdminBundle shouldn't rely on the persistence bundle code

This option is set in the SearchHandler:

SonataAdminBundle/src/Search/SearchHandler.php

Line 92 in 09e8b7d

$filter->setOption('case_sensitive', $this->caseSensitive);

And the Admin bundle should be aware about the issues from persistence bundles.

We already know that isn't properly respected with some DB platforms.
If I use the commented code instead, this template will respect the "case_sensitive" option, which can lead to not matching some results returned by the persistence bundle (since the persistence bundle is not properly respecting the option).
What do you suggest?

[phansys]

I left the right behavior (respecting the "case_sensitive" option), adding this comment in the template:

Some model managers are not respecting the "sonata_admin.global_search.case_sensitive" configuration option.
If you see no matching filters for a search result, it is probably the reason. In that case, you SHOULD consider using false as value for this option.

Is it fine for you?

[VincentLanglet]

Seems ok like this

[VincentLanglet]

Suggested change

	{% if match and (((filter.options.case_sensitive or filter.options.case_sensitive is null) and filter.value.value in match)
	{% if match and ((filter.options.case_sensitive is not same as(false) and filter.value.value in match)

[phansys]

Done.

[franmomu]

These filters are implementing FilterInterface if I'm not mistaken, but there is no getValue method in the interface.

And getValue from Filter is deprecated.

[phansys]

Nice catch!
I've replaced these usages with a new variable holding the search term.
Thank you.

[VincentLanglet]

getValue is not in the interface in master :/

[core23]

This highlight does not work if you use cascaded fields, e.g.:

    protected function configureDatagridFilters(DatagridMapper $filter): void
    {
        $filter
            ->add('addresses.city')
        ;
    }

This will result in a RuntimeException:

Neither the property "city" nor one of the methods "city()", "getcity()"/"iscity()"/"hascity()" or "__call()" exist and have public access in class "Doctrine\ORM\PersistentCollection".

[VincentLanglet]

This highlight does not work if you use cascaded fields, e.g.:

    protected function configureDatagridFilters(DatagridMapper $filter): void
    {
        $filter
            ->add('addresses.city')
        ;
    }

This will result in a RuntimeException:

Neither the property "city" nor one of the methods "city()", "getcity()"/"iscity()"/"hascity()" or "__call()" exist and have public access in class "Doctrine\ORM\PersistentCollection".

This feature was partially removed from Sonata 4. Do you know if it'll be still present ?
#7347

[core23]

This feature was partially removed from Sonata 4. Do you know if it'll be still present ?
#7347

What do you mean with still present? Tested it just today with the 3.x branch. Never tried the master branch.

[VincentLanglet]

This feature was partially removed from Sonata 4. Do you know if it'll be still present ?

#7347

What do you mean with still present? Tested it just today with the 3.x branch. Never tried the master branch.

If the bug you describe will be still present in the master branch since the code were modified