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

TransactionStatus::addTransactionLogEntry() A
last analyzed 2017-10-23 09:52 UTC

↳ Parent: TransactionStatus

Complexity

Conditions	3
Paths	4

Size

Total Lines	70
Code Lines	64

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	70
rs	9.1724
c	0
b	0
f	0
cc	3
eloc	64
nc	4
nop	2

How to fix Long Method

<?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 - 2016 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\Core\Model\ResourceModel;

use Payone\Core\Helper\Toolkit;
use Magento\Framework\App\Action\Context;
use Magento\Sales\Model\Order;

/**
 * TransactionStatus resource model
 */
class TransactionStatus extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
{
    /**
     * Context object
     *
     * @var \Magento\Framework\App\Action\Context
     */
    protected $oContext = null;

    /**
     * Store manager object
     *
     * @var \Magento\Store\Model\StoreManagerInterface
     */
    protected $storeManager;

    /**
     * Toolkit helper object
     *
     * @var Toolkit
     */
    protected $toolkitHelper;

    /**
     * Constructor
     *
     * @param \Magento\Framework\Model\ResourceModel\Db\Context $context
     * @param \Magento\Store\Model\StoreManagerInterface        $storeManager
     * @param \Payone\Core\Helper\Toolkit                       $toolkitHelper
     * @param string                                            $connectionName
     */
    public function __construct(
        \Magento\Framework\Model\ResourceModel\Db\Context $context,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Payone\Core\Helper\Toolkit $toolkitHelper,
        $connectionName = null
    ) {
        parent::__construct($context, $connectionName);
        $this->storeManager = $storeManager;
        $this->toolkitHelper = $toolkitHelper;
    }

    /**
     * Initialize connection and table
     *
     * @return void
     */
    protected function _construct()
    {
        $this->_init('payone_protocol_transactionstatus', 'id');
    }

    /**
     * Get request-parameter value or a given default if not set
     *
     * @param  string $sKey
     * @param  string $sDefault
     * @return string
     */
    public function getParam($sKey, $sDefault = '')
    {
        if ($this->oContext) {
            $sParam = $this->oContext->getRequest()->getParam($sKey, $sDefault);
            if (!$this->toolkitHelper->isUTF8($sParam)) {
                $sParam = utf8_encode($sParam);
            }
            return $sParam;
        }
        return $sDefault;
    }

    /**
     * Write TransactionStatus entry to database
     *
     * @param  Context $oContext
     * @param  Order   $oOrder
     * @return $this
     */
    public function addTransactionLogEntry(Context $oContext, Order $oOrder = null)
    {
        $this->oContext = $oContext;
        $aRequest = $oContext->getRequest()->getPostValue();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $sRawStatus = serialize($aRequest);
        if (!$this->toolkitHelper->isUTF8($sRawStatus)) {
            $sRawStatus = utf8_encode($sRawStatus); // needed for serializing the array
        }
        $sOrderId = $oOrder !== null ? $oOrder->getIncrementId() : '';
        $this->getConnection()->insert(
            $this->getMainTable(),
            [
                'order_id' => $sOrderId,
                'store_id' => $this->storeManager->getStore()->getId(),
                'reference' => $this->getParam('reference'),
                'txid' => $this->getParam('txid'),
                'txaction' => $this->getParam('txaction'),
                'sequencenumber' => $this->getParam('sequencenumber'),
                'clearingtype' => $this->getParam('clearingtype'),
                'txtime' => date('Y-m-d H:i:s', $this->getParam('txtime')),
                'price' => $this->getParam('price'),
                'balance' => $this->getParam('balance'),
                'receivable' => $this->getParam('receivable'),
                'currency' => $this->getParam('currency'),
                'aid' => $this->getParam('aid'),
                'portalid' => $this->getParam('portalid'),
                'key' => $this->getParam('key'),
                'mode' => $this->getParam('mode'),
                'userid' => $this->getParam('userid'),
                'customerid' => $this->getParam('customerid'),
                'company' => $this->getParam('company'),
                'firstname' => $this->getParam('firstname'),
                'lastname' => $this->getParam('lastname'),
                'street' => $this->getParam('street'),
                'zip' => $this->getParam('zip'),
                'city' => $this->getParam('city'),
                'email' => $this->getParam('email'),
                'country' => $this->getParam('country'),
                'shipping_company' => $this->getParam('shipping_company'),
                'shipping_firstname' => $this->getParam('shipping_firstname'),
                'shipping_lastname' => $this->getParam('shipping_lastname'),
                'shipping_street' => $this->getParam('shipping_street'),
                'shipping_zip' => $this->getParam('shipping_zip'),
                'shipping_city' => $this->getParam('shipping_city'),
                'shipping_country' => $this->getParam('shipping_country'),
                'param' => $this->getParam('param'),
                'accessname' => $this->getParam('accessname'),
                'accesscode' => $this->getParam('accesscode'),
                'bankcountry' => $this->getParam('bankcountry'),
                'bankaccount' => $this->getParam('bankaccount'),
                'bankcode' => $this->getParam('bankcode'),
                'bankaccountholder' => $this->getParam('bankaccountholder'),
                'cardexpiredate' => $this->getParam('cardexpiredate'),
                'cardtype' => $this->getParam('cardtype'),
                'cardpan' => $this->getParam('cardpan'),
                'clearing_bankaccountholder' => $this->getParam('clearing_bankaccountholder'),
                'clearing_bankaccount' => $this->getParam('clearing_bankaccount'),
                'clearing_bankcode' => $this->getParam('clearing_bankcode'),
                'clearing_bankname' => $this->getParam('clearing_bankname'),
                'clearing_bankbic' => $this->getParam('clearing_bankbic'),
                'clearing_bankiban' => $this->getParam('clearing_bankiban'),
                'clearing_legalnote' => $this->getParam('clearing_legalnote'),
                'clearing_duedate' => $this->getParam('clearing_duedate'),
                'clearing_reference' => $this->getParam('clearing_reference'),
                'clearing_instructionnote' => $this->getParam('clearing_instructionnote'),
                'raw_status' => $sRawStatus,
            ]
        );
        return $this;
    }

