category automated filters (#3672)

Author: vitek-rostislav

src/DependencyInjection/ShopsysFrameworkExtension.php

@@ -10,6 +10,7 @@
 use Shopsys\FrameworkBundle\Component\Grid\InlineEdit\GridInlineEditInterface;
 use Shopsys\FrameworkBundle\Component\HttpFoundation\TransactionalMasterRequestConditionProviderInterface;
 use Shopsys\FrameworkBundle\Component\Router\FriendlyUrl\FriendlyUrlDataProviderInterface;
+use Shopsys\FrameworkBundle\Model\Category\AutomatedFilter\CategoryAutomatedFilterInterface;
 use Shopsys\FrameworkBundle\Model\Mail\MailTemplateSender\MailTemplateSenderInterface;
 use Shopsys\FrameworkBundle\Model\Order\Processing\OrderProcessingStack;
 use Shopsys\FrameworkBundle\Twig\NoVarDumperExtension;
@@ -73,6 +74,9 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $container->registerForAutoconfiguration(MailTemplateSenderInterface::class)
             ->addTag('shopsys.mail_template_sender');
+
+        $container->registerForAutoconfiguration(CategoryAutomatedFilterInterface::class)
+            ->addTag('shopsys.category_automated_filter');
     }
 
     /**

src/Form/Admin/Advert/AdvertFormType.php

@@ -85,6 +85,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     t('HTML code') => Advert::TYPE_CODE,
                     t('Image with link') => Advert::TYPE_IMAGE,
                 ],
+                'choice_translation_domain' => false,
                 'expanded' => true,
                 'multiple' => false,
                 'constraints' => [

src/Form/Admin/Article/ArticleFormType.php

@@ -106,6 +106,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     t('Site') => Article::TYPE_SITE,
                     t('Link') => Article::TYPE_LINK,
                 ],
+                'choice_translation_domain' => false,
                 'expanded' => true,
                 'multiple' => false,
                 'label' => t('Type'),

src/Form/Admin/Category/CategoryFormType.php

@@ -17,6 +17,7 @@
 use Shopsys\FrameworkBundle\Form\Locale\LocalizedType;
 use Shopsys\FrameworkBundle\Form\SortableValuesType;
 use Shopsys\FrameworkBundle\Form\UrlListType;
+use Shopsys\FrameworkBundle\Model\Category\AutomatedFilter\CategoryAutomatedFilterFacade;
 use Shopsys\FrameworkBundle\Model\Category\Category;
 use Shopsys\FrameworkBundle\Model\Category\CategoryData;
 use Shopsys\FrameworkBundle\Model\Category\CategoryFacade;
@@ -44,6 +45,7 @@ class CategoryFormType extends AbstractType
      * @param \Shopsys\FrameworkBundle\Component\Plugin\PluginCrudExtensionFacade $pluginCrudExtensionFacade
      * @param \Shopsys\FrameworkBundle\Model\Localization\Localization $localization
      * @param \Shopsys\FrameworkBundle\Model\Product\Parameter\ParameterRepository $parameterRepository
+     * @param \Shopsys\FrameworkBundle\Model\Category\AutomatedFilter\CategoryAutomatedFilterFacade $categoryAutomatedFilterFacade
      */
     public function __construct(
         private readonly CategoryFacade $categoryFacade,
@@ -52,6 +54,7 @@ public function __construct(
         private readonly PluginCrudExtensionFacade $pluginCrudExtensionFacade,
         private readonly Localization $localization,
         private readonly ParameterRepository $parameterRepository,
+        private readonly CategoryAutomatedFilterFacade $categoryAutomatedFilterFacade,
     ) {
     }
 
@@ -110,6 +113,8 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 ]);
         }
 
