Changing the default filter criteria to "Is equal to" - version 3.x

[ThisuraThejith]

Good day,

I'm working with Sonata Admin Panel 3.x and currently I'm working on changing the default filter matching criteria from "contains" to "is equal to" for some filter fields to filter certain entities. Refer the below screen shot to have a more clear idea.

I'll take one entity called "Comments" to explain my problem. The following are the filter fields that I have to filter comments.

As I need to always set the value to "is equal to" in the first drop down after clicking on "Advanced filters", I've overridden the "configureDefaultFilterValues" in the "CommentAdmin" file as follows.

protected function configureDefaultFilterValues(array &$filterValues)
{
      $availableFilterFields = [
          'id',
          'message',
          'user.id',
          'user.artist_name',
          'song.id',
          'song.name',
          'article.title',
      ];
    
      foreach ($availableFilterFields as $fieldName) {
          $filterValues[str_replace('.', '__', $fieldName)] = [
              "type" => ChoiceType::TYPE_EQUAL
          ];
      }
}

When it comes to a filter field which is a direct property of the Comment entity (for example "message" in this case), this works and "is equal to" is selected as the default filter criteria as follows.

But the problem is when it comes to a filter field which is associated to the Comment entity through another entity like User Artist Name, which will be accessed in the CommentAdmin file as user.artist_name, which is included in the $availableFilterFields array in the above method, this doesn't work and "is equal to" is not selected as the default filter criteria as in the following screenshot.

Is there a way to resolve this? And add to that I'd appreciate if anyone can suggest a way to centrally change this default filter criteria to "is equal to" in every place, as that is the filter criteria that is mostly used by our system admins and it will be very convenient to have it already selected.

Thanks in advance.

[zyberspace]

Try using user__artist_name instead, like the actual query parameter used when submitting the filter.

The default filter values are directly merged with the passed query. There is no further processing of the provided keys, as far, as i know of.

---

If your stil want to use the . in your configureDefaultFilterValues, you could write something like this:

protected function configureDefaultFilterValues(array &$filterValues)
{
    $availableFilterFields = [
        'id',
        'message',
        'user.id',
        'user.artist_name',
        'song.id',
        'song.name',
        'article.title',
    ];

    foreach ($availableFilterFields as $fieldName) {
        $filterValues[str_replace('.', '__', $fieldName)] = [
            "type" => ChoiceType::TYPE_EQUAL
        ];
    }
}

[ThisuraThejith]

@zyberspace Thanks a lot for the answer and passing user__artist_name worked indeed. To add some more weight, is there a way that you can suggest to centrally change this default filter criteria into "is equal to" in every place in the admin panel as that is the most commonly used filter criteria by our admins?

[zyberspace]

@ThisuraThejith I would build a global admin extension: https://docs.sonata-project.org/projects/SonataAdminBundle/en/4.x/reference/extensions/

It's basically the same as your admin class but can be configured for multiple (or even all) admins and each method gets called after the one from your individual admins. The configureDefaultFilterValues method of the admin extensions gets the admin passed, so you can try and get your filter names from their and the simply put your foreach in the admin extension.