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

Api::addPayoneOrderData() A
last analyzed 2017-10-23 09:52 UTC

↳ Parent: Api

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	3

<?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\Helper;

use Payone\Core\Model\Methods\PayoneMethod;
use Magento\Sales\Model\Order as SalesOrder;

/**
 * Helper class for everything that has to do with APIs
 *
 * @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
 */
class Api extends Base
{
    /**
     * PAYONE connection curl php
     *
     * @var \Payone\Core\Helper\Connection\CurlPhp
     */
    protected $connCurlPhp;

    /**
     * PAYONE connection curl cli
     *
     * @var \Payone\Core\Helper\Connection\CurlCli
     */
    protected $connCurlCli;

    /**
     * PAYONE connection fsockopen
     *
     * @var \Payone\Core\Helper\Connection\Fsockopen
     */
    protected $connFsockopen;

    /**
     * Fields to copy from the request array to the order
     *
     * @var array
     */
    protected $requestToOrder = [
        'reference' => 'payone_refnr',
        'request' => 'payone_authmode',
        'mode' => 'payone_mode',
        'mandate_identification' => 'payone_mandate_id',
        'workorderid' => 'payone_workorder_id',
        'add_paydata[installment_duration]' => 'payone_installment_duration',
    ];

    /**
     * Fields to copy from the response to the order
     *
     * @var array
     */
    protected $responseToOrder = [
        'txid' => 'payone_txid',
        'mandate_identification' => 'payone_mandate_id',
        'clearing_reference' => 'payone_clearing_reference',
        'add_paydata[clearing_reference]' => 'payone_clearing_reference',
        'add_paydata[workorderid]' => 'payone_workorder_id',
        'clearing_bankaccount' => 'payone_clearing_bankaccount',
        'clearing_bankcode' => 'payone_clearing_bankcode',
        'clearing_bankcountry' => 'payone_clearing_bankcountry',
        'clearing_bankname' => 'payone_clearing_bankname',
        'clearing_bankaccountholder' => 'payone_clearing_bankaccountholder',
        'clearing_bankcity' => 'payone_clearing_bankcity',
        'clearing_bankiban' => 'payone_clearing_bankiban',
        'clearing_bankbic' => 'payone_clearing_bankbic'
    ];

    /**
     * Constructor
     *
     * @param \Magento\Framework\App\Helper\Context      $context
     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
     * @param \Payone\Core\Helper\Shop                   $shopHelper
     * @param \Payone\Core\Helper\Connection\CurlPhp     $connCurlPhp
     * @param \Payone\Core\Helper\Connection\CurlCli     $connCurlCli
     * @param \Payone\Core\Helper\Connection\Fsockopen   $connFsockopen
     */
    public function __construct(
        \Magento\Framework\App\Helper\Context $context,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Payone\Core\Helper\Shop $shopHelper,
        \Payone\Core\Helper\Connection\CurlPhp $connCurlPhp,
        \Payone\Core\Helper\Connection\CurlCli $connCurlCli,
        \Payone\Core\Helper\Connection\Fsockopen $connFsockopen
    ) {
        parent::__construct($context, $storeManager, $shopHelper);
        $this->connCurlPhp = $connCurlPhp;
        $this->connCurlCli = $connCurlCli;
        $this->connFsockopen = $connFsockopen;
    }

    /**
     * Check which communication possibilities are existing and send the request
     *
     * @param  string $sRequestUrl
     * @return array
     */
    public function sendApiRequest($sRequestUrl)
    {
        $aParsedRequestUrl = parse_url($sRequestUrl);
        if ($aParsedRequestUrl === false) {
            return ["errormessage" => "Payone API request URL could not be parsed."];
        }

        if ($this->connCurlPhp->isApplicable()) {
            // php native curl exists so we gonna use it for requesting
            $aResponse = $this->connCurlPhp->sendCurlPhpRequest($aParsedRequestUrl);
        } elseif ($this->connCurlCli->isApplicable()) {
            // cli version of curl exists on server
            $aResponse = $this->connCurlCli->sendCurlCliRequest($aParsedRequestUrl);
        } else {
            // last resort => via sockets
            $aResponse = $this->connFsockopen->sendSocketRequest($aParsedRequestUrl);
        }

        $aResponse = $this->formatOutputByResponse($aResponse);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $aResponse;
    }

