OXDEV-8778 Code refactor

OXID-eSales · Nov 12, 2024 · 2e9f009 · 2e9f009
1 parent b1362f6
commit 2e9f009
Show file tree

Hide file tree

Showing 21 changed files with 404 additions and 167 deletions.
diff --git a/src/ProductVote/Controller/ArticleDetailsController.php b/src/ProductVote/Controller/ArticleDetailsController.php
@@ -10,8 +10,7 @@
 namespace OxidEsales\ModuleTemplate\ProductVote\Controller;
 
 use OxidEsales\Eshop\Application\Model\User;
-use OxidEsales\ModuleTemplate\ProductVote\Dao\ProductVoteDaoInterface;
-use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVote;
+use OxidEsales\ModuleTemplate\ProductVote\Service\VoteServiceInterface;
 
 /**
  * @extendable-class
@@ -35,39 +34,23 @@ public function voteDown(): void
 
     public function resetVote(): void
     {
-        $userId = $this->getUserId();
-        if (!$userId) {
+        $user = $this->getUser();
+        if (!($user instanceof User)) {
             return;
         }
 
-        $productVoteDao = $this->getProductVoteDao();
-        $productVoteDao->resetProductVote($this->getProduct()->getId(), $userId);
+        $voteService = $this->getService(VoteServiceInterface::class);
+        $voteService->resetProductVote($this->getProduct(), $user);
     }
 
     private function vote(bool $isUp): void
-    {
-        $userId = $this->getUserId();
-        if (!$userId) {
-            return;
-        }
-
-        $productVoteDao = $this->getProductVoteDao();
-        $vote = new ProductVote($this->getProduct()->getId(), $userId, $isUp);
-        $productVoteDao->setProductVote($vote);
-    }
-
-    private function getUserId(): ?string
     {
         $user = $this->getUser();
         if (!($user instanceof User)) {
-            return null;
+            return;
         }
 
-        return $user->getId();
-    }
-
-    private function getProductVoteDao(): ProductVoteDaoInterface
-    {
-        return $this->getService(ProductVoteDaoInterface::class);
+        $voteService = $this->getService(VoteServiceInterface::class);
+        $voteService->setProductVote($this->getProduct(), $user, $isUp);
     }
 }
diff --git a/src/ProductVote/Dao/ProductVoteDao.php b/src/ProductVote/Dao/ProductVoteDao.php
@@ -12,8 +12,7 @@
 use Doctrine\DBAL\Result;
 use OxidEsales\EshopCommunity\Internal\Framework\Database\QueryBuilderFactoryInterface;
 use OxidEsales\ModuleTemplate\ProductVote\DataMapper\ProductVoteDataMapperInterface;
-use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVote;
-use RuntimeException;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVoteInterface;
 
 readonly class ProductVoteDao implements ProductVoteDaoInterface
 {
@@ -23,7 +22,7 @@ public function __construct(
     ) {
     }
 
-    public function getProductVote(string $productId, string $userId): ?ProductVote
+    public function getProductVote(string $productId, string $userId): ?ProductVoteInterface
     {
         $queryBuilder = $this->queryBuilderFactory->create();
         $queryBuilder
@@ -40,22 +39,20 @@ public function getProductVote(string $productId, string $userId): ?ProductVote
                 'userId' => $userId,
             ]);
 
+        /** @var Result $result */
         $result = $queryBuilder->execute();
-        if (!($result instanceof Result)) {
-            throw new RuntimeException('Query returned error.');
-        }
-
         $row = $result->fetchAssociative();
+
         if ($row === false) {
             return null;
         }
 
         return $this->dataMapper->map($row);
     }
 
-    public function setProductVote(ProductVote $vote): void
+    public function setProductVote(ProductVoteInterface $vote): void
     {
-        $this->resetProductVote($vote->productId, $vote->userId);
+        $this->resetProductVote($vote->getProductId(), $vote->getUserId());
 
         $queryBuilder = $this->queryBuilderFactory->create();
         $queryBuilder
@@ -68,9 +65,9 @@ public function setProductVote(ProductVote $vote): void
             ])
             ->setParameters([
                 'oxid' => uniqid(),
-                'productId' => $vote->productId,
-                'userId' => $vote->userId,
-                'vote' => (int)$vote->vote,
+                'productId' => $vote->getProductId(),
+                'userId' => $vote->getUserId(),
+                'vote' => (int)$vote->isVoteUp(),
             ])
             ->execute();
     }

diff --git a/src/ProductVote/Dao/ProductVoteDaoInterface.php b/src/ProductVote/Dao/ProductVoteDaoInterface.php
@@ -9,12 +9,12 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\Dao;
 
