PayolutionBase::__construct() - Code Metrics - fjbender/magento-2 - Measure and Improve Code Quality continuously with Scrutinizer

PayolutionBase::__construct() A
last analyzed 2017-10-23 09:52 UTC

↳ Parent: PayolutionBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
c	0
b	0
f	0
rs	9.0856
cc	1
eloc	21
nc	1
nop	18

How to fix Many Parameters

<?php

/**
 * PAYONE Magento 2 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
 *
 * PHP version 5
 *
 * @category  Payone
 * @package   Payone_Magento2_Plugin
 * @author    FATCHIP GmbH <[email protected]>
 * @copyright 2003 - 2017 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\Core\Model\Methods\Payolution;

use Payone\Core\Model\PayoneConfig;
use Magento\Sales\Model\Order;
use Magento\Payment\Model\InfoInterface;
use Magento\Framework\Exception\LocalizedException;
use Payone\Core\Model\Methods\PayoneMethod;
use Magento\Framework\DataObject;

/**
 * Base class for all Payolution methods
 */
class PayolutionBase extends PayoneMethod
{
    /* Payment method sub types */
    const METHOD_PAYOLUTION_SUBTYPE_INVOICE = 'PYV';
    const METHOD_PAYOLUTION_SUBTYPE_DEBIT = 'PYD';
    const METHOD_PAYOLUTION_SUBTYPE_INSTALLMENT = 'PYS';

    /**
     * Clearingtype for PAYONE authorization request
     *
     * @var string
     */
    protected $sClearingtype = 'fnc';

    /**
     * Payment method group identifier
     *
     * @var string
     */
    protected $sGroupName = PayoneConfig::METHOD_GROUP_PAYOLUTION;

    /**
     * Payment method long sub type
     *
     * @var string|bool
     */
    protected $sLongSubType = false;

    /**
     * Keys that need to be assigned to the additionalinformation fields
     *
     * @var array
     */
    protected $aAssignKeys = [
        'telephone',
        'b2bmode',
        'trade_registry_number',
        'dateofbirth'
    ];

    /**
     * PAYONE genericpayment pre_check request model
     *
     * @var \Payone\Core\Model\Api\Request\Genericpayment\PreCheck
     */
    protected $precheckRequest;

    /**
     * Info instructions block path
     *
     * @var string
     */
    protected $_infoBlockType = 'Payone\Core\Block\Info\ClearingReference';

    /**
     * Constructor
     *
     * @param \Magento\Framework\Model\Context                        $context
     * @param \Magento\Framework\Registry                             $registry
     * @param \Magento\Framework\Api\ExtensionAttributesFactory       $extensionFactory
     * @param \Magento\Framework\Api\AttributeValueFactory            $customAttrFactory
     * @param \Magento\Payment\Helper\Data                            $paymentData
     * @param \Magento\Framework\App\Config\ScopeConfigInterface      $scopeConfig
     * @param \Magento\Payment\Model\Method\Logger                    $logger
     * @param \Payone\Core\Helper\Toolkit                             $toolkitHelper
     * @param \Payone\Core\Helper\Shop                                $shopHelper
     * @param \Magento\Framework\Url                                  $url
     * @param \Magento\Checkout\Model\Session                         $checkoutSession
     * @param \Payone\Core\Model\Api\Request\Debit                    $debitRequest
     * @param \Payone\Core\Model\Api\Request\Capture                  $captureRequest
     * @param \Payone\Core\Model\Api\Request\Authorization            $authorizationRequest
     * @param \Payone\Core\Model\Api\Request\Genericpayment\PreCheck  $precheckRequest
     * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
     * @param \Magento\Framework\Data\Collection\AbstractDb           $resourceCollection
     * @param array                                                   $data
     */
    public function __construct(
        \Magento\Framework\Model\Context $context,
        \Magento\Framework\Registry $registry,
        \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
        \Magento\Framework\Api\AttributeValueFactory $customAttrFactory,
        \Magento\Payment\Helper\Data $paymentData,
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
        \Magento\Payment\Model\Method\Logger $logger,
        \Payone\Core\Helper\Toolkit $toolkitHelper,
        \Payone\Core\Helper\Shop $shopHelper,
        \Magento\Framework\Url $url,
        \Magento\Checkout\Model\Session $checkoutSession,
        \Payone\Core\Model\Api\Request\Debit $debitRequest,
        \Payone\Core\Model\Api\Request\Capture $captureRequest,
        \Payone\Core\Model\Api\Request\Authorization $authorizationRequest,
        \Payone\Core\Model\Api\Request\Genericpayment\PreCheck $precheckRequest,
        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
        array $data = []
    ) {
        parent::__construct($context, $registry, $extensionFactory, $customAttrFactory, $paymentData, $scopeConfig, $logger, $toolkitHelper, $shopHelper, $url, $checkoutSession, $debitRequest, $captureRequest, $authorizationRequest, $resource, $resourceCollection, $data);
        $this->precheckRequest = $precheckRequest;
    }

