Exclude searchers from the service container

Author: hlecorche

doc/crud.md

@@ -346,6 +346,10 @@ class CarSearcher extends AbstractSearcher
 
 > **_REMARQUE:_**  Il est aussi possible de faire des recherches plus complexes sans utiliser les filtres pré-définis. [En savoir plus](cookbook/advanced-searcher.md)
 
+> **_REMARQUE:_**  La classe Searcher est un objet de données (elle est stockée en session), et non un service : elle est
+> automatiquement exclue du conteneur de services et doit être instanciée avec `new`. Pour utiliser un service dans la
+> classe Searcher, passez-le par [les options du formulaire de recherche](cookbook/advanced-searcher.md#définir-les-options-du-formulaire-de-recherche).
+
 Une fois la classe Searcher créée, nous devons modifier notre contrôleur :
 
 ```diff

doc/upgrade/3.0.md

@@ -161,6 +161,10 @@
     * [Création d'un formulaire de recherche](../crud.md#ajout-formulaire-de-recherche-facultatif)
     * [Options du formulaire de recherche](../references/searcher.md)
     * [Personnalisation avancée de la classe Searcher](../cookbook/advanced-searcher.md)
+* Les classes implémentant `SearcherInterface` sont maintenant automatiquement exclues du conteneur de services
+  (lorsque l'autoconfiguration est activée). Une classe Searcher ne peut donc plus être injectée ni autowirée : elle doit
+  être instanciée avec `new`. Pour utiliser un service dans une classe Searcher, passez-le par
+  [les options du formulaire de recherche](../cookbook/advanced-searcher.md#définir-les-options-du-formulaire-de-recherche).
 * La protection CSRF est maintenant activée sur le formulaire de recherche (`FormSearchType`). Le jeton CSRF est
   automatiquement rendu par la fonction Twig `crud_search_form_start`. Si vous surchargez le bloc Twig
   `search_form_start` ou si vous n'utilisez pas cette fonction Twig, vous devez rendre vous-même le champ `_token`

src/DependencyInjection/EcommitCrudExtension.php

@@ -14,6 +14,7 @@
 namespace Ecommit\CrudBundle\DependencyInjection;
 
 use Ecommit\CrudBundle\Form\Filter\FilterInterface;
+use Ecommit\CrudBundle\Form\Searcher\SearcherInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
@@ -43,5 +44,10 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('ecommit_crud.twig_functions_configuration', $configs['twig_functions_configuration']);
 
         $container->registerForAutoconfiguration(FilterInterface::class)->addTag('ecommit_crud.filter');
+
+        // Searchers are stored in the session: they are data objects, not services
+        $container->registerForAutoconfiguration(SearcherInterface::class)->addTag('container.excluded', [
+            'source' => 'because searchers are stored in the session and must not be services (to use a service in a searcher, pass it in the search form options)',
+        ]);
     }
 }

tests/DependencyInjection/EcommitCrudExtensionTest.php

@@ -13,8 +13,12 @@
 
 namespace Ecommit\CrudBundle\Tests\DependencyInjection;
 
+use Ecommit\CrudBundle\DependencyInjection\EcommitCrudExtension;
 use Ecommit\CrudBundle\Tests\Functional\App\Form\Filter\MyFilter;
+use Ecommit\CrudBundle\Tests\Functional\App\Form\Searcher\UserSearcher;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DependencyInjection\Compiler\ResolveInstanceofConditionalsPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class EcommitCrudExtensionTest extends KernelTestCase
 {
@@ -29,4 +33,18 @@ public function testAutoconfigureTag(): void
 
         $this->assertTrue($crudFilters->has(MyFilter::class));
     }
+
+    public function testSearcherIsExcludedFromContainer(): void
+    {
+        $container = new ContainerBuilder();
+        $extension = new EcommitCrudExtension();
+        $extension->load([[
+            'theme' => '@EcommitCrud/Theme/base.html.twig',
+            'icon_theme' => '@EcommitCrud/IconTheme/base.html.twig',
+        ]], $container);
+        $container->register(UserSearcher::class, UserSearcher::class)->setAutoconfigured(true);
+        (new ResolveInstanceofConditionalsPass())->process($container);
+
+        $this->assertTrue($container->getDefinition(UserSearcher::class)->hasTag('container.excluded'));
+    }
 }