    /**
     * Get TransactionStatus id be txid
     *
     * @param  string $sTxid
     * @return string
     */
    public function getAppointedIdByTxid($sTxid)
    {
        $oConn = $this->getConnection();

        $oSelect = $oConn->select()->from($this->getMainTable())
            ->where('txid = :txid')
            ->where('txaction = :txaction');

        return $oConn->fetchOne($oSelect, ['txid' => $sTxid, 'txaction' => 'appointed']);
    }
}


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 - 2016 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\ResourceModel;
28
29			use Payone\Core\Helper\Toolkit;
30			use Magento\Framework\App\Action\Context;
31			use Magento\Sales\Model\Order;
32
33			/**
34			* TransactionStatus resource model
35			*/
36			class TransactionStatus extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
37			{
38			/**
39			* Context object
40			*
41			* @var \Magento\Framework\App\Action\Context
42			*/
43			protected $oContext = null;
44
45			/**
46			* Store manager object
47			*
48			* @var \Magento\Store\Model\StoreManagerInterface
49			*/
50			protected $storeManager;
51
52			/**
53			* Toolkit helper object
54			*
55			* @var Toolkit
56			*/
57			protected $toolkitHelper;
58
59			/**
60			* Constructor
61			*
62			* @param \Magento\Framework\Model\ResourceModel\Db\Context $context
63			* @param \Magento\Store\Model\StoreManagerInterface $storeManager
64			* @param \Payone\Core\Helper\Toolkit $toolkitHelper
65			* @param string $connectionName
66			*/
67			public function __construct(
68			\Magento\Framework\Model\ResourceModel\Db\Context $context,
69			\Magento\Store\Model\StoreManagerInterface $storeManager,
70			\Payone\Core\Helper\Toolkit $toolkitHelper,
71			$connectionName = null
72			) {
73			parent::__construct($context, $connectionName);
74			$this->storeManager = $storeManager;
75			$this->toolkitHelper = $toolkitHelper;
76			}
77
78			/**
79			* Initialize connection and table
80			*
81			* @return void
82			*/
83			protected function _construct()
84			{
85			$this->_init('payone_protocol_transactionstatus', 'id');
86			}
87
88			/**
89			* Get request-parameter value or a given default if not set
90			*
91			* @param string $sKey
92			* @param string $sDefault
93			* @return string
94			*/
95			public function getParam($sKey, $sDefault = '')
96			{
97			if ($this->oContext) {
98			$sParam = $this->oContext->getRequest()->getParam($sKey, $sDefault);
99			if (!$this->toolkitHelper->isUTF8($sParam)) {
100			$sParam = utf8_encode($sParam);
101			}
102			return $sParam;
103			}
104			return $sDefault;
105			}
106
107			/**
108			* Write TransactionStatus entry to database
109			*
110			* @param Context $oContext
111			* @param Order $oOrder
112			* @return $this
113			*/
114			public function addTransactionLogEntry(Context $oContext, Order $oOrder = null)
115			{
116			$this->oContext = $oContext;
117			$aRequest = $oContext->getRequest()->getPostValue();
			0 ignored issues – show Bug introduced 2016-11-09 11:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Magento\Framework\App\RequestInterface` as the method `getPostValue()` does only exist in the following implementations of said interface: `Magento\Framework\App\Request\Http`, `Magento\Framework\Webapi\Request`, `Magento\Framework\Webapi\Rest\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
118			$sRawStatus = serialize($aRequest);
119			if (!$this->toolkitHelper->isUTF8($sRawStatus)) {
120			$sRawStatus = utf8_encode($sRawStatus); // needed for serializing the array
121			}
122			$sOrderId = $oOrder !== null ? $oOrder->getIncrementId() : '';
123			$this->getConnection()->insert(
124			$this->getMainTable(),
125			[
126			'order_id' => $sOrderId,
127			'store_id' => $this->storeManager->getStore()->getId(),
128			'reference' => $this->getParam('reference'),
129			'txid' => $this->getParam('txid'),
130			'txaction' => $this->getParam('txaction'),
131			'sequencenumber' => $this->getParam('sequencenumber'),
132			'clearingtype' => $this->getParam('clearingtype'),
133			'txtime' => date('Y-m-d H:i:s', $this->getParam('txtime')),
134			'price' => $this->getParam('price'),
135			'balance' => $this->getParam('balance'),
136			'receivable' => $this->getParam('receivable'),
137			'currency' => $this->getParam('currency'),
138			'aid' => $this->getParam('aid'),
139			'portalid' => $this->getParam('portalid'),
140			'key' => $this->getParam('key'),
141			'mode' => $this->getParam('mode'),
142			'userid' => $this->getParam('userid'),
143			'customerid' => $this->getParam('customerid'),
144			'company' => $this->getParam('company'),
145			'firstname' => $this->getParam('firstname'),
146			'lastname' => $this->getParam('lastname'),
147			'street' => $this->getParam('street'),
148			'zip' => $this->getParam('zip'),
149			'city' => $this->getParam('city'),
150			'email' => $this->getParam('email'),
151			'country' => $this->getParam('country'),
152			'shipping_company' => $this->getParam('shipping_company'),
153			'shipping_firstname' => $this->getParam('shipping_firstname'),
154			'shipping_lastname' => $this->getParam('shipping_lastname'),
155			'shipping_street' => $this->getParam('shipping_street'),
156			'shipping_zip' => $this->getParam('shipping_zip'),
157			'shipping_city' => $this->getParam('shipping_city'),
158			'shipping_country' => $this->getParam('shipping_country'),
159			'param' => $this->getParam('param'),
160			'accessname' => $this->getParam('accessname'),
161			'accesscode' => $this->getParam('accesscode'),
162			'bankcountry' => $this->getParam('bankcountry'),
163			'bankaccount' => $this->getParam('bankaccount'),
164			'bankcode' => $this->getParam('bankcode'),
165			'bankaccountholder' => $this->getParam('bankaccountholder'),
166			'cardexpiredate' => $this->getParam('cardexpiredate'),
167			'cardtype' => $this->getParam('cardtype'),
168			'cardpan' => $this->getParam('cardpan'),
169			'clearing_bankaccountholder' => $this->getParam('clearing_bankaccountholder'),
170			'clearing_bankaccount' => $this->getParam('clearing_bankaccount'),
171			'clearing_bankcode' => $this->getParam('clearing_bankcode'),
172			'clearing_bankname' => $this->getParam('clearing_bankname'),
173			'clearing_bankbic' => $this->getParam('clearing_bankbic'),
174			'clearing_bankiban' => $this->getParam('clearing_bankiban'),
175			'clearing_legalnote' => $this->getParam('clearing_legalnote'),
176			'clearing_duedate' => $this->getParam('clearing_duedate'),
177			'clearing_reference' => $this->getParam('clearing_reference'),
178			'clearing_instructionnote' => $this->getParam('clearing_instructionnote'),
179			'raw_status' => $sRawStatus,
180			]
181			);
182			return $this;
183			}
184
185			/**
186			* Get TransactionStatus id be txid
187			*
188			* @param string $sTxid
189			* @return string
190			*/
191			public function getAppointedIdByTxid($sTxid)
192			{
193			$oConn = $this->getConnection();
194
195			$oSelect = $oConn->select()->from($this->getMainTable())
196			->where('txid = :txid')
197			->where('txaction = :txaction');
198
199			return $oConn->fetchOne($oSelect, ['txid' => $sTxid, 'txaction' => 'appointed']);
200			}
201			}
202

fjbender / magento-2

TransactionStatus::addTransactionLogEntry() A last analyzed 2017-10-23 09:52 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like

TransactionStatus::addTransactionLogEntry() A
last analyzed 2017-10-23 09:52 UTC