    /**
     * Return parameters specific to this payment type
     *
     * @param  Order $oOrder
     * @return array
     */
    public function getPaymentSpecificParameters(Order $oOrder)
    {
        $aBaseParams = [
            'financingtype' => $this->getSubType(),
            'api_version' => '3.10',
            'workorderid' => $this->getInfoInstance()->getAdditionalInformation('workorderid'),
        ];

        $sBirthday = $this->getInfoInstance()->getAdditionalInformation('dateofbirth');
        if ($sBirthday) {
            $aBaseParams['birthday'] = $sBirthday;
        }

        $blB2b = $this->getInfoInstance()->getAdditionalInformation('b2bmode');
        if ($blB2b == '1') {
            $aBaseParams['add_paydata[b2b]'] = 'yes';
            $aBaseParams['add_paydata[company_trade_registry_number]'] = $this->getInfoInstance()->getAdditionalInformation('trade_registry_number');
        }

        $aSubTypeParams = $this->getSubTypeSpecificParameters($oOrder);
        $aParams = array_merge($aBaseParams, $aSubTypeParams);
        return $aParams;
    }

    /**
     * Method to trigger the Payone genericpayment request pre-check
     *
     * @param  float       $dAmount
     * @param  string|bool $sBirthday
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     * @throws LocalizedException
     */
    public function sendPayonePreCheck($dAmount)
    {
        $oQuote = $this->checkoutSession->getQuote();
        $aResponse = $this->precheckRequest->sendRequest($this, $oQuote, $dAmount);

        if ($aResponse['status'] == 'ERROR') {// request returned an error
            throw new LocalizedException(__($aResponse['errorcode'].' - '.$aResponse['customermessage']));
        } elseif ($aResponse['status'] == 'OK') {
            $this->getInfoInstance()->setAdditionalInformation('workorderid', $aResponse['workorderid']);
        }
        return $aResponse;
    }

    /**
     * Return long subtype
     *
     * @return string
     */
    public function getLongSubType()
    {
        return $this->sLongSubType;
    }

    /**
     * Add the checkout-form-data to the checkout session
     *
     * @param  DataObject $data
     * @return $this
     */
    public function assignData(DataObject $data)
    {
        parent::assignData($data);

        $oInfoInstance = $this->getInfoInstance();
        foreach ($this->aAssignKeys as $sKey) {

            $sData = $this->toolkitHelper->getAdditionalDataEntry($data, $sKey);
            if ($sData) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $oInfoInstance->setAdditionalInformation($sKey, $sData);
            }
        }

        return $this;
    }
}


