Merge pull request #4 from PAYONE-GmbH/OX7-3-Refactoring

Ox7 3 refactoring

Application/Controller/Admin/FcPayOneAdmin.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * PAYONE OXID Connector is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -30,4 +29,5 @@ class FcPayOneAdmin extends FcPayOneAdminView
      * @var string
      */
     protected $_sThisTemplate = '@fcpayone/admin/fcpayone';
+
 }

Application/Controller/Admin/FcPayOneAdminDetails.php

@@ -20,7 +20,6 @@
 
 namespace Fatchip\PayOne\Application\Controller\Admin;
 
-
 use Fatchip\PayOne\Application\Model\FcPoConfigExport;
 use Fatchip\PayOne\Application\Model\FcPoErrorMapping;
 use Fatchip\PayOne\Application\Model\FcPoForwarding;
@@ -32,77 +31,80 @@
 use OxidEsales\Eshop\Application\Controller\Admin\AdminDetailsController;
 use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
 use OxidEsales\Eshop\Core\DatabaseProvider;
+use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
+use stdClass;
 
 class FcPayOneAdminDetails extends AdminDetailsController
 {
 
     /**
      * Helper object for dealing with different shop versions
      *
-     * @var object
+     * @var FcPoHelper
      */
-    protected $_oFcPoHelper = null;
+    protected FcPoHelper $_oFcPoHelper;
 
     /**
      * Centralized Database instance
      *
-     * @var object
+     * @var DatabaseInterface
      */
     protected DatabaseInterface $_oFcPoDb;
 
     /**
      * fcpoconfigexport instance
      *
-     * @var object
+     * @var FcPoConfigExport
      */
-    protected $_oFcPoConfigExport = null;
+    protected FcPoConfigExport $_oFcPoConfigExport;
 
     /**
      * fcpopaypal instance
      *
-     * @var object
+     * @var FcPoPaypal
      */
 
-    protected $_oFcPoPayPal = null;
+    protected FcPoPaypal $_oFcPoPayPal;
 
     /**
      * fcpopaypal instance
      *
-     * @var object
+     * @var FcPoKlarna
      */
-    protected $_oFcPoKlarna = null;
+    protected FcPoKlarna $_oFcPoKlarna;
 
     /**
      * fcpomapping instance
      *
-     * @var object
+     * @var FcPoMapping
      */
-    protected $_oFcPoMapping = null;
+    protected FcPoMapping $_oFcPoMapping;
 
     /**
      * fcpoforwarding instance
      *
-     * @var object
+     * @var FcPoForwarding
      */
-    protected $_oFcPoForwarding = null;
+    protected FcPoForwarding $_oFcPoForwarding;
 
     /**
      * fcporatepay instance
      *
-     * @var null|object
+     * @var FcPoRatePay
      */
-    protected $_oFcPoRatePay = null;
+    protected FcPoRatePay $_oFcPoRatePay;
 
     /**
      * fcpoerrormapping instance
      *
-     * @var null|object
+     * @var FcPoErrorMapping
      */
-    protected $_oFcPoErrorMapping = null;
+    protected FcPoErrorMapping $_oFcPoErrorMapping;
 
 
     /**
      * Init needed data
+     * @throws DatabaseConnectionException
      */
     public function __construct()
     {
@@ -113,9 +115,9 @@ public function __construct()
         $this->_oFcPoPayPal = oxNew(FcPoPayPal::class);
         $this->_oFcPoKlarna = oxNew(FcPoKlarna::class);
         $this->_oFcPoMapping = oxNew(FcPoMapping::class);
-        $this->_oFcPoErrorMapping = oxNew(FcPoErrorMapping::class);
         $this->_oFcPoForwarding = oxNew(FcPoForwarding::class);
         $this->_oFcPoRatePay = oxNew(FcPoRatePay::class);
+        $this->_oFcPoErrorMapping = oxNew(FcPoErrorMapping::class);
     }
 
     /**
@@ -124,9 +126,29 @@ public function __construct()
      * @param string $sClassName
      * @return object
      */
-    public function fcpoGetInstance($sClassName)
+    public function fcpoGetInstance(string $sClassName): object
     {
         return oxNew($sClassName);
     }
 
+    /**
+     * Returns payone status list
+     *
+     * @return stdClass[]
+     */
+    public function getPayoneStatusList(): array
+    {
+        $aPayoneStatusList = $this->_oFcPoHelper->fcpoGetPayoneStatusList();
+
+        $aNewList = [];
+        foreach ($aPayoneStatusList as $sPayoneStatusId) {
+            $oStatus = new stdClass();
+            $oStatus->sId = $sPayoneStatusId;
+            $oStatus->sTitle = $this->_oFcPoHelper->fcpoGetLang()->translateString('fcpo_status_' . $sPayoneStatusId, null, true);
+            $aNewList[] = $oStatus;
+        }
+
+        return $aNewList;
+    }
+
 }

Application/Controller/Admin/FcPayOneAdminList.php

@@ -1,13 +1,4 @@
 <?php
-
-namespace Fatchip\PayOne\Application\Controller\Admin;
-
-
-use Fatchip\PayOne\Lib\FcPoHelper;
-use OxidEsales\Eshop\Application\Controller\Admin\AdminListController;
-use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
-use OxidEsales\Eshop\Core\DatabaseProvider;
-
 /**
  * PAYONE OXID Connector is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -26,26 +17,36 @@
  * @copyright (C) Payone GmbH
  * @version       OXID eShop CE
  */
