Introduce AsFilter attribute to define filter type and form type

[vasilvestre]

This PR introduces a new attribute, AsFilter, to provide a more concise and structured way of defining filter types and form types for grid filters.

Previously, filter types and form types were defined two methods inherited from ConfigurableFilterInterface.

By using the AsFilter attribute, developers can now explicitly declare the type and form type of a filter directly above the class definition. This approach improves code readability, reduces reliance on tag attributes, and enhances maintainability.

Steps:

• Create the attribute and implement it's logic
• Test
• Documentation (should be on Sylius stack now)

Example usage:

use Sylius\Component\Grid\Filtering\FilterInterface;
use Sylius\Component\Grid\Metadata\AsFilter;

#[AsFilter(type: 'product_name', formType: ProductNameFilterType::class)]
final class ProductNameFilter implements FilterInterface
{
    public function apply(DataSourceInterface $dataSource, string $name, $data, array $options): void
    {
        if (empty($data['value'])) {
            return;
        }

        $queryBuilder = $dataSource->getQueryBuilder();
        $rootAlias = $queryBuilder->getRootAliases()[0];

        $queryBuilder
            ->andWhere(sprintf('%s.name LIKE :name', $rootAlias))
            ->setParameter('name', '%' . $data['value'] . '%');
    }
}

The RegisterFiltersPass compiler pass has been updated to check for the AsFilter attribute and ignore duplicate filter configuration.

Tests are provided in the PR, documentation too.

A new behaviour is that type is now optional as the FQCN is now used by default. Which means you can reference it directly in PHP or YAML .

Future considerations:

In a future PR, we can consider deprecating the ConfigurableFilterInterface as it becomes redundant by introducing the AsFilter attribute. This will further simplify the process of creating grid filters and improve consistency.

[loic425]

@vasilvestre you have two commits with "-" as commit message
https://github.com/Sylius/SyliusGridBundle/pull/348/commits

[lchrusciel]

it seems to be incorrect, or at least misleading

[vasilvestre]

Why ? We can use FQCN as name and also call the create method of the filter.

[loic425]

Yes, this is a bit strange... but I understand why.
The FQCN is the type/name of the filter.

[loic425]

@vasilvestre Could you remember me why you don't use the Filter::create method instead?

[vasilvestre]

I did line 35

[lchrusciel]

How is it tested? Does it override nationality filter and is covered by this test:

SyliusGridBundle/src/Bundle/Tests/Functional/GridUiTest.php

Lines 235 to 245 in f500a89

	public function it_includes_all_rows_even_when_sorting_by_a_nullable_path(): void
	{
	$this->client->request('GET', '/authors/');
	$totalItemsCountBeforeSorting = count($this->getAuthorNamesFromResponse());
	$this->client->request('GET', '/authors/?sorting[nationality]=desc');
	$totalItemsCountAfterSorting = count($this->getAuthorNamesFromResponse());
	$this->assertSame($totalItemsCountBeforeSorting, $totalItemsCountAfterSorting);
	}

or is not covered by test and we don't know if it works?

[vasilvestre]

I think it's covered in https://github.com/Sylius/SyliusGridBundle/blob/f500a89f5ea35fd675012c30e55d0def0a751cc3/tests/Application/src/Filter/AttributeNationalityFilter.php and https://github.com/Sylius/SyliusGridBundle/blob/f500a89f5ea35fd675012c30e55d0def0a751cc3/tests/Application/src/Grid/Builder/AttributeNationalityFilter.php

[loic425]

I added tests on the RegisterFiltersPass itself.

I've tried locally and have seen some errors.

[loic425]

Does not change it yourself, I have tests in progress.

[loic425]

We now tagged the Attribute instead, but we need the ones that implements TypeAwareFilterInterface and FormTypeAwareFilterInterface which contains static methods for the type and the form type.

[diimpp]

If registry is renamed to filterRegistry, then formTypeRegistry should be become filterFormTypeRegister, hence I propose to remove this change.

Suggested change

	$filterRegistry = $container->getDefinition('sylius.registry.grid_filter');
	$registry = $container->getDefinition('sylius.registry.grid_filter');

[diimpp]

According to SF CS, which is basis for sylius CS, global classes should be used directly and not added to use.

Suggested change

	throw new InvalidArgumentException(sprintf('Tagged grid filters needs to have "form_type" attribute or implements "%s".', FormTypeAwareFilterInterface::class));
	throw new \InvalidArgumentException(sprintf('Tagged grid filters needs to have "form_type" attribute or implements "%s".', FormTypeAwareFilterInterface::class));

[diimpp]

Suggested change

use InvalidArgumentException;

[diimpp]

Please move form type to usual SF placement.

Suggested change

	use App\Grid\Type\NationalityFilterType;
	use App\Form\Type\Grid\NationalityFilterType;

[loic425]

we should use this interface instead, that was a mistake to use it cause the FilterInterface itself is not enough to auconfigure it.

Suggested change

	$container->registerForAutoconfiguration(FilterInterface::class)
	$container->registerForAutoconfiguration(ConfigurableFilterInterface::class)