1		<?php
2
3		/**
4		* PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
5		* it under the terms of the GNU Lesser General Public License as published by
6		* the Free Software Foundation, either version 3 of the License, or
7		* (at your option) any later version.
8		*
9		* PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU Lesser General Public License for more details.
13		*
14		* You should have received a copy of the GNU Lesser General Public License
15		* along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
16		*
17		* PHP version 5
18		*
19		* @category Payone
20		* @package Payone_Magento2_Plugin
21		* @author FATCHIP GmbH <[email protected]>
22		* @copyright 2003 - 2017 Payone GmbH
23		* @license <http://www.gnu.org/licenses/> GNU Lesser General Public License
24		* @link http://www.payone.de
25		*/
26
27		namespace Payone\Core\Model\Methods\Payolution;
28
29		use Payone\Core\Model\PayoneConfig;
30		use Magento\Sales\Model\Order;
31		use Magento\Payment\Model\InfoInterface;
32		use Magento\Framework\Exception\LocalizedException;
33		use Payone\Core\Model\Methods\PayoneMethod;
34		use Magento\Framework\DataObject;
35
36		/**
37		* Base class for all Payolution methods
38		*/
39		class PayolutionBase extends PayoneMethod
40		{
41		/* Payment method sub types */
42		const METHOD_PAYOLUTION_SUBTYPE_INVOICE = 'PYV';
43		const METHOD_PAYOLUTION_SUBTYPE_DEBIT = 'PYD';
44		const METHOD_PAYOLUTION_SUBTYPE_INSTALLMENT = 'PYS';
45
46		/**
47		* Clearingtype for PAYONE authorization request
48		*
49		* @var string
50		*/
51		protected $sClearingtype = 'fnc';
52
53		/**
54		* Payment method group identifier
55		*
56		* @var string
57		*/
58		protected $sGroupName = PayoneConfig::METHOD_GROUP_PAYOLUTION;
59
60		/**
61		* Payment method long sub type
62		*
63		* @var string\|bool
64		*/
65		protected $sLongSubType = false;
66
67		/**
68		* Keys that need to be assigned to the additionalinformation fields
69		*
70		* @var array
71		*/
72		protected $aAssignKeys = [
73		'telephone',
74		'b2bmode',
75		'trade_registry_number',
76		'dateofbirth'
77		];
78
79		/**
80		* PAYONE genericpayment pre_check request model
81		*
82		* @var \Payone\Core\Model\Api\Request\Genericpayment\PreCheck
83		*/
84		protected $precheckRequest;
85
86		/**
87		* Info instructions block path
88		*
89		* @var string
90		*/
91		protected $_infoBlockType = 'Payone\Core\Block\Info\ClearingReference';
92
93		/**
94		* Constructor
95		*
96		* @param \Magento\Framework\Model\Context $context
97		* @param \Magento\Framework\Registry $registry
98		* @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
99		* @param \Magento\Framework\Api\AttributeValueFactory $customAttrFactory
100		* @param \Magento\Payment\Helper\Data $paymentData
101		* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
102		* @param \Magento\Payment\Model\Method\Logger $logger
103		* @param \Payone\Core\Helper\Toolkit $toolkitHelper
104		* @param \Payone\Core\Helper\Shop $shopHelper
105		* @param \Magento\Framework\Url $url
106		* @param \Magento\Checkout\Model\Session $checkoutSession
107		* @param \Payone\Core\Model\Api\Request\Debit $debitRequest
108		* @param \Payone\Core\Model\Api\Request\Capture $captureRequest
109		* @param \Payone\Core\Model\Api\Request\Authorization $authorizationRequest
110		* @param \Payone\Core\Model\Api\Request\Genericpayment\PreCheck $precheckRequest
111		* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
112		* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
113		* @param array $data
114		*/
115		public function __construct(
116		\Magento\Framework\Model\Context $context,
117		\Magento\Framework\Registry $registry,
118		\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
119		\Magento\Framework\Api\AttributeValueFactory $customAttrFactory,
120		\Magento\Payment\Helper\Data $paymentData,
121		\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
122		\Magento\Payment\Model\Method\Logger $logger,
123		\Payone\Core\Helper\Toolkit $toolkitHelper,
124		\Payone\Core\Helper\Shop $shopHelper,
125		\Magento\Framework\Url $url,
126		\Magento\Checkout\Model\Session $checkoutSession,
127		\Payone\Core\Model\Api\Request\Debit $debitRequest,
128		\Payone\Core\Model\Api\Request\Capture $captureRequest,
129		\Payone\Core\Model\Api\Request\Authorization $authorizationRequest,
130		\Payone\Core\Model\Api\Request\Genericpayment\PreCheck $precheckRequest,
131		\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
132		\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
133		array $data = []
134		) {
135		parent::__construct($context, $registry, $extensionFactory, $customAttrFactory, $paymentData, $scopeConfig, $logger, $toolkitHelper, $shopHelper, $url, $checkoutSession, $debitRequest, $captureRequest, $authorizationRequest, $resource, $resourceCollection, $data);
136		$this->precheckRequest = $precheckRequest;
137		}
138
139		/**
140		* Return parameters specific to this payment type
141		*
142		* @param Order $oOrder
143		* @return array
144		*/
145		public function getPaymentSpecificParameters(Order $oOrder)
146		{
147		$aBaseParams = [
148		'financingtype' => $this->getSubType(),
149		'api_version' => '3.10',
150		'workorderid' => $this->getInfoInstance()->getAdditionalInformation('workorderid'),
151		];
152
153		$sBirthday = $this->getInfoInstance()->getAdditionalInformation('dateofbirth');
154		if ($sBirthday) {
155		$aBaseParams['birthday'] = $sBirthday;
156		}
157
158		$blB2b = $this->getInfoInstance()->getAdditionalInformation('b2bmode');
159		if ($blB2b == '1') {
160		$aBaseParams['add_paydata[b2b]'] = 'yes';
161		$aBaseParams['add_paydata[company_trade_registry_number]'] = $this->getInfoInstance()->getAdditionalInformation('trade_registry_number');
162		}
163
164		$aSubTypeParams = $this->getSubTypeSpecificParameters($oOrder);
165		$aParams = array_merge($aBaseParams, $aSubTypeParams);
166		return $aParams;
167		}
168
169		/**
170		* Method to trigger the Payone genericpayment request pre-check
171		*
172		* @param float $dAmount
173		* @param string\|bool $sBirthday
		0 ignored issues – show Bug introduced 2017-08-22 11:37 UTC by Report Bug Copy Issue Report There is no parameter named `$sBirthday`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
174		* @return array
175		* @throws LocalizedException
176		*/
177		public function sendPayonePreCheck($dAmount)
178		{
179		$oQuote = $this->checkoutSession->getQuote();
180		$aResponse = $this->precheckRequest->sendRequest($this, $oQuote, $dAmount);
181
182		if ($aResponse['status'] == 'ERROR') {// request returned an error
183		throw new LocalizedException(__($aResponse['errorcode'].' - '.$aResponse['customermessage']));
184		} elseif ($aResponse['status'] == 'OK') {
185		$this->getInfoInstance()->setAdditionalInformation('workorderid', $aResponse['workorderid']);
186		}
187		return $aResponse;
188		}
189
190		/**
191		* Return long subtype
192		*
193		* @return string
194		*/
195		public function getLongSubType()
196		{
197		return $this->sLongSubType;
198		}
199
200		/**
201		* Add the checkout-form-data to the checkout session
202		*
203		* @param DataObject $data
204		* @return $this
205		*/
206		public function assignData(DataObject $data)
207		{
208		parent::assignData($data);
209
210		$oInfoInstance = $this->getInfoInstance();
211	View Code Duplication	foreach ($this->aAssignKeys as $sKey) {
		0 ignored issues – show Duplication introduced 2017-08-22 11:37 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
212		$sData = $this->toolkitHelper->getAdditionalDataEntry($data, $sKey);
213		if ($sData) {
		0 ignored issues – show Bug Best Practice introduced 2017-08-22 11:37 UTC by Report Bug Copy Issue Report The expression `$sData` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
214		$oInfoInstance->setAdditionalInformation($sKey, $sData);
215		}
216		}
217
218		return $this;
219		}
220		}
221

fjbender / magento-2

PayolutionBase::__construct() A last analyzed 2017-10-23 09:52 UTC

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like

PayolutionBase::__construct() A
last analyzed 2017-10-23 09:52 UTC