    /**
     * Format response to a clean output array
     *
     * @param  array $aResponse
     * @return array
     */
    protected function formatOutputByResponse($aResponse)
    {
        $aOutput = [];

        if (is_array($aResponse)) { // correct response existing?
            foreach ($aResponse as $iLinenum => $sLine) { // go through line by line
                $iPos = strpos($sLine, "=");
                if ($iPos > 0) { // is a "=" as delimiter existing?
                    $aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos + 1));
                } elseif (!empty($sLine)) { // is line not empty?
                    $aOutput[$iLinenum] = $sLine; // add the line unedited
                }
            }
        }

        return $aOutput;
    }

    /**
     * Generate the request url out of the params and die api url
     *
     * @param  array  $aParameters
     * @param  string $sApiUrl
     * @return string
     */
    public function getRequestUrl($aParameters, $sApiUrl)
    {
        $sRequestUrl = '';
        foreach ($aParameters as $sKey => $mValue) {
            if (is_array($mValue)) { // might be array
                foreach ($mValue as $i => $sSubValue) {
                    $sRequestUrl .= "&".$sKey."[".$i."]=".urlencode($sSubValue);
                }
            } else {
                $sRequestUrl .= "&".$sKey."=".urlencode($mValue);
            }
        }
        $sRequestUrl = $sApiUrl."?".substr($sRequestUrl, 1);
        return $sRequestUrl;
    }

    /**
     * Copy Data to order by given map
     *
     * @param SalesOrder $oOrder
     * @param array $aData
     * @param array $aMap
     * @return SalesOrder
     */
    protected function addDataToOrder(SalesOrder $oOrder, $aData, $aMap)
    {
        foreach ($aMap as $sFrom => $sTo) {
            if (isset($aData[$sFrom])) {
                $oOrder->setData($sTo, $aData[$sFrom]);
            }
        }
        return $oOrder;
    }

    /**
     * Add PAYONE information to the order object to be saved in the DB
     *
     * @param  SalesOrder $oOrder
     * @param  array      $aRequest
     * @param  array      $aResponse
     * @return void
     */
    public function addPayoneOrderData(SalesOrder $oOrder, $aRequest, $aResponse)
    {
        $this->addDataToOrder($oOrder, $aRequest, $this->requestToOrder);
        $this->addDataToOrder($oOrder, $aResponse, $this->responseToOrder);
    }

    /**
     * Check if invoice-data has to be added to the authorization request
     *
     * @param  PayoneMethod $oPayment
     * @return bool
     */
    public function isInvoiceDataNeeded(PayoneMethod $oPayment)
    {
        $blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing'); // invoicing enabled?
        if ($blInvoiceEnabled || $oPayment->needsProductInfo()) {
            return true; // invoice data needed
        }
        return false; // invoice data not needed
    }
}


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\Helper;
28
29			use Payone\Core\Model\Methods\PayoneMethod;
30			use Magento\Sales\Model\Order as SalesOrder;
31
32			/**
33			* Helper class for everything that has to do with APIs
34			*
35			* @category Payone
36			* @package Payone_Magento2_Plugin
37			* @author FATCHIP GmbH <[email protected]>
38			* @copyright 2003 - 2016 Payone GmbH
39			* @license <http://www.gnu.org/licenses/> GNU Lesser General Public License
40			* @link http://www.payone.de
41			*/
42			class Api extends Base
43			{
44			/**
45			* PAYONE connection curl php
46			*
47			* @var \Payone\Core\Helper\Connection\CurlPhp
48			*/
49			protected $connCurlPhp;
50
51			/**
52			* PAYONE connection curl cli
53			*
54			* @var \Payone\Core\Helper\Connection\CurlCli
55			*/
56			protected $connCurlCli;
57
58			/**
59			* PAYONE connection fsockopen
60			*
61			* @var \Payone\Core\Helper\Connection\Fsockopen
62			*/
63			protected $connFsockopen;
64
65			/**
66			* Fields to copy from the request array to the order
67			*
68			* @var array
69			*/
70			protected $requestToOrder = [
71			'reference' => 'payone_refnr',
72			'request' => 'payone_authmode',
73			'mode' => 'payone_mode',
74			'mandate_identification' => 'payone_mandate_id',
75			'workorderid' => 'payone_workorder_id',
76			'add_paydata[installment_duration]' => 'payone_installment_duration',
77			];
78
79			/**
80			* Fields to copy from the response to the order
81			*
82			* @var array
83			*/
84			protected $responseToOrder = [
85			'txid' => 'payone_txid',
86			'mandate_identification' => 'payone_mandate_id',
87			'clearing_reference' => 'payone_clearing_reference',
88			'add_paydata[clearing_reference]' => 'payone_clearing_reference',
89			'add_paydata[workorderid]' => 'payone_workorder_id',
90			'clearing_bankaccount' => 'payone_clearing_bankaccount',
91			'clearing_bankcode' => 'payone_clearing_bankcode',
92			'clearing_bankcountry' => 'payone_clearing_bankcountry',
93			'clearing_bankname' => 'payone_clearing_bankname',
94			'clearing_bankaccountholder' => 'payone_clearing_bankaccountholder',
95			'clearing_bankcity' => 'payone_clearing_bankcity',
96			'clearing_bankiban' => 'payone_clearing_bankiban',
97			'clearing_bankbic' => 'payone_clearing_bankbic'
98			];
99
100			/**
101			* Constructor
102			*
103			* @param \Magento\Framework\App\Helper\Context $context
104			* @param \Magento\Store\Model\StoreManagerInterface $storeManager
105			* @param \Payone\Core\Helper\Shop $shopHelper
106			* @param \Payone\Core\Helper\Connection\CurlPhp $connCurlPhp
107			* @param \Payone\Core\Helper\Connection\CurlCli $connCurlCli
108			* @param \Payone\Core\Helper\Connection\Fsockopen $connFsockopen
109			*/
110			public function __construct(
111			\Magento\Framework\App\Helper\Context $context,
112			\Magento\Store\Model\StoreManagerInterface $storeManager,
113			\Payone\Core\Helper\Shop $shopHelper,
114			\Payone\Core\Helper\Connection\CurlPhp $connCurlPhp,
115			\Payone\Core\Helper\Connection\CurlCli $connCurlCli,
116			\Payone\Core\Helper\Connection\Fsockopen $connFsockopen
117			) {
118			parent::__construct($context, $storeManager, $shopHelper);
119			$this->connCurlPhp = $connCurlPhp;
120			$this->connCurlCli = $connCurlCli;
121			$this->connFsockopen = $connFsockopen;
122			}
123
124			/**
125			* Check which communication possibilities are existing and send the request
126			*
127			* @param string $sRequestUrl
128			* @return array
129			*/
130			public function sendApiRequest($sRequestUrl)
131			{
132			$aParsedRequestUrl = parse_url($sRequestUrl);
133			if ($aParsedRequestUrl === false) {
134			return ["errormessage" => "Payone API request URL could not be parsed."];
135			}
136
137			if ($this->connCurlPhp->isApplicable()) {
138			// php native curl exists so we gonna use it for requesting
139			$aResponse = $this->connCurlPhp->sendCurlPhpRequest($aParsedRequestUrl);
140			} elseif ($this->connCurlCli->isApplicable()) {
141			// cli version of curl exists on server
142			$aResponse = $this->connCurlCli->sendCurlCliRequest($aParsedRequestUrl);
143			} else {
144			// last resort => via sockets
145			$aResponse = $this->connFsockopen->sendSocketRequest($aParsedRequestUrl);
146			}
147
148			$aResponse = $this->formatOutputByResponse($aResponse);
			0 ignored issues – show Bug introduced 2016-11-09 11:08 UTC by Report Bug Copy Issue Report It seems like `$aResponse` can also be of type `null`; however, `Payone\Core\Helper\Api::formatOutputByResponse()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
149
150			return $aResponse;
151			}
152
153			/**
154			* Format response to a clean output array
155			*
156			* @param array $aResponse
157			* @return array
158			*/
159			protected function formatOutputByResponse($aResponse)
160			{
161			$aOutput = [];
162
163			if (is_array($aResponse)) { // correct response existing?
164			foreach ($aResponse as $iLinenum => $sLine) { // go through line by line
165			$iPos = strpos($sLine, "=");
166			if ($iPos > 0) { // is a "=" as delimiter existing?
167			$aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos + 1));
168			} elseif (!empty($sLine)) { // is line not empty?
169			$aOutput[$iLinenum] = $sLine; // add the line unedited
170			}
171			}
172			}
173
174			return $aOutput;
175			}
176
177			/**
178			* Generate the request url out of the params and die api url
179			*
180			* @param array $aParameters
181			* @param string $sApiUrl
182			* @return string
183			*/
184			public function getRequestUrl($aParameters, $sApiUrl)
185			{
186			$sRequestUrl = '';
187			foreach ($aParameters as $sKey => $mValue) {
188			if (is_array($mValue)) { // might be array
189			foreach ($mValue as $i => $sSubValue) {
190			$sRequestUrl .= "&".$sKey."[".$i."]=".urlencode($sSubValue);
191			}
192			} else {
193			$sRequestUrl .= "&".$sKey."=".urlencode($mValue);
194			}
195			}
196			$sRequestUrl = $sApiUrl."?".substr($sRequestUrl, 1);
197			return $sRequestUrl;
198			}
199
200			/**
201			* Copy Data to order by given map
202			*
203			* @param SalesOrder $oOrder
204			* @param array $aData
205			* @param array $aMap
206			* @return SalesOrder
207			*/
208			protected function addDataToOrder(SalesOrder $oOrder, $aData, $aMap)
209			{
210			foreach ($aMap as $sFrom => $sTo) {
211			if (isset($aData[$sFrom])) {
212			$oOrder->setData($sTo, $aData[$sFrom]);
213			}
214			}
215			return $oOrder;
216			}
217
218			/**
219			* Add PAYONE information to the order object to be saved in the DB
220			*
221			* @param SalesOrder $oOrder
222			* @param array $aRequest
223			* @param array $aResponse
224			* @return void
225			*/
226			public function addPayoneOrderData(SalesOrder $oOrder, $aRequest, $aResponse)
227			{
228			$this->addDataToOrder($oOrder, $aRequest, $this->requestToOrder);
229			$this->addDataToOrder($oOrder, $aResponse, $this->responseToOrder);
230			}
231
232			/**
233			* Check if invoice-data has to be added to the authorization request
234			*
235			* @param PayoneMethod $oPayment
236			* @return bool
237			*/
238			public function isInvoiceDataNeeded(PayoneMethod $oPayment)
239			{
240			$blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing'); // invoicing enabled?
241			if ($blInvoiceEnabled \|\| $oPayment->needsProductInfo()) {
242			return true; // invoice data needed
243			}
244			return false; // invoice data not needed
245			}
246			}
247

fjbender / magento-2

Api::addPayoneOrderData() A last analyzed 2017-10-23 09:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Api::addPayoneOrderData() A
last analyzed 2017-10-23 09:52 UTC