Import category position from Akeneo

synolia · Nov 6, 2023 · cb03582 · cb03582
1 parent b6ad918
commit cb03582
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 20 deletions.
diff --git a/docs/CONFIGURE_DETAIL.md b/docs/CONFIGURE_DETAIL.md
@@ -53,6 +53,8 @@ The category import configuration contains two configurations.
 
 `excluded_category_codes` allows you to choose the categories that you want to exclude from the import.
 
+`use_akeneo_positions` import category position from Akeneo, this will bypass the default sortable event.
+
 **Selecting a parent will exclude the parent and its children**.
 
 ```yaml
@@ -66,6 +68,7 @@ synolia_sylius_akeneo:
             - led_tvs
             - audio_video
             - mp3_players
+        use_akeneo_positions: true
 ```
 
 

diff --git a/src/DependencyInjection/SynoliaSyliusAkeneoExtension.php b/src/DependencyInjection/SynoliaSyliusAkeneoExtension.php
@@ -126,7 +126,7 @@ private function processCategoryConfiguration(ContainerBuilder $container, array
         $categoryConfigurationProviderDefinition
             ->setArgument('$categoryCodesToImport', $config['category_configuration']['root_category_codes'])
             ->setArgument('$categoryCodesToExclude', $config['category_configuration']['excluded_category_codes'])
-            ->setArgument('$categoryCodesToExclude', $config['category_configuration']['use_akeneo_positions'])
+            ->setArgument('$useAkeneoPositions', $config['category_configuration']['use_akeneo_positions'])
         ;
 
         $container->setAlias(CategoryConfigurationProviderInterface::class, CategoryConfigurationProvider::class);

diff --git a/src/Entity/CategoryConfiguration.php b/src/Entity/CategoryConfiguration.php
@@ -48,6 +48,10 @@ class CategoryConfiguration implements ResourceInterface
     #[ORM\Column(type: Types::ARRAY)]
     private array $rootCategories = [];
 
+    /** @ORM\Column(type="boolean") */
+    #[ORM\Column(type: Types::BOOLEAN)]
+    private bool $useAkeneoPositions = false;
+
     public function getId(): int
     {
         return $this->id;
@@ -88,4 +92,16 @@ public function setRootCategories(array $rootCategories): self
 
         return $this;
     }
+
+    public function useAkeneoPositions(): bool
+    {
+        return $this->useAkeneoPositions;
+    }
+
+    public function setUseAkeneoPositions(bool $useAkeneoPositions): self
+    {
+        $this->useAkeneoPositions = $useAkeneoPositions;
+
+        return $this;
+    }
 }
diff --git a/src/Fixture/CategoryConfigurationFixture.php b/src/Fixture/CategoryConfigurationFixture.php
@@ -23,6 +23,7 @@ public function load(array $options): void
         $categoryConfiguration = $this->categoriesConfigurationFactory->createNew();
         $categoryConfiguration->setRootCategories($options['root_categories_to_import']);
         $categoryConfiguration->setNotImportCategories($options['categories_to_exclude']);
+        $categoryConfiguration->setUseAkeneoPositions($options['use_akeneo_positions']);
 
         $this->entityManager->persist($categoryConfiguration);
         $this->entityManager->flush();
@@ -46,6 +47,9 @@ protected function configureOptionsNode(ArrayNodeDefinition $optionsNode): void
                 ->arrayNode('categories_to_exclude')
                     ->scalarPrototype()->defaultValue([])->end()
                 ->end()
+                ->arrayNode('use_akeneo_positions')
+                    ->scalarPrototype()->defaultFalse()->end()
+                ->end()
             ->end()
         ;
     }

diff --git a/src/Form/Type/CategoriesConfigurationType.php b/src/Form/Type/CategoriesConfigurationType.php
@@ -5,6 +5,7 @@
 namespace Synolia\SyliusAkeneoPlugin\Form\Type;
 
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\FormBuilderInterface;
 
@@ -26,6 +27,10 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'required' => false,
                 'multiple' => true,
             ])
+            ->add('use_akeneo_positions', CheckboxType::class, [
+                'label' => 'sylius.ui.admin.akeneo.categories.use_akeneo_positions',
+                'required' => false,
+            ])
             ->add('submit', SubmitType::class, [
                 'attr' => ['class' => 'ui icon primary button'],
                 'label' => 'sylius.ui.admin.akeneo.save',

diff --git a/src/Manager/Doctrine/DoctrineSortableManager.php b/src/Manager/Doctrine/DoctrineSortableManager.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Synolia\SyliusAkeneoPlugin\Manager\Doctrine;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Gedmo\Sortable\SortableListener;
+
+class DoctrineSortableManager
+{
+    private array $originalEventListeners = [];
+
+    public function __construct(private EntityManagerInterface $entityManager)
+    {
+    }
+
+    public function disableSortableEventListener(): void
+    {
+        foreach ($this->entityManager->getEventManager()->getListeners() as $eventName => $listeners) {
+            foreach ($listeners as $listener) {
+                if ($listener instanceof SortableListener) {
+                    $this->originalEventListeners[$eventName] = $listener;
+                    $this->entityManager->getEventManager()->removeEventListener($eventName, $listener);
+                }
+            }
+        }
+    }
+
+    public function enableSortableEventListener(): void
+    {
+        if ($this->originalEventListeners === []) {
+            return;
+        }
+
+        foreach ($this->originalEventListeners as $eventName => $listener) {
+            $this->entityManager->getEventManager()->addEventListener($eventName, $listener);
+        }
+    }
+}
diff --git a/src/Migrations/Version20231106080715.php b/src/Migrations/Version20231106080715.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Synolia\SyliusAkeneoPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20231106080715 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Added useAkeneoPositions column';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE akeneo_api_configuration_categories ADD useAkeneoPositions TINYINT(1) NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE akeneo_api_configuration_categories DROP useAkeneoPositions');
+    }
+}
diff --git a/src/Model/Configuration/CategoryConfiguration.php b/src/Model/Configuration/CategoryConfiguration.php
@@ -37,7 +37,7 @@ public function setCategoryCodesToExclude(array $categoryCodesToExclude): self
         return $this;
     }
 
