[Recommendation] #1399868 - Add gally recommendation

Author: PierreGauthier

src/Command/StructureSync.php

@@ -35,6 +35,7 @@ class StructureSync extends Command
         'catalog' => 'syncAllLocalizedCatalogs',
         'sourceField' => 'syncAllSourceFields',
         'sourceFieldOption' => 'syncAllSourceFieldOptions',
+        'recommenderType' => 'syncAllRecommenderTypes',
     ];
 
     /**

src/Form/Extension/ChannelTypeExtension.php

@@ -15,13 +15,21 @@
 namespace Gally\SyliusPlugin\Form\Extension;
 
 use Sylius\Bundle\ChannelBundle\Form\Type\ChannelType;
+use Sylius\Component\Product\Model\ProductAssociationTypeInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Symfony\Component\Form\AbstractTypeExtension;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\IntegerType;
 use Symfony\Component\Form\FormBuilderInterface;
 
 final class ChannelTypeExtension extends AbstractTypeExtension
 {
+    public function __construct(
+        private RepositoryInterface $productAssociationTypeRepository,
+    ) {
+    }
+
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
@@ -66,11 +74,43 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'attr' => [
                     'min' => 0,
                 ],
+            ])
+            ->add('gallyProductRecommendationMaxSize', IntegerType::class, [
+                'label' => 'gally_sylius.form.product_recommendation_max_size',
+                'attr' => [
+                    'min' => 0,
+                ],
+            ])
+            ->add('gallyCartRecommendationTypeCode', ChoiceType::class, [
+                'label' => 'gally_sylius.form.cart_recommendation_type',
+                'choices' => $this->getProductAssociationTypeChoices(),
+                'required' => false,
+                'placeholder' => 'gally_sylius.form.cart_recommendation_type_none',
+            ])
+            ->add('gallyCartRecommendationMaxSize', IntegerType::class, [
+                'label' => 'gally_sylius.form.cart_recommendation_max_size',
+                'attr' => [
+                    'min' => 0,
+                ],
             ]);
     }
 
     public static function getExtendedTypes(): iterable
     {
         return [ChannelType::class];
     }
+
+    /**
+     * @return array<string, string>
+     */
+    private function getProductAssociationTypeChoices(): array
+    {
+        $choices = [];
+        /** @var ProductAssociationTypeInterface $productAssociationType */
+        foreach ($this->productAssociationTypeRepository->findAll() as $productAssociationType) {
+            $choices[(string) $productAssociationType->getName()] = (string) $productAssociationType->getCode();
+        }
+
+        return $choices;
+    }
 }

