SV-34 Implemented Logger interface

composer.json

@@ -49,8 +49,7 @@
         "phpunit/phpunit": "*",
         "behat/behat": "*",
         "symfony/translation": "*",
-        "prestashop/php-dev-tools": "^3.16",
-        "invertus/knapsack": "^10.0"
+        "prestashop/php-dev-tools": "^3.16"
     },
     "scripts": {
         "test-integration": "./vendor/bin/phpunit --configuration ./tests/Integration/phpunit.xml",

controllers/admin/AdminSaferPayOfficialLogsController.php

@@ -21,12 +21,18 @@
  *@license   SIX Payment Services
  */
 
+use Invertus\SaferPay\Adapter\LegacyContext;
 use Invertus\SaferPay\Config\SaferPayConfig;
+use Invertus\Saferpay\Context\GlobalShopContext;
 use Invertus\SaferPay\Controller\AbstractAdminSaferPayController;
 use Invertus\SaferPay\Enum\PermissionType;
 use Invertus\SaferPay\Logger\Formatter\LogFormatter;
+use Invertus\SaferPay\Logger\LoggerInterface;
+use Invertus\SaferPay\Repository\SaferPayLogRepository;
+use Invertus\SaferPay\Utility\ExceptionUtility;
 use Invertus\SaferPay\Utility\VersionUtility;
 use Invertus\SaferPay\Logger\Logger;
+use Invertus\SaferPay\Adapter\Tools;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -150,7 +156,8 @@ public function setMedia($isNewTheme = false)
     {
         parent::setMedia($isNewTheme);
 
-        $context = $this->module->getService(\Invertus\SaferPay\Adapter\LegacyContext::class);
+        /** @var LegacyContext $context */
+        $context = $this->module->getService(LegacyContext::class);
 
         Media::addJsDef([
             'saferpayofficial' => [
@@ -239,19 +246,19 @@ public function displayAjaxGetLog()
             return;
         }
 
-        /** @var \Invertus\SaferPay\Adapter\Tools $tools */
-        $tools = $this->module->getService(\Invertus\SaferPay\Adapter\Tools::class);
+        /** @var Tools $tools */
+        $tools = $this->module->getService(Tools::class);
 
-        /** @var \Invertus\SaferPay\Repository\SaferPayLogRepository $logRepository */
-        $logRepository = $this->module->getService(\Invertus\SaferPay\Repository\SaferPayLogRepository::class);
+        /** @var SaferPayLogRepository $logRepository */
+        $logRepository = $this->module->getService(SaferPayLogRepository::class);
 
-        /** @var \Invertus\SaferPay\Context\GlobalShopContext $shopContext */
-        $globalShopContext = $this->module->getService(\Invertus\SaferPay\Context\GlobalShopContext::class);
+        /** @var GlobalShopContext $shopContext */
+        $globalShopContext = $this->module->getService(GlobalShopContext::class);
 
         $logId = $tools->getValueAsInt('log_id');
 
-//        /** @var LoggerInterface $logger */
-//        $logger = $this->module->getService(LoggerInterface::class);
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
 
         try {
             /** @var \SaferPayLog|null $log */
@@ -260,13 +267,13 @@ public function displayAjaxGetLog()
                 'id_shop' => $globalShopContext->getShopId(),
             ]);
         } catch (Exception $exception) {
-//            $logger->error('Failed to find log', [
-//                'context' => [
-//                    'id_log' => $logId,
-//                    'id_shop' => $globalShopContext->getShopId(),
-//                ],
-//                'exceptions' => ExceptionUtility::getExceptions($exception),
-//            ]);
+            $logger->error('Failed to find log', [
+                'context' => [
+                    'id_log' => $logId,
+                    'id_shop' => $globalShopContext->getShopId(),
+                ],
+                'exceptions' => ExceptionUtility::getExceptions($exception),
+            ]);
 
             $this->ajaxResponse(json_encode([
                 'error' => true,
@@ -275,13 +282,13 @@ public function displayAjaxGetLog()
         }
 
         if (!isset($log)) {
-//            $logger->error('No log information found.', [
-//                'context' => [
-//                    'id_log' => $logId,
-//                    'id_shop' => $globalShopContext->getShopId(),
-//                ],
-//                'exceptions' => [],
-//            ]);
+            $logger->error('No log information found.', [
+                'context' => [
+                    'id_log' => $logId,
+                    'id_shop' => $globalShopContext->getShopId(),
+                ],
+                'exceptions' => [],
+            ]);
 
             $this->ajaxRender(json_encode([
                 'error' => true,
@@ -316,8 +323,8 @@ public function processExport($textDelimiter = '"')
         /** @var Configuration $configuration */
         $configuration = $this->module->getService(Configuration::class);
 
-        /** @var \Invertus\SaferPay\Adapter\LegacyContext $context */
-        $context = $this->module->getService(\Invertus\SaferPay\Adapter\LegacyContext::class);
+        /** @var LegacyContext $context */
+        $context = $this->module->getService(LegacyContext::class);
 
         $storeInfo = [
             'PrestaShop Version' => _PS_VERSION_,

controllers/admin/AdminSaferPayOfficialPaymentController.php

@@ -51,6 +51,7 @@ public function __construct()
     public function setMedia($isNewTheme = false)
     {
         parent::setMedia($isNewTheme);
+
         $this->addCSS("{$this->module->getPathUri()}views/css/admin/payment_method.css");
         $this->addJS("{$this->module->getPathUri()}views/js/admin/chosen_countries.js");
         $this->addJS("{$this->module->getPathUri()}views/js/admin/payment_method_all.js");

src/Config/SaferPayConfig.php

@@ -425,6 +425,11 @@ public static function isTestMode()
         return (bool) Configuration::get(self::TEST_MODE);
     }
 
+    public static function isDebugMode()
+    {
+        return (bool) Configuration::get(self::SAFERPAY_DEBUG_MODE);
+    }
+
     public static function isVersion17()
     {
         return (bool) version_compare(_PS_VERSION_, '1.7', '>=');

src/Context/GlobalShopContext.php

@@ -21,7 +21,7 @@
  *@license   SIX Payment Services
  */
 
-namespace Invertus\Saferpay\Context;
+namespace Invertus\SaferPay\Context;
 
 use Invertus\SaferPay\Adapter\LegacyContext;
 
@@ -32,7 +32,7 @@
  * Gets shop context data
  * NOTE: Done without interface because throwing error in the module
  */
-class GlobalShopContext
+class GlobalShopContext implements GlobalShopContextInterface
 {
     private $context;
 

src/Context/GlobalShopContextInterface.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ *NOTICE OF LICENSE
+ *
+ *This source file is subject to the Open Software License (OSL 3.0)
+ *that is bundled with this package in the file LICENSE.txt.
+ *It is also available through the world-wide-web at this URL:
+ *http://opensource.org/licenses/osl-3.0.php
+ *If you did not receive a copy of the license and are unable to
+ *obtain it through the world-wide-web, please send an email
+ *to [email protected] so we can send you a copy immediately.
+ *
+ *DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ *versions in the future. If you wish to customize PrestaShop for your
+ *needs please refer to http://www.prestashop.com for more information.
+ *
+ *@author INVERTUS UAB www.invertus.eu  <[email protected]>
+ *@copyright SIX Payment Services
+ *@license   SIX Payment Services
+ */
+
+namespace Invertus\SaferPay\Context;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+/**
+ * Gets shop context data
+ */
+interface GlobalShopContextInterface
+{
+    public function getShopId();
+
+    public function getLanguageId();
+
+    public function getLanguageIso();
+
+    public function getCurrencyIso();
+
+    public function getCurrency();
+
+    public function getShopDomain();
+
+    public function getShopName();
+
+    public function isShopSingleShopContext();
+}

src/EntityManager/EntityManagerInterface.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ *NOTICE OF LICENSE
+ *
+ *This source file is subject to the Open Software License (OSL 3.0)
+ *that is bundled with this package in the file LICENSE.txt.
+ *It is also available through the world-wide-web at this URL:
+ *http://opensource.org/licenses/osl-3.0.php
+ *If you did not receive a copy of the license and are unable to
+ *obtain it through the world-wide-web, please send an email
+ *to [email protected] so we can send you a copy immediately.
+ *
+ *DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ *versions in the future. If you wish to customize PrestaShop for your
+ *needs please refer to http://www.prestashop.com for more information.
+ *
+ *@author INVERTUS UAB www.invertus.eu  <[email protected]>
+ *@copyright SIX Payment Services
+ *@license   SIX Payment Services
+ */
+
+namespace Invertus\SaferPay\EntityManager;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+interface EntityManagerInterface
+{
+    /**
+     * @param \ObjectModel $model
+     * @param string $unitOfWorkType - @see ObjectModelUnitOfWork
+     * @param string|null $specificKey
+     *
+     * @return EntityManagerInterface
+     */
+    public function persist(
+        \ObjectModel $model,
+        $unitOfWorkType,
+        $specificKey = null
+    );
+
+    /**
+     * @return array<\ObjectModel>
+     *
+     * @throws \PrestaShopException
+     */
+    public function flush();
+}

src/EntityManager/ObjectModelEntityManager.php

@@ -0,0 +1,86 @@
+<?php
+/**
+ *NOTICE OF LICENSE
+ *
+ *This source file is subject to the Open Software License (OSL 3.0)
+ *that is bundled with this package in the file LICENSE.txt.
+ *It is also available through the world-wide-web at this URL:
+ *http://opensource.org/licenses/osl-3.0.php
+ *If you did not receive a copy of the license and are unable to
+ *obtain it through the world-wide-web, please send an email
+ *to [email protected] so we can send you a copy immediately.
+ *
+ *DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ *versions in the future. If you wish to customize PrestaShop for your
+ *needs please refer to http://www.prestashop.com for more information.
+ *
+ *@author INVERTUS UAB www.invertus.eu  <[email protected]>
+ *@copyright SIX Payment Services
+ *@license   SIX Payment Services
+ */
+
+namespace Invertus\SaferPay\EntityManager;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class ObjectModelEntityManager implements EntityManagerInterface
+{
+    private $unitOfWork;
+
+    public function __construct(ObjectModelUnitOfWork $unitOfWork)
+    {
+        $this->unitOfWork = $unitOfWork;
+    }
+
+    /**
+     * @param \ObjectModel $model
+     * @param string $unitOfWorkType
+     * @param string|null $specificKey
+     *                                 for example external_id key to make it easier to keep
+     *                                 track of which object model is related to which external_id
+     */
+    public function persist(
+        \ObjectModel $model,
+        $unitOfWorkType,
+        $specificKey = null
+    ) {
+        $this->unitOfWork->setWork($model, $unitOfWorkType, $specificKey);
+
+        return $this;
+    }
+
+    /**
+     * @return array<\ObjectModel>
+     *
+     * @throws \PrestaShopDatabaseException
+     * @throws \PrestaShopException
+     */
+    public function flush()
+    {
+        $persistenceModels = $this->unitOfWork->getWork();
+        $persistedModels = [];
+
+        foreach ($persistenceModels as $externalId => $persistenceModel) {
+            if ($persistenceModel['unit_of_work_type'] === ObjectModelUnitOfWork::UNIT_OF_WORK_SAVE) {
+                $persistenceModel['object']->save();
+            }
+
+            if ($persistenceModel['unit_of_work_type'] === ObjectModelUnitOfWork::UNIT_OF_WORK_DELETE) {
+                $persistenceModel['object']->delete();
+            }
+
+            if (!empty($externalId)) {
+                $persistedModels[$externalId] = $persistenceModel['object'];
+            } else {
+                $persistedModels[] = $persistenceModel['object'];
+            }
+        }
+        $this->unitOfWork->clearWork();
+
+        return $persistedModels;
+    }
+}