PurchaseRequestCollection::requestMerchants() - Code Metrics - Inspection of "Merge branch 'new_yii2_merchant'" - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8d56c2...eec4fb )

by Dmitry

created 2017-11-22 13:09 UTC

PurchaseRequestCollection::requestMerchants() A

↳ Parent: PurchaseRequestCollection

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\merchant;

use hipanel\modules\finance\models\Merchant;
use hiqdev\hiart\ResponseErrorException;
use hiqdev\php\merchant\response\RedirectPurchaseResponse;
use hiqdev\yii2\merchant\models\DepositRequest;
use hiqdev\yii2\merchant\models\PurchaseRequest;
use Yii;

class PurchaseRequestCollection extends \hiqdev\yii2\merchant\Collection
{
    public function init()
    {
        parent::init();

        if ($this->depositRequest === null) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->depositRequest = $this->createDefaultDepositRequest();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $this->loadMerchants($this->depositRequest);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function loadMerchants($depositRequest)
    {
        $this->addItems($this->fetchMerchants($depositRequest));
    }

    public static $supportedSystems = [
        'webmoney' => 1,
        'paypal' => 1,
        'yandex' => 1,
        'interkassa' => 1,
        'paxum' => 1,
        'ecoin' => 1,
        'okpay' => 1,
        'robokassa' => 1,
        'freekassa' => 1,
        'bitpay' => 1,
        'epayservice' => 1,
    ];

    public function fetchMerchants(DepositRequest $depositRequest)
    {
        $params = [
            'transactionId' => $depositRequest->id,
            'sum' => floatval($depositRequest->amount),
            'site' => Yii::$app->request->getHostInfo(),
        ];

        if (Yii::$app->user->getIsGuest()) {
            $params['seller'] = Yii::$app->params['user.seller'];
        } elseif (isset($depositRequest->username)) {
            $params['username'] = $depositRequest->username;
        }

        if (isset($depositRequest->merchant)) {
            // When the Request contains concrete merchant name,
            // parameters `finishUrl`, `cancelUrl`, `notifyUrl` contain

            // correct URLs, adjusted by [[hiqdev\yii2-merchant\Module::prepareRequestData()]]

            // and they must be used as success, failure and confirm URLs
            $params['success_url'] = $depositRequest->returnUrl;
            $params['failure_url'] = $depositRequest->cancelUrl;
            $params['confirm_url'] = $depositRequest->notifyUrl;
        }

        try {
            $merchants = $this->requestMerchants($params);
        } catch (ResponseErrorException $e) {
            if ($e->getResponse()->getData() === null) {
                Yii::info('No available payment methods found', 'hipanel:finance');
                $merchants = [];
            } else {
                throw $e;
            }
        }

        $result = [];
        foreach (array_keys(static::$supportedSystems) as $system) {
            foreach ($merchants as $name => $merchant) {
                if ($merchant['system'] === $system) {
                    $result[$name] = $this->convertMerchant($merchant);
                }
            }
        }

        return $result;
    }

    public function requestMerchants($params)
    {
        $userId = Yii::$app->user->getIsGuest() ? null : Yii::$app->user->identity->getId();

        return Yii::$app->getCache()->getOrSet([__METHOD__, $params, $userId], function () use ($params) {
            return Merchant::perform('prepare-info', $params, ['batch' => true]);
        }, 3600*1);
    }

    public function convertMerchant($data)
    {
        $request = new PurchaseRequest();

        $request->merchant_name = $data['name'];
        $request->system = $data['system'];
        $request->currency = strtoupper($data['currency']);
        $request->label = $data['label'];
        $request->fee = $data['fee'];
        $request->commission_fee = $data['commission_fee'];
        $request->id = $data['invoice_id'];
        $request->amount = $data['sum'];
        $request->form = (new RedirectPurchaseResponse($data['action'], $data['inputs']))->setMethod($data['method']);
        $request->disableReason = $data['disable_reason'] ?? null;

        return $request;
    }

    protected function createDefaultDepositRequest()
    {
        $request = new DepositRequest();
        $request->amount = 10;

        return $request;
    }
}


1			<?php
2			/**
3			* Finance module for HiPanel
4			*
5			* @link https://github.com/hiqdev/hipanel-module-finance
6			* @package hipanel-module-finance
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\modules\finance\merchant;
12
13			use hipanel\modules\finance\models\Merchant;
14			use hiqdev\hiart\ResponseErrorException;
15			use hiqdev\php\merchant\response\RedirectPurchaseResponse;
16			use hiqdev\yii2\merchant\models\DepositRequest;
17			use hiqdev\yii2\merchant\models\PurchaseRequest;
18			use Yii;
19
20			class PurchaseRequestCollection extends \hiqdev\yii2\merchant\Collection
21			{
22			public function init()
23			{
24			parent::init();
25
26			if ($this->depositRequest === null) {
			0 ignored issues – show Documentation introduced 2017-11-22 13:27 UTC by Report Bug Copy Issue Report The property `depositRequest` does not exist on `object<hipanel\modules\f...chaseRequestCollection>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
27			$this->depositRequest = $this->createDefaultDepositRequest();
			0 ignored issues – show Documentation introduced 2017-11-22 13:27 UTC by Report Bug Copy Issue Report The property `depositRequest` does not exist on `object<hipanel\modules\f...chaseRequestCollection>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
28			}
29
30			$this->loadMerchants($this->depositRequest);
			0 ignored issues – show Documentation introduced 2017-11-22 13:27 UTC by Report Bug Copy Issue Report The property `depositRequest` does not exist on `object<hipanel\modules\f...chaseRequestCollection>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
31			}
32
33			public function loadMerchants($depositRequest)
34			{
35			$this->addItems($this->fetchMerchants($depositRequest));
36			}
37
38			public static $supportedSystems = [
39			'webmoney' => 1,
40			'paypal' => 1,
41			'yandex' => 1,
42			'interkassa' => 1,
43			'paxum' => 1,
44			'ecoin' => 1,
45			'okpay' => 1,
46			'robokassa' => 1,
47			'freekassa' => 1,
48			'bitpay' => 1,
49			'epayservice' => 1,
50			];
51
52			public function fetchMerchants(DepositRequest $depositRequest)
53			{
54			$params = [
55			'transactionId' => $depositRequest->id,
56			'sum' => floatval($depositRequest->amount),
57			'site' => Yii::$app->request->getHostInfo(),
58			];
59
60			if (Yii::$app->user->getIsGuest()) {
61			$params['seller'] = Yii::$app->params['user.seller'];
62			} elseif (isset($depositRequest->username)) {
63			$params['username'] = $depositRequest->username;
64			}
65
66			if (isset($depositRequest->merchant)) {
67			// When the Request contains concrete merchant name,
68			// parameters `finishUrl`, `cancelUrl`, `notifyUrl` contain
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-26 12:59 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
69			// correct URLs, adjusted by [[hiqdev\yii2-merchant\Module::prepareRequestData()]]
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-26 12:59 UTC by Report Bug Copy Issue Report `39%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
70			// and they must be used as success, failure and confirm URLs
71			$params['success_url'] = $depositRequest->returnUrl;
72			$params['failure_url'] = $depositRequest->cancelUrl;
73			$params['confirm_url'] = $depositRequest->notifyUrl;
74			}
75
76			try {
77			$merchants = $this->requestMerchants($params);
78			} catch (ResponseErrorException $e) {
79			if ($e->getResponse()->getData() === null) {
80			Yii::info('No available payment methods found', 'hipanel:finance');
81			$merchants = [];
82			} else {
83			throw $e;
84			}
85			}
86
87			$result = [];
88			foreach (array_keys(static::$supportedSystems) as $system) {
89			foreach ($merchants as $name => $merchant) {
90			if ($merchant['system'] === $system) {
91			$result[$name] = $this->convertMerchant($merchant);
92			}
93			}
94			}
95
96			return $result;
97			}
98
99			public function requestMerchants($params)
100			{
101			$userId = Yii::$app->user->getIsGuest() ? null : Yii::$app->user->identity->getId();
102
103			return Yii::$app->getCache()->getOrSet([__METHOD__, $params, $userId], function () use ($params) {
104			return Merchant::perform('prepare-info', $params, ['batch' => true]);
105			}, 3600*1);
106			}
107
108			public function convertMerchant($data)
109			{
110			$request = new PurchaseRequest();
111
112			$request->merchant_name = $data['name'];
113			$request->system = $data['system'];
114			$request->currency = strtoupper($data['currency']);
115			$request->label = $data['label'];
116			$request->fee = $data['fee'];
117			$request->commission_fee = $data['commission_fee'];
118			$request->id = $data['invoice_id'];
119			$request->amount = $data['sum'];
120			$request->form = (new RedirectPurchaseResponse($data['action'], $data['inputs']))->setMethod($data['method']);
121			$request->disableReason = $data['disable_reason'] ?? null;
122
123			return $request;
124			}
125
126			protected function createDefaultDepositRequest()
127			{
128			$request = new DepositRequest();
129			$request->amount = 10;
130
131			return $request;
132			}
133			}
134

hiqdev / hipanel-module-finance

Push — master ( 8d56c2...eec4fb )

PurchaseRequestCollection::requestMerchants() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like