feature EasyCorp#4783 Respect filters while searching, add additional search event (pkly)

javiereguiluz · javiereguiluz · commit 7a70efa0f4d6 · 2021-12-02T20:23:45.000+01:00
This PR was submitted for the master branch but it was squashed and merged into the 3.x branch instead. Discussion ---------- Respect filters while searching, add additional search event Fixes EasyCorp#4707 Commits ------- 0e00044 Respect filters while searching, add additional search event
diff --git a/src/Event/AfterEntitySearchEvent.php b/src/Event/AfterEntitySearchEvent.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace EasyCorp\Bundle\EasyAdminBundle\Event;
+
+use Doctrine\ORM\QueryBuilder;
+use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
+use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
+
+final class AfterEntitySearchEvent
+{
+    private $queryBuilder;
+    private $searchDto;
+    private $entityDto;
+
+    public function __construct(QueryBuilder $queryBuilder, SearchDto $searchDto, EntityDto $entityDto)
+    {
+        $this->queryBuilder = $queryBuilder;
+        $this->searchDto = $searchDto;
+        $this->entityDto = $entityDto;
+    }
+
+    public function getQueryBuilder(): QueryBuilder
+    {
+        return $this->queryBuilder;
+    }
+
+    public function getSearchDto(): SearchDto
+    {
+        return $this->searchDto;
+    }
+
+    public function getEntityDto(): EntityDto
+    {
+        return $this->entityDto;
+    }
+}
diff --git a/src/Orm/EntityRepository.php b/src/Orm/EntityRepository.php
@@ -10,6 +10,7 @@
 use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterDataDto;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;
+use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntitySearchEvent;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Factory\FormFactory;
 use EasyCorp\Bundle\EasyAdminBundle\Form\Type\ComparisonType;
@@ -26,13 +27,15 @@ final class EntityRepository implements EntityRepositoryInterface
     private $doctrine;
     private $entityFactory;
     private $formFactory;
+    private $eventDispatcher;
 
-    public function __construct(AdminContextProvider $adminContextProvider, ManagerRegistry $doctrine, EntityFactory $entityFactory, FormFactory $formFactory)
+    public function __construct(AdminContextProvider $adminContextProvider, ManagerRegistry $doctrine, EntityFactory $entityFactory, FormFactory $formFactory, EventDispatcherInterface $eventDispatcher)
     {
         $this->adminContextProvider = $adminContextProvider;
         $this->doctrine = $doctrine;
         $this->entityFactory = $entityFactory;
         $this->formFactory = $formFactory;
+        $this->eventDispatcher = $eventDispatcher;
     }
 
     public function createQueryBuilder(SearchDto $searchDto, EntityDto $entityDto, FieldCollection $fields, FilterCollection $filters): QueryBuilder
@@ -148,6 +151,8 @@ private function addSearchClause(QueryBuilder $queryBuilder, SearchDto $searchDt
                     ->setParameter('query_as_words', $dqlParameters['words_query']);
             }
         }
+
+        $this->eventDispatcher->dispatch(new AfterEntitySearchEvent($queryBuilder, $searchDto, $entityDto));
     }
 
     private function addOrderClause(QueryBuilder $queryBuilder, SearchDto $searchDto, EntityDto $entityDto): void
diff --git a/src/Resources/config/services.php b/src/Resources/config/services.php
@@ -223,6 +223,7 @@
             ->arg(1, new Reference('doctrine'))
             ->arg(2, new Reference(EntityFactory::class))
             ->arg(3, new Reference(FormFactory::class))
+            ->arg(4, new Reference('event_dispatcher'))
 
         ->set(EntityFactory::class)
             ->arg(0, new Reference(FieldFactory::class))
diff --git a/src/Resources/views/layout.html.twig b/src/Resources/views/layout.html.twig
@@ -182,6 +182,14 @@
 
                                         <form class="form-action-search" method="get">
                                             {% block search_form %}
+                                                {% block search_form_filters %}
+                                                    {% for field, array in ea.search.appliedFilters %}
+                                                        {% for key, value in array %}
+                                                            <input type="hidden" name="filters[{{ field }}][{{ key }}]" value="{{ value }}">
+                                                        {% endfor %}
+                                                    {% endfor %}
+                                                {% endblock %}
+
                                                 <input type="hidden" name="crudAction" value="index">
                                                 <input type="hidden" name="crudControllerFqcn" value="{{ ea.request.query.get('crudControllerFqcn') }}">
                                                 <input type="hidden" name="menuIndex" value="{{ ea.request.query.get('menuIndex') }}">

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;`
`11`	`11`	`use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterDataDto;`
`12`	`12`	`use EasyCorp\Bundle\EasyAdminBundle\Dto\SearchDto;`
	`13`	`+use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntitySearchEvent;`
`13`	`14`	`use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;`
`14`	`15`	`use EasyCorp\Bundle\EasyAdminBundle\Factory\FormFactory;`
`15`	`16`	`use EasyCorp\Bundle\EasyAdminBundle\Form\Type\ComparisonType;`
`@@ -26,13 +27,15 @@ final class EntityRepository implements EntityRepositoryInterface`
`26`	`27`	`private $doctrine;`
`27`	`28`	`private $entityFactory;`
`28`	`29`	`private $formFactory;`
	`30`	`+ private $eventDispatcher;`
`29`	`31`
`30`		`- public function __construct(AdminContextProvider $adminContextProvider, ManagerRegistry $doctrine, EntityFactory $entityFactory, FormFactory $formFactory)`
	`32`	`+ public function __construct(AdminContextProvider $adminContextProvider, ManagerRegistry $doctrine, EntityFactory $entityFactory, FormFactory $formFactory, EventDispatcherInterface $eventDispatcher)`
`31`	`33`	`{`
`32`	`34`	`$this->adminContextProvider = $adminContextProvider;`
`33`	`35`	`$this->doctrine = $doctrine;`
`34`	`36`	`$this->entityFactory = $entityFactory;`
`35`	`37`	`$this->formFactory = $formFactory;`
	`38`	`+ $this->eventDispatcher = $eventDispatcher;`
`36`	`39`	`}`
`37`	`40`
`38`	`41`	`public function createQueryBuilder(SearchDto $searchDto, EntityDto $entityDto, FieldCollection $fields, FilterCollection $filters): QueryBuilder`
`@@ -148,6 +151,8 @@ private function addSearchClause(QueryBuilder $queryBuilder, SearchDto $searchDt`
`148`	`151`	`->setParameter('query_as_words', $dqlParameters['words_query']);`
`149`	`152`	`}`
`150`	`153`	`}`
	`154`	`+`
	`155`	`+ $this->eventDispatcher->dispatch(new AfterEntitySearchEvent($queryBuilder, $searchDto, $entityDto));`
`151`	`156`	`}`
`152`	`157`
`153`	`158`	`private function addOrderClause(QueryBuilder $queryBuilder, SearchDto $searchDto, EntityDto $entityDto): void`