-use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVote;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVoteInterface;
 
 interface ProductVoteDaoInterface
 {
-    public function getProductVote(string $productId, string $userId): ?ProductVote;
+    public function getProductVote(string $productId, string $userId): ?ProductVoteInterface;
 
-    public function setProductVote(ProductVote $vote): void;
+    public function setProductVote(ProductVoteInterface $vote): void;
     public function resetProductVote(string $productId, string $userId): void;
 }
diff --git a/src/ProductVote/Dao/ResultDao.php → src/ProductVote/Dao/VoteResultDao.php b/src/ProductVote/Dao/ResultDao.php → src/ProductVote/Dao/VoteResultDao.php
@@ -9,20 +9,21 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\Dao;
 
+use Doctrine\DBAL\Result;
 use OxidEsales\EshopCommunity\Internal\Framework\Database\QueryBuilderFactoryInterface;
-use OxidEsales\ModuleTemplate\ProductVote\DataMapper\ResultDataMapperInterface;
-use OxidEsales\ModuleTemplate\ProductVote\DataType\Result;
-use RuntimeException;
+use OxidEsales\ModuleTemplate\ProductVote\DataMapper\VoteResultDataMapperInterface;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResult;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResultInterface;
 
-readonly class ResultDao implements ResultDaoInterface
+readonly class VoteResultDao implements VoteResultDaoInterface
 {
     public function __construct(
         private QueryBuilderFactoryInterface $queryBuilderFactory,
-        private ResultDataMapperInterface $dataMapper,
+        private VoteResultDataMapperInterface $dataMapper,
     ) {
     }
 
-    public function getProductVoteResult(string $productId): Result
+    public function getProductVoteResult(string $productId): VoteResultInterface
     {
         $queryBuilder = $this->queryBuilderFactory->create();
         $queryBuilder
@@ -38,15 +39,12 @@ public function getProductVoteResult(string $productId): Result
                 'productId' => $productId,
             ]);
 
+        /** @var Result $queryResult */
         $queryResult = $queryBuilder->execute();
-        if (!($queryResult instanceof \Doctrine\DBAL\Result)) {
-            throw new RuntimeException('Query returned error.');
-        }
-
         $row = $queryResult->fetchAssociative();
 
         if (!$row) {
-            return new Result($productId, 0, 0);
+            return new VoteResult($productId, 0, 0);
         }
         return $this->dataMapper->map($row);
     }

diff --git a/src/ProductVote/Dao/ResultDaoInterface.php → ...roductVote/Dao/VoteResultDaoInterface.php b/src/ProductVote/Dao/ResultDaoInterface.php → ...roductVote/Dao/VoteResultDaoInterface.php
@@ -9,9 +9,9 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\Dao;
 
-use OxidEsales\ModuleTemplate\ProductVote\DataType\Result;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResultInterface;
 
-interface ResultDaoInterface
+interface VoteResultDaoInterface
 {
-    public function getProductVoteResult(string $productId): array|Result;
+    public function getProductVoteResult(string $productId): VoteResultInterface;
 }
diff --git a/...oductVote/DataMapper/ResultDataMapper.php → ...tVote/DataMapper/VoteResultDataMapper.php b/...oductVote/DataMapper/ResultDataMapper.php → ...tVote/DataMapper/VoteResultDataMapper.php
@@ -9,17 +9,17 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\DataMapper;
 
-use OxidEsales\ModuleTemplate\ProductVote\DataType\Result;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResult;
 use OxidEsales\ModuleTemplate\ProductVote\Exception\MapDataTypeException;
 
-readonly class ResultDataMapper implements ResultDataMapperInterface
+readonly class VoteResultDataMapper implements VoteResultDataMapperInterface
 {
-    public function map(array $data): Result
+    public function map(array $data): VoteResult
     {
         if (!isset($data['ProductId']) || !isset($data['VoteUp']) || !isset($data['VoteDown'])) {
             throw new MapDataTypeException();
         }
 
-        return new Result($data['ProductId'], (int)$data['VoteUp'], (int)$data['VoteDown']);
+        return new VoteResult($data['ProductId'], (int)$data['VoteUp'], (int)$data['VoteDown']);
     }
 }
diff --git a/.../DataMapper/ResultDataMapperInterface.php → ...aMapper/VoteResultDataMapperInterface.php b/.../DataMapper/ResultDataMapperInterface.php → ...aMapper/VoteResultDataMapperInterface.php
@@ -9,9 +9,9 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\DataMapper;
 