+
+namespace Fatchip\PayOne\Application\Controller\Admin;
+
+use Fatchip\PayOne\Lib\FcPoHelper;
+use OxidEsales\Eshop\Application\Controller\Admin\AdminListController;
+use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
+use OxidEsales\Eshop\Core\DatabaseProvider;
+use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
+
 class FcPayOneAdminList extends AdminListController
 {
 
     /**
      * Helper object for dealing with different shop versions
      *
-     * @var object
+     * @var FcPoHelper
      */
-    protected $_oFcPoHelper = null;
+    protected FcPoHelper $_oFcPoHelper;
 
     /**
      * Centralized Database instance
      *
-     * @var object
+     * @var DatabaseInterface
      */
     protected DatabaseInterface $_oFcPoDb;
 
 
     /**
      * Init needed data
+     * @throws DatabaseConnectionException
      */
     public function __construct()
     {

Application/Controller/Admin/FcPayOneAdminView.php

@@ -1,12 +1,4 @@
 <?php
-
-namespace Fatchip\PayOne\Application\Controller\Admin;
-
-use Fatchip\PayOne\Lib\FcPoHelper;
-use OxidEsales\Eshop\Application\Controller\Admin\AdminController;
-use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
-use OxidEsales\Eshop\Core\DatabaseProvider;
-
 /**
  * PAYONE OXID Connector is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -25,26 +17,36 @@
  * @copyright (C) Payone GmbH
  * @version       OXID eShop CE
  */
+
+namespace Fatchip\PayOne\Application\Controller\Admin;
+
+use Fatchip\PayOne\Lib\FcPoHelper;
+use OxidEsales\Eshop\Application\Controller\Admin\AdminController;
+use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
+use OxidEsales\Eshop\Core\DatabaseProvider;
+use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
+
 class FcPayOneAdminView extends AdminController
 {
 
     /**
      * Helper object for dealing with different shop versions
      *
-     * @var object
+     * @var FcPoHelper
      */
-    protected $_oFcPoHelper = null;
+    protected FcPoHelper $_oFcPoHelper;
 
     /**
      * Centralized Database instance
      *
-     * @var object
+     * @var DatabaseInterface
      */
     protected DatabaseInterface $_oFcPoDb;
 
 
     /**
      * Init needed data
+     * @throws DatabaseConnectionException
      */
     public function __construct()
     {
@@ -53,50 +55,42 @@ public function __construct()
         $this->_oFcPoDb = DatabaseProvider::getDb();
     }
 
-
     /**
-     * Return admin template seperator sign by shop-version
+     * Return admin template separator sign by shop-version
      *
      * @return string
      */
-    public function fcGetAdminSeperator()
+    public function fcGetAdminSeparator(): string
     {
-        $iVersion = $this->_oFcPoHelper->fcpoGetIntShopVersion();
-        if ($iVersion < 4300) {
-            return '?';
-        } else {
-            return '&';
-        }
+        return '&';
     }
 
     /**
      * Returns current view identifier
      *
      * @return string
      */
-    public function getViewId()
+    public function getViewId(): string
     {
         return 'dyn_fcpayone';
     }
 
-
     /**
      * Template getter for integrator ID
      *
      * @return string
      */
-    public function fcpoGetIntegratorId()
+    public function fcpoGetIntegratorId(): string
     {
         return $this->_oFcPoHelper->fcpoGetIntegratorId();
     }
 
-
     /**
      * Template getter returns payone connector version
      *
      * @return string
      */
-    public function fcpoGetVersion()
+    public function fcpoGetVersion(): string
     {
         return $this->_oFcPoHelper->fcpoGetModuleVersion();
     }
@@ -106,7 +100,7 @@ public function fcpoGetVersion()
      *
      * @return string
      */
-    public function fcpoGetMerchantId()
+    public function fcpoGetMerchantId(): string
     {
         $oConfig = $this->_oFcPoHelper->fcpoGetConfig();
         return $oConfig->getConfigParam('sFCPOMerchantID');

Application/Controller/Admin/FcPayOneApiLog.php

@@ -1,10 +1,4 @@
 <?php
-
-namespace Fatchip\PayOne\Application\Controller\Admin;
-
-
-use Fatchip\PayOne\Application\Model\FcPoRequestLog;
-
 /**
  * PAYONE OXID Connector is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -23,6 +17,11 @@
  * @copyright (C) Payone GmbH
  * @version       OXID eShop CE
  */
+
+namespace Fatchip\PayOne\Application\Controller\Admin;
+
+use Fatchip\PayOne\Application\Model\FcPoRequestLog;
+
 class FcPayOneApiLog extends FcPayOneAdminDetails
 {
 
@@ -36,19 +35,19 @@ class FcPayOneApiLog extends FcPayOneAdminDetails
     /**
      * Array with existing status of order
      *
-     * @var array
+     * @var array|null
      */
-    protected $_aStatus = null;
+    protected ?array $_aStatus = null;
 
 
     /**
      * Loads transaction log entry with given oxid, passes
-     * it's data to Smarty engine and returns name of template file
-     * "fcpayone_apilog.tpl".
+     * its data to Twig engine and returns path to a template
+     * "fcpayone_apilog".
      *
      * @return string
      */
-    public function render()
+    public function render(): string
     {
         parent::render();