Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 124 additions & 5 deletions docs/grid/custom_filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,128 @@ Sylius Grids come with built-in filters, but there are use-cases where you need

To add a new filter, we need to create an appropriate class and form type.

## Using attributes

{% code title="src/Grid/Filter/SuppliersStatisticsFilter.php" lineNumbers="true" %}
```php
<?php

declare(strict_types=1);

namespace App\Grid\Filter;

use App\Form\Type\Filter\SuppliersStatisticsFilterType;
use Sylius\Bundle\GridBundle\Doctrine\DataSourceInterface;
use Sylius\Component\Grid\Attribute\AsFilter;
use Sylius\Component\Grid\Filtering\FilterInterface;

#[AsFilter(
formType: SuppliersStatisticsFilterType::class,
type: 'suppliers_statistics',
template: 'templates/grid/filter/suppliers_statistics.html.twig'
)]
class SuppliersStatisticsFilter implements FilterInterface
{
public function apply(DataSourceInterface $dataSource, $name, $data, array $options = []): void
{
// Your filtering logic.
// $data['stats'] contains the submitted value!
$queryBuilder = $dataSource->getQueryBuilder();
$queryBuilder
->andWhere('stats = :stats')
->setParameter(':stats', $data['stats'])
;

// You can leverage the ExpressionBuilder to apply driver-agnostic filters to the data source.
// Combined with restrict(), it provides query builder–style functionality for grid filters.
$dataSource->restrict($dataSource->getExpressionBuilder()->equals('stats', $data['stats']));
}
}
```
{% endcode %}

And the form type:

{% code title="src/Form/Type/Filter/SuppliersStatisticsFilterType.php" lineNumbers="true" %}
```php
<?php

declare(strict_types=1);

namespace App\Form\Type\Filter;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class SuppliersStatisticsFilterType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options): void
{
$builder->add(
'stats',
ChoiceType::class,
['choices' => range($options['from'], $options['to'])]
);
}

public function configureOptions(OptionsResolver $resolver): void
{
$resolver
->setDefaults([
'range' => [0, 10],
])
->setAllowedTypes('range', ['array'])
;
}
}
```
{% endcode %}

Create a template for the filter, similar to the existing ones:

{% code title="templates/grid/filter/suppliers_statistics.html.twig" lineNumbers="true" %}
```twig
{% form_theme form '@SyliusUi/Form/theme.html.twig' %}

{{ form_row(form) }}
```
{% endcode %}

Your custom filter is now ready to be plugged into the grid configuration using its service alias or FQCN.

{% code title="src/Grid/TournamentGrid.php" lineNumbers="true" %}
```php
<?php

declare(strict_types=1);

namespace App\Grid;

use App\Entity\Tournament;
use Sylius\Bundle\GridBundle\Builder\GridBuilderInterface;
use Sylius\Bundle\GridBundle\Grid\AbstractGrid;
use Sylius\Bundle\GridBundle\Grid\ResourceAwareGridInterface;

#[AsGrid('app_tournament', Tournament::class)]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use named arguments.

final class TournamentGrid extends AbstractGrid implements ResourceAwareGridInterface
{
public function buildGrid(GridBuilderInterface $gridBuilder): void
{
$gridBuilder
->addFilter(
Filter::create('stats', 'suppliers_statistics')
->setFormOptions(['range' => [0, 100]])
)
;
}
}
```
{% endcode %}

## Legacy way

{% code title="src/Grid/Filter/SuppliersStatisticsFilter.php" lineNumbers="true" %}
```php
<?php
Expand All @@ -20,16 +142,13 @@ class SuppliersStatisticsFilter implements ConfigurableFilterInterface
{
// Your filtering logic.
// $data['stats'] contains the submitted value!
// here is an example
$queryBuilder = $dataSource->getQueryBuilder();
$queryBuilder
->andWhere('stats = :stats')
->setParameter(':stats', $data['stats'])
;

// For driver abstraction you can use the expression builder. ExpressionBuilder is a kind of query builder.
// $data['stats'] contains the submitted value!
// here is an example
$dataSource->restrict($dataSource->getExpressionBuilder()->equals('stats', $data['stats']));
}

Expand Down Expand Up @@ -66,7 +185,7 @@ class SuppliersStatisticsFilterType extends AbstractType
$builder->add(
'stats',
ChoiceType::class,
['choices' => range($options['range'][0], $options['range'][1])]
['choices' => range($options['from'], $options['to'])]
);
}

Expand All @@ -85,7 +204,7 @@ class SuppliersStatisticsFilterType extends AbstractType

Create a template for the filter, similar to the existing ones:

{% code title="templates/Grid/Filter/suppliers_statistics.html.twig" lineNumbers="true" %}
{% code title="templates/grid/filter/suppliers_statistics.html.twig" lineNumbers="true" %}
```twig
{% form_theme form '@SyliusUi/Form/theme.html.twig' %}

Expand Down
Loading