-    public function isUseAkeneoPositions(): bool
+    public function useAkeneoPositions(): bool
     {
         return $this->useAkeneoPositions;
     }

diff --git a/src/Model/Configuration/CategoryConfigurationInterface.php b/src/Model/Configuration/CategoryConfigurationInterface.php
@@ -14,7 +14,7 @@ public function setCategoryCodesToImport(array $categoryCodesToImport): self;
 
     public function setCategoryCodesToExclude(array $categoryCodesToExclude): self;
 
-    public function isUseAkeneoPositions(): bool;
+    public function useAkeneoPositions(): bool;
 
     public function setUseAkeneoPositions(bool $useAkeneoPositions): self;
 }
diff --git a/src/Resources/translations/messages.en.yml b/src/Resources/translations/messages.en.yml
@@ -65,6 +65,7 @@ sylius:
                     main_category: Main category
                     root_categories: Sylius Root categories
                     empty_local_replace_by: Replace empty local by
+                    use_akeneo_positions: Import category position from Akeneo
                 products:
                     title: Products
                     subtitle: Products configuration

diff --git a/src/Resources/translations/messages.fr.yml b/src/Resources/translations/messages.fr.yml
@@ -65,6 +65,7 @@ sylius:
                     main_category: Catégorie principale
                     root_categories: Catégories racines de Sylius
                     empty_local_replace_by: Remplacer la locale vide par
+                    use_akeneo_positions: Importer la position des catégories d'Akeneo
                 products:
                     title: Produits
                     subtitle: Configuration des produits

diff --git a/src/Task/Category/CreateUpdateEntityTask.php b/src/Task/Category/CreateUpdateEntityTask.php
@@ -6,7 +6,6 @@
 
 use Behat\Transliterator\Transliterator;
 use Doctrine\ORM\EntityManagerInterface;
-use Gedmo\Sortable\SortableListener;
 use Psr\Log\LoggerInterface;
 use Sylius\Component\Core\Model\TaxonInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
@@ -23,6 +22,7 @@
 use Synolia\SyliusAkeneoPlugin\Event\Category\BeforeProcessingTaxonEvent;
 use Synolia\SyliusAkeneoPlugin\Exceptions\UnsupportedAttributeTypeException;
 use Synolia\SyliusAkeneoPlugin\Logger\Messages;
+use Synolia\SyliusAkeneoPlugin\Manager\Doctrine\DoctrineSortableManager;
 use Synolia\SyliusAkeneoPlugin\Payload\Category\CategoryPayload;
 use Synolia\SyliusAkeneoPlugin\Payload\PipelinePayloadInterface;
 use Synolia\SyliusAkeneoPlugin\Provider\Configuration\Api\CategoryConfigurationProviderInterface;
@@ -64,6 +64,7 @@ public function __construct(
         private TaxonAttributeTypeMatcher $taxonAttributeTypeMatcher,
         private TaxonAttributeValueBuilder $taxonAttributeValueBuilder,
         private CategoryConfigurationProviderInterface $categoryConfigurationProvider,
+        private DoctrineSortableManager $sortableManager,
     ) {
     }
 
@@ -153,27 +154,14 @@ public function __invoke(PipelinePayloadInterface $payload): PipelinePayloadInte
 
                 $this->dispatcher->dispatch(new AfterProcessingTaxonEvent($resource, $taxon));
 
-                if ($this->categoryConfigurationProvider->get()->isUseAkeneoPositions()) {
+                if ($this->categoryConfigurationProvider->get()->useAkeneoPositions()) {
                     $taxon->setPosition($resource['position']);
 
-                    foreach ($this->entityManager->getEventManager()->getAllListeners() as $listenerTypes) {
-                        foreach ($listenerTypes as $listener) {
-                            if (get_class($listener) === SortableListener::class) {
-                                $this->entityManager->getEventManager()->removeEventListener([
-                                    'onFlush',
-                                    'loadClassMetadata',
-                                    'prePersist',
-                                    'postPersist',
-                                    'preUpdate',
-                                    'postRemove',
-                                    'postFlush',
-                                ], $listener);
-                            }
-                        }
-                    }
+                    $this->sortableManager->disableSortableEventListener();
                 }
 
                 $this->entityManager->flush();
+                $this->sortableManager->enableSortableEventListener();
 
                 if ($this->entityManager->getConnection()->isTransactionActive()) {
                     $this->entityManager->commit();

diff --git a/src/Transformer/Configuration/DatabaseCategoryConfigurationToApiConnectionTransformer.php b/src/Transformer/Configuration/DatabaseCategoryConfigurationToApiConnectionTransformer.php
@@ -14,6 +14,7 @@ public function transform(CategoryConfiguration $configuration): CategoryConfigu
         return new \Synolia\SyliusAkeneoPlugin\Model\Configuration\CategoryConfiguration(
             $configuration->getRootCategories(),
             $configuration->getNotImportCategories(),
+            $configuration->useAkeneoPositions(),
         );
     }
 }