src/Indexer/Provider/RecommenderTypeProvider.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade Gally to newer versions in the future.
+ *
+ * @package   Gally
+ * @author    Stephan Hochdörfer <S.Hochdoerfer@bitexpert.de>, Gally Team <elasticsuite@smile.fr>
+ * @copyright 2022-present Smile
+ * @license   Open Software License v. 3.0 (OSL-3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Indexer\Provider;
+
+use Gally\Sdk\Entity\RecommenderType;
+use Sylius\Component\Product\Model\ProductAssociationTypeInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+
+/**
+ * Gally recommender type data provider, built from Sylius product association types.
+ */
+class RecommenderTypeProvider implements ProviderInterface
+{
+    public function __construct(
+        private RepositoryInterface $productAssociationTypeRepository,
+    ) {
+    }
+
+    /**
+     * @return iterable<RecommenderType>
+     */
+    public function provide(): iterable
+    {
+        /** @var ProductAssociationTypeInterface $productAssociationType */
+        foreach ($this->productAssociationTypeRepository->findAll() as $productAssociationType) {
+            yield $this->buildRecommenderType($productAssociationType);
+        }
+    }
+
+    public function buildRecommenderType(ProductAssociationTypeInterface $productAssociationType): RecommenderType
+    {
+        return new RecommenderType(
+            (string) $productAssociationType->getName(),
+            (string) $productAssociationType->getCode(),
+        );
+    }
+}

src/Indexer/Subscriber/ProductAssociationTypeSubscriber.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade Gally to newer versions in the future.
+ *
+ * @package   Gally
+ * @author    Stephan Hochdörfer <S.Hochdoerfer@bitexpert.de>, Gally Team <elasticsuite@smile.fr>
+ * @copyright 2022-present Smile
+ * @license   Open Software License v. 3.0 (OSL-3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Indexer\Subscriber;
+
+use Gally\Sdk\Service\StructureSynchonizer;
+use Gally\SyliusPlugin\Indexer\Provider\RecommenderTypeProvider;
+use Sylius\Component\Product\Model\ProductAssociationTypeInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\EventDispatcher\GenericEvent;
+
+final class ProductAssociationTypeSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        private RecommenderTypeProvider $recommenderTypeProvider,
+        private StructureSynchonizer $structureSynchonizer,
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            'sylius.product_association_type.post_create' => 'onProductAssociationTypeUpdate',
+            'sylius.product_association_type.post_update' => 'onProductAssociationTypeUpdate',
+        ];
+    }
+
+    public function onProductAssociationTypeUpdate(GenericEvent $event): void
+    {
+        $productAssociationType = $event->getSubject();
+        if (!$productAssociationType instanceof ProductAssociationTypeInterface) {
+            return;
+        }
+
+        $recommenderType = $this->recommenderTypeProvider->buildRecommenderType($productAssociationType);
+        $this->structureSynchonizer->syncRecommenderType($recommenderType);
+    }
+}

src/Migrations/Version20260709120000.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade Gally to newer versions in the future.
+ *
+ * @package   Gally
+ * @author    Stephan Hochdörfer <S.Hochdoerfer@bitexpert.de>, Gally Team <elasticsuite@smile.fr>
+ * @copyright 2022-present Smile
+ * @license   Open Software License v. 3.0 (OSL-3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20260709120000 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return "Add recommendation configuration columns in 'sylius_channel' table.";
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE sylius_channel ADD gally_product_recommendation_max_size INT DEFAULT 4 NOT NULL, ADD gally_cart_recommendation_type_code VARCHAR(255) DEFAULT NULL, ADD gally_cart_recommendation_max_size INT DEFAULT 4 NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE sylius_channel DROP gally_product_recommendation_max_size, DROP gally_cart_recommendation_type_code, DROP gally_cart_recommendation_max_size');
+    }
+}

src/Model/GallyChannelInterface.php

@@ -57,4 +57,16 @@ public function setGallyUidCookieLifetime(int $gallyUidCookieLifetime): void;
     public function getGallyVidCookieLifetime(): int;
 
     public function setGallyVidCookieLifetime(int $gallyVidCookieLifetime): void;
+
+    public function getGallyProductRecommendationMaxSize(): int;
+
+    public function setGallyProductRecommendationMaxSize(int $gallyProductRecommendationMaxSize): void;
+
+    public function getGallyCartRecommendationTypeCode(): ?string;
+
+    public function setGallyCartRecommendationTypeCode(?string $gallyCartRecommendationTypeCode): void;
+
+    public function getGallyCartRecommendationMaxSize(): int;
+
+    public function setGallyCartRecommendationMaxSize(int $gallyCartRecommendationMaxSize): void;
 }

src/Model/GallyChannelTrait.php

