Added possibility to hide ProductAttribute and ProductOption filters

composer.json

@@ -70,6 +70,10 @@
   },
   "autoload-dev": {
     "psr-4": {
+      "Tests\\BitBag\\SyliusElasticsearchPlugin\\": [
+        "tests/",
+        "tests/Application/src"
+      ],
       "Tests\\BitBag\\SyliusElasticsearchPlugin\\Behat\\": "tests/Behat",
       "spec\\BitBag\\SyliusElasticsearchPlugin\\": "spec/"
     },

config/services/form.xml

@@ -80,5 +80,13 @@
             <argument type="service" id="bitbag_sylius_elasticsearch_plugin.facet.registry" />
             <argument type="service" id="fos_elastica.finder.bitbag_shop_product" />
         </service>
+
+        <service id="bitbag_sylius_elasticsearch_plugin.form.extension.type.product_attribute" class="BitBag\SyliusElasticsearchPlugin\Form\Extension\ProductAttributeTypeExtension">
+            <tag name="form.type_extension" extended-type="Sylius\Bundle\AdminBundle\Form\Type\ProductAttributeType" />
+        </service>
+
+        <service id="bitbag_sylius_elasticsearch_plugin.form.extension.type.product_option" class="BitBag\SyliusElasticsearchPlugin\Form\Extension\ProductOptionTypeExtension">
+            <tag name="form.type_extension" extended-type="Sylius\Bundle\AdminBundle\Form\Type\ProductOptionType" />
+        </service>
     </services>
 </container>

config/twig/bitbag_twig_hooks.yml

@@ -202,3 +202,19 @@ sylius_twig_hooks:
           order_by: 'price'
           sort: 'asc'
         priority: 200
+    'sylius_admin.product_attribute.create.content.form.general':
+      facet_disabled:
+        template: '@BitBagSyliusElasticsearchPlugin/admin/product_attribute/form/general/facet_disabled.html.twig'
+        priority: -100
+    'sylius_admin.product_attribute.update.content.form.general':
+      facet_disabled:
+        template: '@BitBagSyliusElasticsearchPlugin/admin/product_attribute/form/general/facet_disabled.html.twig'
+        priority: -100
+    'sylius_admin.product_option.create.content.form.sections.general':
+      facet_disabled:
+        template: '@BitBagSyliusElasticsearchPlugin/admin/product_attribute/form/general/facet_disabled.html.twig'
+        priority: -100
+    'sylius_admin.product_option.update.content.form.sections.general':
+      facet_disabled:
+        template: '@BitBagSyliusElasticsearchPlugin/admin/product_attribute/form/general/facet_disabled.html.twig'
+        priority: -100

doc/installation.md

@@ -89,14 +89,37 @@ fos_elastica:
 ```
 
 ## Entities
-Use `BitBag\SyliusElasticsearchPlugin\Model\ProductVariantTrait` and `BitBag\SyliusElasticsearchPlugin\Model\ProductVariantInterface` in an overridden ProductVariant entity class.
-The configuration, depending on the mapping used, may vary.
+Use 
+
+`BitBag\SyliusElasticsearchPlugin\Model\ProductVariantTrait` 
+`BitBag\SyliusElasticsearchPlugin\Model\ProductVariantInterface` 
+`BitBag\SyliusElasticsearchPlugin\Entity\DisableFacetAwareTrait` 
+`BitBag\SyliusElasticsearchPlugin\Entity\ProductAttributeInterface` 
+`BitBag\SyliusElasticsearchPlugin\Entity\ProductOptionInterface` 
+
+in an overridden ProductVariant,ProductOption and ProductAttribute entity classes. The configuration, depending on the mapping used, may vary.
 
 ### Attribute mapping
 - [Attribute mapping configuration](installation/attribute-mapping.md)
 ### XML mapping
 - [XML mapping configuration](installation/xml-mapping.md)
 
+### Add configuration for extended product option and product attribute:
+```yaml
+sylius_product:
+  resources:
+    product_option:
+      classes:
+        model: App\Entity\Product\ProductOption
+
+sylius_attribute:
+  resources:
+    product:
+      attribute:
+        classes:
+          model: App\Entity\Product\ProductAttribute
+```
+
 ### Update installed assets with the following command:
 ```bash
 bin/console assets:install
@@ -107,6 +130,12 @@ bin/console assets:install
 bin/console cache:clear
 ```
 
+### Finish the installation by updating the database schema and installing assets
+```bash
+bin/console doctrine:migrations:diff
+bin/console doctrine:migrations:migrate
+```
+
 ### Finally, with an elasticsearch server running, execute following command:
 ```bash
 bin/console fos:elastica:populate

src/Entity/DisableFacetAwareInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusElasticsearchPlugin\Entity;
+
+interface DisableFacetAwareInterface
+{
+    public function isFacetDisabled(): bool;
+
+    public function setFacetDisabled(bool $facetDisabled): void;
+}

src/Entity/DisableFacetAwareTrait.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusElasticsearchPlugin\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+trait DisableFacetAwareTrait
+{
+    #[ORM\Column(type: 'boolean', options: ['default' => false])]
+    protected bool $facetDisabled = false;
+
+    public function isFacetDisabled(): bool
+    {
+        return $this->facetDisabled;
+    }
+
+    public function setFacetDisabled(bool $facetDisabled): void
+    {
+        $this->facetDisabled = $facetDisabled;
+    }
+}

src/Entity/ProductAttributeInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusElasticsearchPlugin\Entity;
+
+use Sylius\Component\Product\Model\ProductAttributeInterface as BaseProductAttributeInterface;
+
+interface ProductAttributeInterface extends DisableFacetAwareInterface, BaseProductAttributeInterface
+{
+}

src/Entity/ProductOptionInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusElasticsearchPlugin\Entity;
+
+use Sylius\Component\Product\Model\ProductOptionInterface as BaseProductOptionInterface;
+
+interface ProductOptionInterface extends DisableFacetAwareInterface, BaseProductOptionInterface
+{
+}

src/Facet/AutoDiscoverRegistry.php

@@ -53,7 +53,7 @@ public function autoRegister(): void
 
     private function discoverAttributes(): void
     {
-        $attributes = $this->productAttributeRepository->findAllWithTranslations($this->localeContext->getLocaleCode());
+        $attributes = $this->productAttributeRepository->findEnabledWithTranslations($this->localeContext->getLocaleCode());
 
         /** @var AttributeInterface $attribute */
         foreach ($attributes as $attribute) {
@@ -73,7 +73,7 @@ private function discoverAttributes(): void
 
     private function discoverOptions(): void
     {
-        $options = $this->productOptionRepository->findAllWithTranslations($this->localeContext->getLocaleCode());
+        $options = $this->productOptionRepository->findEnabledWithTranslations($this->localeContext->getLocaleCode());
 
         /** @var ProductOptionInterface $option */
         foreach ($options as $option) {

src/Form/Extension/ProductAttributeTypeExtension.php

@@ -0,0 +1,34 @@
+<?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 BitBag\SyliusElasticsearchPlugin\Form\Extension;
+
+use Sylius\Bundle\AdminBundle\Form\Type\ProductAttributeType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class ProductAttributeTypeExtension extends AbstractTypeExtension
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder->add('facetDisabled', CheckboxType::class, [
+            'label' => 'bitbag_sylius_elasticsearch_plugin.admin.form.facet_disabled',
+        ]);
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [ProductAttributeType::class];
+    }
+}

src/Form/Extension/ProductOptionTypeExtension.php

@@ -0,0 +1,34 @@
+<?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 BitBag\SyliusElasticsearchPlugin\Form\Extension;
+
+use Sylius\Bundle\AdminBundle\Form\Type\ProductOptionType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class ProductOptionTypeExtension extends AbstractTypeExtension
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder->add('facetDisabled', CheckboxType::class, [
+            'label' => 'bitbag_sylius_elasticsearch_plugin.admin.form.facet_disabled',
+        ]);
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [ProductOptionType::class];
+    }
+}

src/Form/Type/SearchFacetsType.php

@@ -30,7 +30,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
         foreach ($options['facets'] as $facetId => $facetData) {
             $facet = $this->facetRegistry->getFacetById((string) $facetId);
             $choices = [];
-            foreach ($facetData['buckets'] as $bucket) {
+            foreach ($facetData['buckets'] ?? [] as $bucket) {
                 $choices[$facet->getBucketLabel($bucket)] = $bucket['key'];
             }
             if ([] !== $choices) {

src/Repository/ProductAttributeRepository.php

@@ -38,12 +38,13 @@ public function getAttributeTypeByName(string $attributeName): string
         return $result['type'];
     }
 
-    public function findAllWithTranslations(?string $locale): array
+    public function findEnabledWithTranslations(?string $locale): array
     {
         /** @var EntityRepository $productAttributeRepository */
         $productAttributeRepository = $this->productAttributeRepository;
 
         $queryBuilder = $productAttributeRepository->createQueryBuilder('o');
+        $queryBuilder->andWhere('o.facetDisabled = 0');
 
         if (null !== $locale) {
             $queryBuilder

src/Repository/ProductAttributeRepositoryInterface.php

@@ -16,5 +16,5 @@ interface ProductAttributeRepositoryInterface
 {
     public function getAttributeTypeByName(string $attributeName): string;
 
-    public function findAllWithTranslations(?string $locale): array;
+    public function findEnabledWithTranslations(?string $locale): array;
 }

src/Repository/ProductOptionRepository.php

@@ -22,14 +22,16 @@ public function __construct(
     ) {
     }
 
-    public function findAllWithTranslations(?string $locale): array
+    public function findEnabledWithTranslations(?string $locale): array
     {
-        /** @var EntityRepository $queryBuilder */
-        $queryBuilder = $this->productOptionRepository;
+        /** @var EntityRepository $productAttributeRepository */
+        $productAttributeRepository = $this->productOptionRepository;
+
+        $queryBuilder = $productAttributeRepository->createQueryBuilder('o');
+        $queryBuilder->andWhere('o.facetDisabled = 0');
 
         if (null !== $locale) {
             $queryBuilder
-                ->createQueryBuilder('o')
                 ->addSelect('translation')
                 /** @phpstan-ignore-next-line phpstan can't read relationship correctly */
                 ->leftJoin('o.translations', 'translation', 'ot')
@@ -39,7 +41,6 @@ public function findAllWithTranslations(?string $locale): array
         }
 
         return $queryBuilder
-            ->createQueryBuilder('o')
             ->getQuery()
             ->getResult()
         ;

src/Repository/ProductOptionRepositoryInterface.php

@@ -14,5 +14,5 @@
 
 interface ProductOptionRepositoryInterface
 {
-    public function findAllWithTranslations(?string $locale): array;
+    public function findEnabledWithTranslations(?string $locale): array;
 }

templates/admin/product_attribute/form/general/facet_disabled.html.twig

@@ -0,0 +1,3 @@
+<div class="col-12 col-md-6">
+    {{ form_row(hookable_metadata.context.form.facetDisabled, sylius_test_form_attribute('facetDisabled')) }}
+</div>

tests/Application/config/packages/doctrine.yaml

@@ -12,3 +12,14 @@ doctrine:
         charset: UTF8
 
         url: '%env(resolve:DATABASE_URL)%'
+
+    orm:
+        entity_managers:
+            default:
+                auto_mapping: true
+                mappings:
+                    TestApp:
+                        is_bundle: false
+                        type: attribute
+                        dir: '%kernel.project_dir%/src/Entity'
+                        prefix: Tests\BitBag\SyliusElasticsearchPlugin

tests/Application/config/packages/sylius_product.yaml

@@ -0,0 +1,12 @@
+sylius_product:
+  resources:
+    product_option:
+      classes:
+        model: Tests\BitBag\SyliusElasticsearchPlugin\Entity\ProductOption
+
+sylius_attribute:
+  resources:
+    product:
+      attribute:
+        classes:
+          model: Tests\BitBag\SyliusElasticsearchPlugin\Entity\ProductAttribute

tests/Application/src/Entity/ProductAttribute.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace Tests\BitBag\SyliusElasticsearchPlugin\Entity;
+
+use BitBag\SyliusElasticsearchPlugin\Entity\DisableFacetAwareTrait;
+use BitBag\SyliusElasticsearchPlugin\Entity\ProductAttributeInterface;
+use Doctrine\ORM\Mapping as ORM;
+use Sylius\Component\Product\Model\ProductAttribute as BaseProductAttribute;
+
+#[ORM\Entity]
+#[ORM\Table(name: 'sylius_product_attribute')]
+class ProductAttribute extends BaseProductAttribute implements ProductAttributeInterface
+{
+    use DisableFacetAwareTrait;
+}