fix(grid): add default EnumFilter Twig template

Author: stlgaits

app/Entity/Book.php

@@ -13,6 +13,7 @@
 
 namespace App\Entity;
 
+use App\Enum\BookCategory;
 use App\Grid\BookGrid;
 use App\Repository\BookRepository;
 use App\Responder\ExportGridToCsvResponder;
@@ -79,6 +80,9 @@ class Book implements ResourceInterface
     #[NotBlank]
     private ?string $authorName = null;
 
+    #[ORM\Column(type: 'enum', length: 255, nullable: true)]
+    private ?BookCategory $category = null;
+
     #[ORM\Column(type: 'datetime_immutable')]
     private \DateTimeImmutable $createdAt;
 
@@ -121,4 +125,14 @@ public function setCreatedAt(\DateTimeImmutable $createdAt): void
     {
         $this->createdAt = $createdAt;
     }
+
+    public function getCategory(): ?BookCategory
+    {
+        return $this->category;
+    }
+
+    public function setCategory(?BookCategory $category): void
+    {
+        $this->category = $category;
+    }
 }

app/Enum/BookCategory.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Enum;
+
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+enum BookCategory: string implements TranslatableInterface
+{
+    case FICTION = 'fiction';
+    case NON_FICTION = 'non-fiction';
+    case MYSTERY = 'mystery';
+    case THRILLER = 'thriller';
+    case SCIENCE_FICTION = 'science-fiction';
+    case FANTASY = 'fantasy';
+    case ROMANCE = 'romance';
+    case HORROR = 'horror';
+    case BIOGRAPHY = 'biography';
+    case HISTORY = 'history';
+    case SCIENCE = 'science';
+    case TECHNOLOGY = 'technology';
+    case BUSINESS = 'business';
+    case COOKING = 'cooking';
+    case TRAVEL = 'travel';
+    case POETRY = 'poetry';
+    case DRAMA = 'drama';
+    case CHILDREN = 'children';
+    case YOUNG_ADULT = 'young adult';
+    case RELIGION = 'religion';
+    case PHILOSOPHY = 'philosophy';
+    case ART = 'art';
+    case MANGA = 'manga';
+    case COMICS = 'comics';
+
+    /** added for Symfony 6 compatibility */
+    public function trans(TranslatorInterface $translator, ?string $locale = null): string
+    {
+        return ucfirst($translator->trans($this->value, locale: $locale));
+    }
+}

app/Factory/BookFactory.php

@@ -14,6 +14,7 @@
 namespace App\Factory;
 
 use App\Entity\Book;
+use App\Enum\BookCategory;
 use Zenstruck\Foundry\Persistence\PersistentObjectFactory;
 
 /**
@@ -36,11 +37,17 @@ public function withAuthorName(string $authorName): self
         return $this->with(['authorName' => $authorName]);
     }
 
+    public function withCategory(BookCategory $category): self
+    {
+        return $this->with(['category' => $category]);
+    }
+
     protected function defaults(): array|callable
     {
         return [
             'title' => ucfirst(self::faker()->words(3, true)),
             'authorName' => self::faker()->firstName() . ' ' . self::faker()->lastName(),
+            'category' => self::faker()->randomElement(BookCategory::cases()),
         ];
     }
 }

app/Grid/BookGrid.php

@@ -14,6 +14,7 @@
 namespace App\Grid;
 
 use App\Entity\Book;
+use App\Enum\BookCategory;
 use Sylius\Bundle\GridBundle\Builder\Action\Action;
 use Sylius\Bundle\GridBundle\Builder\Action\CreateAction;
 use Sylius\Bundle\GridBundle\Builder\Action\DeleteAction;
@@ -22,36 +23,47 @@
 use Sylius\Bundle\GridBundle\Builder\ActionGroup\BulkActionGroup;
 use Sylius\Bundle\GridBundle\Builder\ActionGroup\ItemActionGroup;
 use Sylius\Bundle\GridBundle\Builder\ActionGroup\MainActionGroup;
+use Sylius\Bundle\GridBundle\Builder\Field\EnumField;
 use Sylius\Bundle\GridBundle\Builder\Field\StringField;
+use Sylius\Bundle\GridBundle\Builder\Filter\EnumFilter;
 use Sylius\Bundle\GridBundle\Builder\Filter\StringFilter;
 use Sylius\Bundle\GridBundle\Builder\GridBuilderInterface;
 use Sylius\Bundle\GridBundle\Grid\AbstractGrid;
-use Sylius\Bundle\GridBundle\Grid\ResourceAwareGridInterface;
+use Sylius\Component\Grid\Attribute\AsGrid;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
-final class BookGrid extends AbstractGrid implements ResourceAwareGridInterface
+#[AsGrid(
+    resourceClass: Book::class,
+    name: 'app_book',
+)]
+final class BookGrid extends AbstractGrid
 {
-    public static function getName(): string
+    public function __construct(private readonly TranslatorInterface $translator)
     {
-        return 'app_book';
     }
 
-    public function buildGrid(GridBuilderInterface $gridBuilder): void
+    public function __invoke(GridBuilderInterface $gridBuilder): void
     {
         $gridBuilder
             ->orderBy('title')
-            ->addFilter(
+            ->withFilters(
                 StringFilter::create('search', ['title', 'authorName'])
                     ->setLabel('sylius.ui.search'),
+                EnumFilter::create(name: 'category', enumClass: BookCategory::class, field: 'category')
+                    ->addFormOption('choice_value', fn (?BookCategory $enum) => $enum?->value)
+                    ->addFormOption('choice_label', fn (BookCategory $choice) => $choice->trans($this->translator))
+                    ->setLabel('app.ui.category'),
             )
-            ->addField(
+            ->withFields(
                 StringField::create('title')
                     ->setLabel('app.ui.title')
                     ->setSortable(true),
-            )
-            ->addField(
                 StringField::create('authorName')
                     ->setLabel('app.ui.author_name')
                     ->setSortable(true),
+                EnumField::create('category')
+                    ->setLabel('app.ui.category')
+                    ->setSortable(true),
             )
             ->addActionGroup(
                 MainActionGroup::create(
@@ -78,9 +90,4 @@ public function buildGrid(GridBuilderInterface $gridBuilder): void
             )
         ;
     }
-
-    public function getResourceClass(): string
-    {
-        return Book::class;
-    }
 }