Filters

How to make filters on lists

1. In the DataSource.php file linked to your entity

/**
 * [@required](https://github.com/required)
 */
public function setFilterset(YourCrudFilterset $filterset)
{
    $this->filterset = $filterset;
}

:warning: The PHPDoc [@required](https://github.com/required) is mandatory, otherwise the method will be ignored.

2. Then, create the file YourCrudFilterset.php that you declared as a parameter above

In the getFilters() method, you can declare the desired filters

<?php

namespace App\Crudit\Datasource\Filterset;

use Lle\CruditBundle\Datasource\AbstractFilterSet;
use Lle\CruditBundle\Filter\FilterType\StringFilterType;
use Lle\CruditBundle\Filter\FilterType\NumberFilterType;

class YourCrudFilterset extends AbstractFilterSet
{
    public function getFilters(): array
    {
        return [
            StringFilterType::new('numeroFiche'),
            NumberFilterType::new('poidsFruit')
        ];
    }
}

For the EntityFilterType you must define three parameters => the field, the class and the autocomplete route (data feed):

<?php

namespace App\Crudit\Datasource\Filterset;

use Lle\CruditBundle\Datasource\AbstractFilterSet;
use Lle\CruditBundle\Filter\FilterType\EntityFilterType;

class YourCrudFilterset extends AbstractFilterSet
{
    public function getFilters(): array
    {
        return [
            EntityFilterType::new('user', User::class, 'app_crudit_user_autocomplete'),
        ];
    }
}

For the WorkflowFilterType you must define 2 parameters => the field and the workflow:

<?php

namespace App\Crudit\Datasource\Filterset;

use Lle\CruditBundle\Datasource\AbstractFilterSet;
use Lle\CruditBundle\Filter\FilterType\WorkflowFilterType;

class YourCrudFilterset extends AbstractFilterSet
{
    public function __construct(
        protected WorkflowInterface $orderStateMachine,
    ) {
    }

    public function getFilters(): array
    {
        return [
            WorkflowFilterType::new('status', $this->orderStateMachine),
        ];
    }
}

3. (Optional) Changing the amount displayed

By default, 4 filters are displayed. If you want to show more or less, override getNumberDisplayed in your FilterSet :

public function getNumberDisplayed(): int
{
    return 8;
}

4. (Optional) Add default values

You can set a default value for your filter. To do this, simply add the setDefault method to your filter :

public function getFilters(): array
{
    return [
        BooleanFilterType::new('actif')->setDefault(['op' => 'eq', 'value' => 'true']),
    ];
}

To configure the default values for an EntityFilterType, you must first create 2 tables. One containing the id and text (toString) of each of your default values and the other with the id of each of your default values. Then, in the setDefault method, you need to configure 3 pieces of data: - op - items (json) - value

public function getFilters(): array
{
    $result = $this->em->getRepository(YourEntity::class)->findBy(['code' => ['A', 'B']]);

    $items = [];
    $idItems = [];
    foreach ($results as $result) {
        $items[] = [
            'id' => $result->getId(),
            'text' => $result->getCode() . ' - ' . $result->getLibelle(),
        ];
        $idItems[] = $result->getId();
    }

    return [
        EntityFilterType::new('yourField', YourEntity::class)->setDefault([
            'op' => 'eq',
            'items' => json_encode($items),
            'value' => implode(',', $idItems),
        ]),
    ];
}

5. (Optional) Add additionnal fields

You can configure the filter to search across multiple fields like this (this works for all filter types):

class YourCrudFilterset extends AbstractFilterSet
{
    public function getFilters(): array
    {
        return [
            StringFilterType::new('firstname')
                ->setAdditionnalFields(['lastname']),
            EntityFilterType::new('deliveryAddress', Address::class, 'app_crudit_address_autocomplete')
                ->setAdditionnalFields(['billingAddress']),
        ];
    }
}

6. (Optional) Add additionnal conditions

If you need to search data with specific conditions, you can configure the applyAdditionnalConditions method on your custom filter:

class YourCustomFilterType extends EntityFilterType
{
    public static function new(string $fieldname): self
    {
        return new self($fieldname);
    }

    public function applyAdditionnalConditions(QueryBuilder $queryBuilder): void
    {
        $queryBuilder
            ->andWhere('root.actif = :actif')
            ->setParameter('actif', true);
    }

    public function getStateTemplate(): string
    {
        return '[@LleCrudit](https://github.com/LleCrudit)/filter/state/entity_filter.html.twig';
    }

    public function getTemplate(): string
    {
        return '[@LleCrudit](https://github.com/LleCrudit)/filter/type/entity_filter.html.twig';
    }
}

Available filter types :

• StringFilterType : simple string search
• BooleanFilterType : true/false/both values
• ChoiceFilterType : a select
• EntityFilterType : autocomplete select for entities
• DateFilterType : simple dates
• DateTimeFilterType : simple datetimes
• PeriodeFilterType : date ranges
• NumberFilterType : simple number search
• NumberRangeFilterType : number ranges
• WorkflowFilterType : for Symfony workflows (see Workflow doc)