Refactor the search form to use type classes instead of a single form builder class

Author: loevgaard

src/Controller/Action/SearchAction.php

@@ -13,7 +13,9 @@
 use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResponseParametersCreated;
 use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResultReceived;
 use Setono\SyliusMeilisearchPlugin\Form\Builder\SearchFormBuilderInterface;
+use Setono\SyliusMeilisearchPlugin\Form\Type\SearchResultType;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Twig\Environment;
@@ -24,6 +26,7 @@ final class SearchAction
 
     public function __construct(
         ManagerRegistry $managerRegistry,
+        private readonly FormFactoryInterface $formFactory,
         private readonly Environment $twig,
         private readonly SearchFormBuilderInterface $searchFormBuilder,
         private readonly SearchEngineInterface $searchEngine,
@@ -40,7 +43,7 @@ public function __invoke(Request $request): Response
         $searchResult = $this->searchEngine->execute($searchRequestCreatedEvent->searchRequest);
         $this->eventDispatcher->dispatch(new SearchResultReceived($searchResult));
 
-        $searchForm = $this->searchFormBuilder->build($searchResult);
+        $searchForm = $this->formFactory->create(SearchResultType::class, $searchResult);
         $searchForm->handleRequest($request);
 
         if ($searchForm->isSubmitted() && !$searchForm->isValid()) {

src/Engine/SearchResult.php

@@ -13,14 +13,15 @@ final class SearchResult
     public function __construct(
         /** The index that was queried */
         public readonly Index $index,
-
+        public readonly string $query,
         /** @var array<int, array> $hits */
         public readonly array $hits,
         public readonly int $totalHits,
         public readonly int $page,
         public readonly int $pageSize,
         public readonly int $totalPages,
         public readonly FacetDistribution $facetDistribution,
+        public readonly ?string $sort = null,
     ) {
     }
 
@@ -44,6 +45,7 @@ public static function fromMeilisearchSearchResult(Index $index, MeilisearchSear
 
         return new self(
             $index,
+            $meilisearchSearchResult->getQuery(),
             $meilisearchSearchResult->getHits(),
             $totalHits,
             $page,

src/Form/Builder/SearchFormBuilder.php

@@ -35,7 +35,7 @@ public function build(SearchResult $searchResult): FormInterface
                 'csrf_protection' => false,
                 'allow_extra_fields' => true,
             ])
-            ->add('q', HiddenType::class)
+            ->add(SearchRequest::QUERY_PARAMETER_FILTER, HiddenType::class)
             ->setMethod('GET')
         ;
 
@@ -79,7 +79,7 @@ private function buildPagination(SearchResult $searchResult, FormBuilderInterfac
             $choices['setono_sylius_meilisearch.form.search.pagination.next'] = $searchResult->page + 1;
         }
 
-        $builder->add('p', ChoiceType::class, [
+        $builder->add(SearchRequest::QUERY_PARAMETER_PAGE, ChoiceType::class, [
             'choices' => $choices,
             'choice_attr' => fn (string $page) => ['style' => 'display: none'], // we only want to display the labels
             'required' => false,

src/Form/Type/SearchFilterType.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Type;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class SearchFilterType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+    }
+}

src/Form/Type/SearchResultSortType.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Type;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class SearchResultSortType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {
+            dump($event->getData());
+        });
+    }
+}

src/Form/Type/SearchResultType.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Type;
+
+use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\HiddenType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+
+final class SearchResultType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add(SearchRequest::QUERY_PARAMETER_SEARCH, HiddenType::class, [
+                'property_path' => 'query',
+            ])
+//            ->add(SearchRequest::QUERY_PARAMETER_FILTER, SearchFilterType::class)
+            ->add(SearchRequest::QUERY_PARAMETER_SORT, SearchResultSortType::class, [
+                'property_path' => 'sort',
+            ])
+            ->setMethod('GET')
+        ;
+    }
+}

src/Resources/config/services/conditional/search.xml

@@ -9,6 +9,7 @@
 
         <service id="Setono\SyliusMeilisearchPlugin\Controller\Action\SearchAction" public="true">
             <argument type="service" id="doctrine"/>
+            <argument type="service" id="form.factory"/>
             <argument type="service" id="twig"/>
             <argument type="service" id="Setono\SyliusMeilisearchPlugin\Form\Builder\SearchFormBuilderInterface"/>
             <argument type="service" id="Setono\SyliusMeilisearchPlugin\Engine\SearchEngineInterface"/>

src/Resources/views/search/_filters.html.twig

@@ -1 +1 @@
-{{ form_widget(searchForm.f, { 'attr': { 'class': 'ssm-filters' } }) }}
+{#{{ form_widget(searchForm.f, { 'attr': { 'class': 'ssm-filters' } }) }}#}