+        $categoryAutomatedFiltersNotesIndexedByValue = $this->categoryAutomatedFilterFacade->getNotesIndexedByValue();
+
         $builderSettingsGroup
             ->add('name', LocalizedType::class, [
                 'main_constraints' => [
@@ -139,6 +144,28 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ->add('enabled', DomainsType::class, [
                 'required' => false,
                 'label' => t('Display on'),
+            ])
+            ->add('automatedFilters', ChoiceType::class, [
+                'label' => 'Automated filters',
+                'required' => false,
+                'multiple' => true,
+                'expanded' => true,
+                'choice_translation_domain' => false,
+                'choices' => $this->categoryAutomatedFilterFacade->getAllValuesIndexedByLabel(),
+                'choice_attr' => function ($choice, $key, $value) use ($categoryAutomatedFiltersNotesIndexedByValue) {
+                    $iconTitle = $categoryAutomatedFiltersNotesIndexedByValue[$value] ?? null;
+
+                    if ($iconTitle === null) {
+                        return [];
+                    }
+
+                    return [
+                        'icon' => true,
+                        'iconTitle' => $iconTitle,
+                        'iconPlacement' => 'right',
+                        'iconClass' => 'margin-left-10',
+                    ];
+                },
             ]);
 
         $builderSeoGroup = $builder->create('seo', GroupType::class, [

src/Form/Admin/Customer/RoleGroup/CustomerUserRoleGroupFormType.php

@@ -47,6 +47,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             'multiple' => true,
             'expanded' => true,
             'choices' => $this->customerUserRole->getAvailableRoles(),
+            'choice_translation_domain' => false,
         ]);
 
         $builder->add('save', SubmitType::class);

src/Form/Admin/PromoCode/PromoCodeFlagType.php

@@ -48,6 +48,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 t('Products with this flag') => PromoCodeFlag::TYPE_INCLUSIVE,
                 t('Products without this flag') => PromoCodeFlag::TYPE_EXCLUSIVE,
             ],
+            'choice_translation_domain' => false,
             'expanded' => true,
             'multiple' => false,
             'constraints' => [

src/Form/Admin/PromoCode/PromoCodeFormType.php

@@ -113,6 +113,7 @@ private function buildBaseGroup(FormBuilderInterface $builder): void
                 'expanded' => true,
                 'multiple' => false,
                 'choices' => $this->promoCodeTypeEnum->getAllIndexedByTranslations(),
+                'choice_translation_domain' => false,
                 'label' => t('Discount type'),
                 'attr' => [
                     'class' => 'js-promo-code-discount-type',

src/Form/RolesType.php

@@ -41,6 +41,7 @@ public function configureOptions(OptionsResolver $resolver): void
             'expanded' => true,
             'label' => false,
             'choices' => $this->rolesChoices,
+            'choice_translation_domain' => false,
         ]);
     }
 

src/Migrations/Version20241216165539.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Shopsys\MigrationBundle\Component\Doctrine\Migrations\AbstractMigration;
+
+class Version20241216165539 extends AbstractMigration
+{
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $schema
+     */
+    public function up(Schema $schema): void
+    {
+        $this->sql('ALTER TABLE categories ADD automated_filters JSON NOT NULL DEFAULT \'{}\'');
+        $this->sql('ALTER TABLE categories ALTER automated_filters DROP DEFAULT');
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $schema
+     */
+    public function down(Schema $schema): void
+    {
+    }
+}

src/Model/Category/AutomatedFilter/CategoryAutomatedFilterFacade.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Model\Category\AutomatedFilter;
+
+use Shopsys\FrameworkBundle\Model\Category\Category;
+use Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery;
+use Traversable;
+
+class CategoryAutomatedFilterFacade
+{
+    /**
+     * @param \Traversable<int, \Shopsys\FrameworkBundle\Model\Category\AutomatedFilter\CategoryAutomatedFilterInterface> $categoryAutomatedFilters
+     */
+    public function __construct(
+        protected readonly Traversable $categoryAutomatedFilters,
+    ) {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getAllValuesIndexedByLabel(): array
+    {
+        $valuesIndexedByLabel = [];
+
+        foreach ($this->categoryAutomatedFilters as $categoryAutomatedFilter) {
+            $valuesIndexedByLabel[$categoryAutomatedFilter->getLabel()] = $categoryAutomatedFilter->getDatabaseValue();
+        }
+
+        return $valuesIndexedByLabel;
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getNotesIndexedByValue(): array
+    {
+        $notesIndexedByValue = [];
+
+        foreach ($this->categoryAutomatedFilters as $categoryAutomatedFilter) {
+            $notesIndexedByValue[$categoryAutomatedFilter->getDatabaseValue()] = $categoryAutomatedFilter->getNote();
+        }
+
+        return $notesIndexedByValue;
+    }
+
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery $filterQuery
+     * @param \Shopsys\FrameworkBundle\Model\Category\Category $category
+     * @return \Shopsys\FrameworkBundle\Model\Product\Search\FilterQuery
+     */
+    public function applyFiltersByCategory(FilterQuery $filterQuery, Category $category): FilterQuery
+    {
+        $filterQuery = $filterQuery->filterByCategory($category->getId());
+
+        foreach ($this->getByCategory($category) as $automatedFilter) {
+            $filterQuery = $automatedFilter->applyFilter($filterQuery);
+        }
+
+        return $filterQuery;
+    }
+
+    /**
+     * @param \Shopsys\FrameworkBundle\Model\Category\Category $category
+     * @return \Shopsys\FrameworkBundle\Model\Category\AutomatedFilter\CategoryAutomatedFilterInterface[]
+     */
+    protected function getByCategory(Category $category): array
+    {
+        $categoryAutomatedFilters = [];
+
+        foreach ($this->categoryAutomatedFilters as $categoryAutomatedFilter) {
+            if ($category->isUsingAutomatedFilter($categoryAutomatedFilter)) {
+                $categoryAutomatedFilters[] = $categoryAutomatedFilter;
+            }
+        }
+
+        return $categoryAutomatedFilters;
+    }
+}