Make block options multi-shop compatible

Kaudaj · Aug 2, 2023 · 567d4f0 · 567d4f0
1 parent 66f9a8d
commit 567d4f0
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 70 deletions.
diff --git a/config/services/admin/domain/block.yml b/config/services/admin/domain/block.yml
@@ -10,10 +10,12 @@ services:
       - name: tactician.handler
         command: Kaudaj\Module\Blocks\Domain\Block\Query\GetBlocks
 
-  kaudaj.module.blocks.block.query_handler.get_block_for_editing:
+  kaudaj.module.blocks.block.query_handler.get_for_editing:
     public: true
     parent: kaudaj.module.blocks.block.query_handler.abstract
     class: Kaudaj\Module\Blocks\Domain\Block\QueryHandler\GetBlockForEditingHandler
+    arguments:
+      - '@kaudaj.module.blocks.block_context'
     tags:
       - name: tactician.handler
         command: Kaudaj\Module\Blocks\Domain\Block\Query\GetBlockForEditing

diff --git a/config/services/common/common.yml b/config/services/common/common.yml
@@ -6,6 +6,7 @@ services:
     class: Kaudaj\Module\Blocks\BlockTypeProviderFactory
     arguments:
       - '@=service("prestashop.adapter.legacy.context").getContext().language.id'
+      - '@kaudaj.module.blocks.block_context'
 
   kaudaj.module.blocks.block_type_provider:
     class: Kaudaj\Module\Blocks\BlockTypeProvider

diff --git a/kjblocks.php b/kjblocks.php
@@ -130,8 +130,7 @@ private function installTables()
         $sql[] = "
             CREATE TABLE IF NOT EXISTS `$dbPrefix" . BlockRepository::TABLE_NAME . "` (
                 `id_block` INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-                `type` VARCHAR(255) NOT NULL,
-                `options` JSON
+                `type` VARCHAR(255) NOT NULL
             ) ENGINE=$dbEngine COLLATE=utf8mb4_general_ci;
         ";
 
@@ -157,6 +156,7 @@ private function installTables()
                 `id_shop` INT,
                 `id_shop_group` INT,
                 `active` BOOLEAN NOT NULL,
+                `options` JSON,
                 FOREIGN KEY (`id_block`)
                 REFERENCES `$dbPrefix" . BlockRepository::TABLE_NAME . "` (`id_block`)
                 ON DELETE CASCADE,
@@ -389,4 +389,9 @@ private function getService(string $backService, string $frontService)
 
         return $object;
     }
+
+    public function getContextCacheId(): string
+    {
+        return str_replace($this->name . '|', '', $this->getCacheId());
+    }
 }
diff --git a/src/Block.php b/src/Block.php
@@ -99,10 +99,16 @@ public function render(): string
             throw new \RuntimeException("Module {$this->getModuleName()} not found");
         }
 
+        /** @var \KJBlocks|false */
+        $kjblocks = \Module::getInstanceByName('kjblocks');
+        if (!$kjblocks) {
+            throw new \RuntimeException('Module kjblocks not found');
+        }
+
         $smarty = $this->legacyContext->getSmarty();
 
         $template = $this->getTemplate();
-        $cacheId = $this->getCacheId() . $this->getContextCacheId();
+        $cacheId = $this->getCacheId() . $kjblocks->getContextCacheId();
         $isCached = $module->isCached($template, $cacheId);
 
         if (!$isCached) {
@@ -133,22 +139,6 @@ protected function getCacheId(): string
         return "{$this->getModuleName()}|{$this->id}";
     }
 