@@ -20,34 +20,43 @@
 trait GallyChannelTrait
 {
     #[ORM\Column(name: 'gally_active', type: 'boolean', options: ['default' => false])]
-    protected $gallyActive = false;
+    protected bool $gallyActive = false;
 
     #[ORM\Column(name: 'gally_product_index_batch_size', type: 'integer', options: ['default' => 50])]
-    protected $gallyProductIndexBatchSize = 50;
+    protected int $gallyProductIndexBatchSize = 50;
 
     #[ORM\Column(name: 'gally_category_index_batch_size', type: 'integer', options: ['default' => 50])]
-    protected $gallyCategoryIndexBatchSize = 50;
+    protected int $gallyCategoryIndexBatchSize = 50;
 
     #[ORM\Column(name: 'gally_autocomplete_product_max_size', type: 'integer', options: ['default' => 6])]
-    protected $gallyAutocompleteProductMaxSize = 6;
+    protected int $gallyAutocompleteProductMaxSize = 6;
 
     #[ORM\Column(name: 'gally_autocomplete_category_max_size', type: 'integer', options: ['default' => 6])]
-    protected $gallyAutocompleteCategoryMaxSize = 6;
+    protected int $gallyAutocompleteCategoryMaxSize = 6;
 
     #[ORM\Column(name: 'gally_autocomplete_attribute_max_size', type: 'integer', options: ['default' => 6])]
-    protected $gallyAutocompleteAttributeMaxSize = 6;
+    protected int $gallyAutocompleteAttributeMaxSize = 6;
 
     #[ORM\Column(name: 'gally_tracking_active', type: 'boolean', options: ['default' => true])]
-    protected $gallyTrackingActive = true;
+    protected bool $gallyTrackingActive = true;
 
     #[ORM\Column(name: 'gally_use_sylius_endpoint_tracking', type: 'boolean', options: ['default' => true])]
-    protected $gallyUseSyliusEndpointTracking = true;
+    protected bool $gallyUseSyliusEndpointTracking = true;
 
     #[ORM\Column(name: 'gally_uid_cookie_lifetime', type: 'integer', options: ['default' => 3600])]
-    protected $gallyUidCookieLifetime = 3600;
+    protected int $gallyUidCookieLifetime = 3600;
 
     #[ORM\Column(name: 'gally_vid_cookie_lifetime', type: 'integer', options: ['default' => 31536000])]
-    protected $gallyVidCookieLifetime = 31536000;
+    protected int $gallyVidCookieLifetime = 31536000;
+
+    #[ORM\Column(name: 'gally_product_recommendation_max_size', type: 'integer', options: ['default' => 4])]
+    protected int $gallyProductRecommendationMaxSize = 4;
+
+    #[ORM\Column(name: 'gally_cart_recommendation_type_code', type: 'string', nullable: true)]
+    protected ?string $gallyCartRecommendationTypeCode = null;
+
+    #[ORM\Column(name: 'gally_cart_recommendation_max_size', type: 'integer', options: ['default' => 4])]
+    protected int $gallyCartRecommendationMaxSize = 4;
 
     public function getGallyActive(): bool
     {
@@ -148,4 +157,34 @@ public function setGallyVidCookieLifetime(int $gallyVidCookieLifetime): void
     {
         $this->gallyVidCookieLifetime = $gallyVidCookieLifetime;
     }
+
+    public function getGallyProductRecommendationMaxSize(): int
+    {
+        return $this->gallyProductRecommendationMaxSize;
+    }
+
+    public function setGallyProductRecommendationMaxSize(int $gallyProductRecommendationMaxSize): void
+    {
+        $this->gallyProductRecommendationMaxSize = $gallyProductRecommendationMaxSize;
+    }
+
+    public function getGallyCartRecommendationTypeCode(): ?string
+    {
+        return $this->gallyCartRecommendationTypeCode;
+    }
+
+    public function setGallyCartRecommendationTypeCode(?string $gallyCartRecommendationTypeCode): void
+    {
+        $this->gallyCartRecommendationTypeCode = $gallyCartRecommendationTypeCode;
+    }
+
+    public function getGallyCartRecommendationMaxSize(): int
+    {
+        return $this->gallyCartRecommendationMaxSize;
+    }
+
+    public function setGallyCartRecommendationMaxSize(int $gallyCartRecommendationMaxSize): void
+    {
+        $this->gallyCartRecommendationMaxSize = $gallyCartRecommendationMaxSize;
+    }
 }