advanced-searcher.md

Personnalisation avancée de la classe Searcher

Personnalisation des filtres de recherche

Solution 1: Utilisation de addField et updateQueryBuilder

<?php
//src/Form/Searcher/CarSearcher
namespace App\Form\Searcher;

use Ecommit\CrudBundle\Crud\SearchFormBuilder;
use Ecommit\CrudBundle\Form\Filter as Filter;
use Ecommit\CrudBundle\Form\Searcher\AbstractSearcher;
use Symfony\Component\Form\Extension\Core\Type\TextType;

class CarSearcher extends AbstractSearcher
{
    public $id;

    public $name;

    public function buildForm(SearchFormBuilder $builder, array $options): void
    {
        //Filtre habituel
        $builder->addFilter('id', Filter\IntegerFilter::class, [
            'comparator' => Filter\IntegerFilter::EQUAL,
        ]);

        //Ajout manuel d'un champ dans filtre de recherche
        $builder->addField('name', TextType::class, [
            'required' => false,
        ]);
    }
    
    public function updateQueryBuilder(mixed $queryBuilder, array $options): void
    {
        //Traitement du filtre de recherche "name"
        if (null !== $this->name) {
            $queryBuilder->andWhere('c1.name = :name')
                ->setParameter('name', $this->name);
        }
    }
}

Solution 2: Utilisation d'une classe FormType

<?php
//src/Form/Searcher/CarSearcher
namespace App\Form\Searcher;

use Ecommit\CrudBundle\Form\Searcher\AbstractSearcher;
use Symfony\Component\Validator\Constraints as Assert;

class CarSearcher extends AbstractSearcher
{
    /**
     * @Assert\Length(max=255)
     */
    public $name;

    public function updateQueryBuilder(mixed $queryBuilder, array $options): void
    {
        //Traitement du filtre de recherche "name"
        if (null !== $this->name) {
            $queryBuilder->andWhere('c1.name = :name')
                ->setParameter('name', $this->name);
        }
    }
}

REMARQUE: Pensez à la validation de vos champs.

<?php
//src/Form/Type/CarSearcherType
namespace App\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class CarSearcherType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->addField('name', TextType::class, [
            'required' => false,
        ]);
    }
}

<?php
//src/Controller/MyCrudController
namespace App\Controller;

//...
+ use App\Form\Type\CarSearcherType;

class MyCrudController extends AbstractCrudController
{
    protected function getCrudOptions(): array
    {
        //...
        
        $crudConfig = $this->createCrudConfig('my_crud'); //Passé en argument: Nom du CRUD
        $crudConfig->addColumn(['id' => 'id', 'alias' => 'c1.id', 'label' => 'Id'])
            //...
            ->setRoute('my_crud_ajax')
-           ->createSearchForm(new CarSearcher())
+           ->createSearchForm(new CarSearcher(), CarSearcherType::class , [
+               //Searcher options
+               'form_options' => [
+                   //Form type options
+               ],
+           ])
            //...

        return $crudConfig->getOptions();
    }
}

Solution 3: Création d'un filtre de recherche

Voir Création d'un filtre de recherche

Définir les options du formulaire de recherche

La classe configureOptions de SearcherInterface peut être utilisée pour définir des options au formulaire de recherche :

//src/Form/Searcher/CarSearcher
namespace App\Form\Searcher;

use Ecommit\CrudBundle\Form\Searcher\AbstractSearcher;
use Symfony\Component\OptionsResolver\OptionsResolver;

class CarSearcher extends AbstractSearcher
{
    //...

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'my_option' => null,
        ]);
    }
}

Ces options doivent être passées au 3ème argument ($options) de la méthode createSearchForm de Crud :

<?php
//src/Controller/MyCrudController
namespace App\Controller;

//...

class MyCrudController extends AbstractCrudController
{
    protected getCrudOptions(): array
    {
        //...
        
        $crudConfig = $this->createCrudConfig('my_crud'); //Passé en argument: Nom du CRUD
        $crudConfig->addColumn(['id' => 'id', 'alias' => 'c1.id', 'label' => 'Id'])
            //...
            ->setRoute('my_crud_ajax')
-           ->createSearchForm(new CarSearcher())
+           ->createSearchForm(new CarSearcher(), null , [
+               'my_option' => 'my_value',
+           ])
            //...

        return $crudConfig->getOptions();
    }
}

Ces options peuvent être enfin récupérées dans les arguments $options des méthodes buildForm et updateQueryBuilder de SearcherInterface.