-use OxidEsales\ModuleTemplate\ProductVote\DataType\Result;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResult;
 
-interface ResultDataMapperInterface
+interface VoteResultDataMapperInterface
 {
-    public function map(array $data): Result;
+    public function map(array $data): VoteResult;
 }
diff --git a/src/ProductVote/DataType/ProductVote.php b/src/ProductVote/DataType/ProductVote.php
@@ -9,12 +9,27 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\DataType;
 
-readonly class ProductVote
+readonly class ProductVote implements ProductVoteInterface
 {
     public function __construct(
         public string $productId,
         public string $userId,
         public bool $vote,
     ) {
     }
+
+    public function getProductId(): string
+    {
+        return $this->productId;
+    }
+
+    public function getUserId(): string
+    {
+        return $this->userId;
+    }
+
+    public function isVoteUp(): bool
+    {
+        return $this->vote;
+    }
 }
diff --git a/src/ProductVote/DataType/Result.php → ...uctVote/DataType/ProductVoteInterface.php b/src/ProductVote/DataType/Result.php → ...uctVote/DataType/ProductVoteInterface.php
@@ -9,12 +9,9 @@
 
 namespace OxidEsales\ModuleTemplate\ProductVote\DataType;
 
-readonly class Result
+interface ProductVoteInterface
 {
-    public function __construct(
-        public string $productId,
-        public int $voteUp,
-        public int $voteDown,
-    ) {
-    }
+    public function getProductId(): string;
+    public function getUserId(): string;
+    public function isVoteUp(): bool;
 }
diff --git a/src/ProductVote/DataType/VoteResult.php b/src/ProductVote/DataType/VoteResult.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\ProductVote\DataType;
+
+readonly class VoteResult implements VoteResultInterface
+{
+    public function __construct(
+        private string $productId,
+        private int $voteUp,
+        private int $voteDown,
+    ) {
+    }
+
+    public function getProductId(): string
+    {
+        return $this->productId;
+    }
+
+    public function getVoteUp(): int
+    {
+        return $this->voteUp;
+    }
+
+    public function getVoteDown(): int
+    {
+        return $this->voteDown;
+    }
+}
diff --git a/src/ProductVote/DataType/VoteResultInterface.php b/src/ProductVote/DataType/VoteResultInterface.php
@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\ProductVote\DataType;
+
+interface VoteResultInterface
+{
+    public function getProductId(): string;
+    public function getVoteUp(): int;
+    public function getVoteDown(): int;
+}
diff --git a/src/ProductVote/Service/VoteService.php b/src/ProductVote/Service/VoteService.php
@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\ProductVote\Service;
+
+use OxidEsales\Eshop\Application\Model\Article;
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\ModuleTemplate\ProductVote\Dao\ProductVoteDaoInterface;
+use OxidEsales\ModuleTemplate\ProductVote\Dao\VoteResultDaoInterface;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVote;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVoteInterface;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResultInterface;
+
+readonly class VoteService implements VoteServiceInterface
+{
+    public function __construct(
+        private ProductVoteDaoInterface $productVoteDao,
+        private VoteResultDaoInterface $voteResultDao,
+    ) {
+    }
+
+    public function getProductVote(Article $product, User $user): ?ProductVoteInterface
+    {
+        return $this->productVoteDao->getProductVote($product->getId(), $user->getId());
+    }
+
+    public function setProductVote(Article $product, User $user, bool $vote): void
+    {
+        $vote = new ProductVote($product->getId(), $user->getId(), $vote);
+        $this->productVoteDao->setProductVote($vote);
+    }
+
+    public function resetProductVote(Article $product, User $user): void
+    {
+        $this->productVoteDao->resetProductVote($product->getId(), $user->getId());
+    }
+
+    public function getProductVoteResult(Article $product): VoteResultInterface
+    {
+        return $this->voteResultDao->getProductVoteResult($product->getId());
+    }
+}
diff --git a/src/ProductVote/Service/VoteServiceInterface.php b/src/ProductVote/Service/VoteServiceInterface.php
@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\ProductVote\Service;
+
+use OxidEsales\Eshop\Application\Model\Article;
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\ProductVoteInterface;
+use OxidEsales\ModuleTemplate\ProductVote\DataType\VoteResultInterface;
+
+interface VoteServiceInterface
+{
+    public function getProductVote(Article $product, User $user): ?ProductVoteInterface;
+    public function setProductVote(Article $product, User $user, bool $vote): void;
+    public function resetProductVote(Article $product, User $user): void;
+
+    public function getProductVoteResult(Article $product): VoteResultInterface;
+}