-    public static function getContextCacheId(): string
-    {
-        $context = \Context::getContext();
-        if (!$context || !$context->language) {
-            return '';
-        }
-
-        $cacheId = "|{$context->language->id}";
-
-        if ($context->currency) {
-            $cacheId .= "|{$context->currency->id}";
-        }
-
-        return $cacheId;
-    }
-
     public function setOptions(array $options = []): void
     {
         if (key_exists(self::OPTION_ID, $options)) {

diff --git a/src/BlockTypeProvider.php b/src/BlockTypeProvider.php
@@ -57,9 +57,15 @@ class BlockTypeProvider
      */
     protected $contextLangId;
 
-    public function __construct(int $contextLangId, string $hookName)
+    /**
+     * @var BlockContext
+     */
+    protected $blockContext;
+
+    public function __construct(int $contextLangId, BlockContext $blockContext, string $hookName)
     {
         $this->contextLangId = $contextLangId;
+        $this->blockContext = $blockContext;
         $this->hookName = $hookName;
     }
 
@@ -206,9 +212,10 @@ public function configureOptions($blockType, array $options = []): array
     public function getBlockTypeFromEntity(Block $block)
     {
         $id = $block->getId();
+        $blockShop = $this->blockContext->getBlockShop($block);
 
         if (!key_exists($id, $this->blocks)) {
-            $options = json_decode($block->getOptions() ?: '', true) ?: [];
+            $options = $blockShop ? json_decode($blockShop->getOptions() ?: '', true) : [];
             $options = is_array($options) ? $options : [];
 
             $this->blocks[$id] = $this->getBlockType($block->getType(), $options + [

diff --git a/src/BlockTypeProviderFactory.php b/src/BlockTypeProviderFactory.php
@@ -28,14 +28,20 @@ class BlockTypeProviderFactory
      */
     protected $contextLangId;
 
-    public function __construct(int $contextLangId)
+    /**
+     * @var BlockContext
+     */
+    protected $blockContext;
+
+    public function __construct(int $contextLangId, BlockContext $blockContext)
     {
         $this->contextLangId = $contextLangId;
+        $this->blockContext = $blockContext;
     }
 
     // @phpstan-ignore-next-line
     public function create(string $hookName): BlockTypeProvider
     {
-        return new BlockTypeProvider($this->contextLangId, $hookName);
+        return new BlockTypeProvider($this->contextLangId, $this->blockContext, $hookName);
     }
 }
diff --git a/src/Domain/Block/CommandHandler/AddBlockHandler.php b/src/Domain/Block/CommandHandler/AddBlockHandler.php
@@ -45,7 +45,6 @@ public function handle(AddBlockCommand $command): BlockId
             $block = new Block();
 
             $block->setType($command->getType());
-            $block->setOptions($command->getOptions() !== null ? $command->getOptions()->getValue() : null);
 
             $blockGroupRepository = $this->entityManager->getRepository(BlockGroup::class);
 
@@ -73,13 +72,14 @@ public function handle(AddBlockCommand $command): BlockId
                 $block->addBlockLang($configuratorBlockLang);
             }
 
-            // $shopConstraint = $command->getShopConstraint();
-            // $shopId = $shopConstraint->getShopId() !== null ? $shopConstraint->getShopId()->getValue() : null;
-            // $shopGroupId = $shopConstraint->getShopGroupId() !== null ? $shopConstraint->getShopGroupId()->getValue() : null;
+            $shopConstraint = $command->getShopConstraint();
+            $shopId = $shopConstraint->getShopId() !== null ? $shopConstraint->getShopId()->getValue() : null;
+            $shopGroupId = $shopConstraint->getShopGroupId() !== null ? $shopConstraint->getShopGroupId()->getValue() : null;
 
-            // $blockShop = $this->createBlockShop($shopId, $shopGroupId);
+            $blockShop = $this->createBlockShop($shopId, $shopGroupId);
+            $blockShop->setOptions($command->getOptions() !== null ? $command->getOptions()->getValue() : null);
 
-            // $block->addBlockShop($blockShop);
+            $block->addBlockShop($blockShop);
 
             $this->entityManager->persist($block);
             $this->entityManager->flush();

diff --git a/src/Domain/Block/CommandHandler/EditBlockHandler.php b/src/Domain/Block/CommandHandler/EditBlockHandler.php
@@ -52,10 +52,6 @@ public function handle(EditBlockCommand $command): void
                 $block->setType($command->getType());
             }
 
-            if ($command->getOptions() !== null) {
-                $block->setOptions($command->getOptions()->getValue());
-            }
-
             $blockGroupsIds = $command->getBlockGroupsIds();
             if ($blockGroupsIds) {
                 $blockGroupsIds = array_map(function (BlockGroupId $blockGroupId): int {
@@ -68,10 +64,10 @@ public function handle(EditBlockCommand $command): void
             $localizedNames = $command->getLocalizedNames();
 
             if (null !== $localizedNames) {
-                foreach ($block->getBlockLangs() as $blockLangs) {
-                    $block->removeBlockLang($blockLangs);
+                foreach ($block->getBlockLangs() as $blockLang) {
+                    $block->removeBlockLang($blockLang);
 
-                    $this->entityManager->remove($blockLangs);
+                    $this->entityManager->remove($blockLang);
                 }
 
                 $this->entityManager->flush();
@@ -84,15 +80,22 @@ public function handle(EditBlockCommand $command): void
                 }
             }
 
-            // $shopConstraint = $command->getShopConstraint();
-            // $shopId = $shopConstraint->getShopId() !== null ? $shopConstraint->getShopId()->getValue() : null;
-            // $shopGroupId = $shopConstraint->getShopGroupId() !== null ? $shopConstraint->getShopGroupId()->getValue() : null;
+            $shopConstraint = $command->getShopConstraint();
+            $shopId = $shopConstraint->getShopId() !== null ? $shopConstraint->getShopId()->getValue() : null;
+            $shopGroupId = $shopConstraint->getShopGroupId() !== null ? $shopConstraint->getShopGroupId()->getValue() : null;
 
-            // $block->removeBlockShop($block->getBlockShop($shopId, $shopGroupId));
+            $blockShop = $block->getBlockShop($shopId, $shopGroupId);
+            if ($blockShop) {
+                $block->removeBlockShop($blockShop);
+                $this->entityManager->remove($blockShop);
+            }
+
+            $this->entityManager->flush();
 
-            // $blockShop = $this->createBlockShop($shopId, $shopGroupId);
+            $blockShop = $this->createBlockShop($shopId, $shopGroupId);
+            $blockShop->setOptions($command->getOptions() !== null ? $command->getOptions()->getValue() : null);
 
-            // $block->addBlockShop($blockShop);
+            $block->addBlockShop($blockShop);
 
             $this->entityManager->persist($block);
             $this->entityManager->flush();

diff --git a/src/Domain/Block/QueryHandler/GetBlockForEditingHandler.php b/src/Domain/Block/QueryHandler/GetBlockForEditingHandler.php
@@ -21,6 +21,8 @@
 
 namespace Kaudaj\Module\Blocks\Domain\Block\QueryHandler;
 
+use Doctrine\ORM\EntityManager;
+use Kaudaj\Module\Blocks\BlockContext;
 use Kaudaj\Module\Blocks\Domain\Block\Exception\BlockException;
 use Kaudaj\Module\Blocks\Domain\Block\Query\GetBlockForEditing;
 use Kaudaj\Module\Blocks\Domain\Block\QueryResult\EditableBlock;
@@ -32,12 +34,24 @@
  */
 final class GetBlockForEditingHandler extends AbstractBlockQueryHandler
 {
+    /**
+     * @var BlockContext
+     */
+    protected $blockContext;
+
+    public function __construct(EntityManager $entityManager, BlockContext $blockContext)
+    {
+        parent::__construct($entityManager);
+
+        $this->blockContext = $blockContext;
+    }
+
     public function handle(GetBlockForEditing $query): EditableBlock
     {
         try {
-            $block = $this->getBlockEntity(
-                $query->getBlockId()->getValue()
-            );
+            $blockId = $query->getBlockId()->getValue();
+            $block = $this->getBlockEntity($blockId);
+            $blockShop = $this->blockContext->getBlockShop($block);
 
             $localizedNames = [];
             foreach ($block->getBlockLangs() as $blockLang) {
@@ -50,22 +64,21 @@ public function handle(GetBlockForEditing $query): EditableBlock
             }
 
             $editableBlock = new EditableBlock(
-                $block->getId(),
+                $blockId,
                 $block->getType(),
-                $block->getOptions(),
+                $blockShop ? $blockShop->getOptions() : null,
                 $blockGroupsIds,
                 $localizedNames
             );
         } catch (\Exception $e) {
             $message = sprintf(
                 'An unexpected error occurred when retrieving block with id %s',
-                var_export($query->getBlockId()->getValue(), true)
+                var_export($blockId, true)
             );
 
             throw new BlockException($message, 0, $e);
         }
 
-        return $editableBlock
-        ;
+        return $editableBlock;
     }
 }
diff --git a/src/Entity/Block.php b/src/Entity/Block.php
@@ -67,16 +67,10 @@ class Block
      */
     private $type;
 
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="json", nullable=true)
-     */
-    private $options;
-
     public function __construct()
     {
         $this->blockLangs = new ArrayCollection();
+        $this->blockShops = new ArrayCollection();
         $this->blockGroups = new ArrayCollection();
     }
 
@@ -209,15 +203,7 @@ public function setType(string $type): self
         return $this;
     }
 
-    public function getOptions(): ?string
+    public function getOptions(): void
     {
-        return $this->options;
-    }
-
-    public function setOptions(?string $options): self
-    {
-        $this->options = $options;
-
-        return $this;
     }
 }
diff --git a/src/Entity/BlockShop.php b/src/Entity/BlockShop.php
@@ -70,6 +70,13 @@ class BlockShop
      */
     protected $active = true;
 
+    /**
+     * @var string|null
+     *
+     * @ORM\Column(type="json", nullable=true)
+     */
+    private $options;
+
     public function getId(): int
     {
         return $this->id;
@@ -122,4 +129,16 @@ public function setActive(bool $active): self
 
         return $this;
     }
+
+    public function getOptions(): ?string
+    {
+        return $this->options;
+    }
+
+    public function setOptions(?string $options): self
+    {
+        $this->options = $options;
+
+        return $this;
+    }
 }
diff --git a/tests/php/phpstan_1.7.8.9.dist.neon b/tests/php/phpstan_1.7.8.9.dist.neon
@@ -1,8 +1,5 @@
 parameters:
   ignoreErrors:
-    - 
-      message: '#^Negated boolean expression is always false.$#'
-      path: %currentWorkingDirectory%/src/Block.php
     -
       message: '#^Parameter \#1 \$characterCleaner of class PrestaShop\\PrestaShop\\Core\\ConstraintValidator\\TypedRegexValidator constructor expects PrestaShop\\PrestaShop\\Core\\String\\CharacterCleaner, PrestaShop\\PrestaShop\\Adapter\\Configuration given\.$#'
       path: %currentWorkingDirectory%/src/Constraint/ConstraintValidatorFactory.php