Filtering on ManyToMany Relation

[LR3my]

Hello me again 😄

I have setup a filter this way :

$builder->addFilter('clients', EntityFilterType::class, [
            'form_options' => [
                'class' => Client::class,
                'choice_label' => function (Client $client): string {
                    return $client->getId() . ' - ' . $client->getName();
                },
            ],
            'label' => 'Filter on a client'
        ]);

But this filter is filtering on a ManyToMany relationship and keep getting a semantic error.

[Semantical Error] line 0, col 73 near 'clients = :c': Error: Invalid PathExpression. StateFieldPathExpression or SingleValuedAssociationField expected.

Is there is a way to make this work ? Should I build my own filter ? sorry again for my noob question 😞

[Kreyu]

Hey @LR3my. This is because it results in invalid DQL:

WHERE clients = :clients

First, make sure to join the clients in your QueryBuilder you pass to the data table, for example:

$this->createQueryBuilder('entity')
    ->join('entity.clients', 'client');

Now, if you wanted to write a WHERE condition to find a specific client, you would probably write a DQL like this:

WHERE client.id = 1

So, pass the client.id as filter's query_path to make the filter work that way:

$builder->addFilter('clients', EntityFilterType::class, [
    'query_path' => 'client.id',
    'form_options' => [
        'class' => Client::class,
        'choice_label' => function (Client $client): string {
            return $client->getId() . ' - ' . $client->getName();
        },
    ],
    'label' => 'Filter on a client'
]);

[LR3my]

Thank you again for your help.

I figured that much, that it was an invalid DQL.

I changed the query builder and the query_path but now I got another error

Object of class App\Entity\Client could not be converted to string

in vendor/kreyu/data-table-bundle/src/Bridge/Doctrine/Orm/Filter/Formatter/EntityActiveFilterFormatter.php (line 25)

            if (is_callable($choiceLabel)) {
                return $choiceLabel($data->getValue());
            }
            return (string) $data->getValue();
        }
    }

[Kreyu]

It is because it tries to render the active filter button (that allows to clear it), but is unable to convert the entity to string.
You can either use choice_label option, like the one you've provided for Symfony Form, or active_filter_formatter:

use Kreyu\Bundle\DataTableBundle\Filter\FilterData;

$builder->addFilter('clients', EntityFilterType::class, [
    'query_path' => 'client.id',
    'form_options' => [
        'class' => Client::class,
        'choice_label' => function (Client $client): string {
            return $client->getId() . ' - ' . $client->getName();
        },
    ],
    'label' => 'Filter on a client',

    // Add this
    'choice_label' => function (Client $client): string {
        return $client->getId() . ' - ' . $client->getName();
    },

    // Or this
    'active_filter_formatter' => function (FilterData $data): string {
        $client = $data->getValue();
        return $client->getId() . ' - ' . $client->getName();
    },
]);

Because this is separate option from a form, you can render it differently.

This should work fine. Now, to improve readability, you can move all this definition to a separate filter type, to reuse it without duplicating code. For example:

use Kreyu\Bundle\DataTableBundle\Bridge\Doctrine\Orm\Filter\Type\EntityFilterType;
use Kreyu\Bundle\DataTableBundle\Filter\Type\AbstractFilterType;
use Symfony\Component\OptionsResolver\OptionsResolver;

class ClientFilterType extends AbstractFilterType
{
    public function configureOptions(OptionsResolver $resolver): void
    {
        $choiceLabel = fn (Client $client) => $client->getId() . ' - ' . $client->getName();

        $resolver->setDefaults([
            'label' => 'Filter on a client',
            'query_path' => 'client.id',
            'form_options' => [
                'class' => Client::class,
                'choice_label' => $choiceLabel,
            ],
            'choice_label' => $choiceLabel,
        ]);
    }

    public function getParent(): ?string
    {
        return EntityFilterType::class;
    }
}

and use it instead an EntityFilterType:

$builder->addFilter('clients', ClientFilterType::class);

You can still pass the options to override the default ones configured in the type.

[LR3my]

It works ! Thanks you very much again ! 🙂