AbstractPayment - Code Metrics - DevGroup-ru/dotplant2 - Measure and Improve Code Quality continuously with Scrutinizer

AbstractPayment A
last analyzed 2020-02-16 09:05 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	166
Duplicated Lines	25.3 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	6
dl	42
loc	166
rs	10
c	0
b	0
f	0

12 Methods

Rating	Name	Duplication	Size	Complexity
	content()	0	1	?
	checkResult()	0	1	?
A	__construct()	0	8	2
A	customCheck()	0	4	1
A	loadTransaction()	0	7	2
A	createResultUrl()	0	9	1
A	createErrorUrl()	11	11	1
A	createSuccessUrl()	10	10	1
A	createFailUrl()	11	11	1
A	createCancelUrl()	10	10	1
A	createCustomCheckUrl()	0	9	1
A	redirect()	0	4	1

How to fix Duplicated Code

<?php

namespace app\components\payment;

use app\modules\shop\models\Order;
use app\modules\shop\models\OrderTransaction;
use app\modules\shop\models\PaymentType;
use yii\base\Widget;
use yii\helpers\Url;
use yii\web\NotFoundHttpException;

abstract class AbstractPayment extends Widget
{
    /** @property Order $order*/
    public $order;
    /** @property OrderTransaction $transaction*/
    public $transaction;

    public function __construct($config = [])
    {
        parent::__construct($config);

        if (!$this->transaction instanceof OrderTransaction) {
            $this->transaction = new OrderTransaction();
        }
    }

    /**
     * @return string
     */
    abstract public function content();

    /**
     * @return mixed
     */
    abstract public function checkResult($hash = '');

    /**
     * @return string|null
     */
    public function customCheck()
    {
        return null;
    }

    /**
     * @param bool $success
     * @param integer|null $orderId
     */
//    protected function redirect($success, $orderId = null)
//    {
//        $url = ['/shop/payment/' . ($success ? 'success' : 'error')];
//        if (!is_null($orderId)) {
//            $url['id'] = $orderId;
//        }
//        \Yii::$app->response->redirect($url);
//    }

    /**
     * @param integer $id
     * @return OrderTransaction
     * @throws \yii\web\NotFoundHttpException
     */
    protected function loadTransaction($id)
    {
        if (null === $model = OrderTransaction::findOne($id)) {
            throw new NotFoundHttpException();
        }
        return $this->transaction = $model;

    }

    /**
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createResultUrl(array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/result',
            'othash' => $this->transaction->generateHash(),
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.
    }
}
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));
    }

    /**
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createErrorUrl(array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/error',
            'id' => $this->transaction->id,
            'othash' => $this->transaction->generateHash(),
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.
    }
}
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));

    }

    /**
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createSuccessUrl(array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/success',
            'id' => $this->transaction->id,
            'othash' => $this->transaction->generateHash(),
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.
    }
}
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));
    }

    /**
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createFailUrl(array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/fail',
            'id' => $this->transaction->id,
            'othash' => $this->transaction->generateHash(),
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.
    }
}
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));

    }

    /**
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createCancelUrl(array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/cancel',
            'id' => $this->transaction->id,
            'othash' => $this->transaction->generateHash(),
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.
    }
}
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));
    }

    /**
     * @param PaymentType $type
     * @param array $params
     * @param bool|true $scheme
     * @return string
     */
    protected function createCustomCheckUrl(PaymentType $type, array $params = [], $scheme = true)
    {
        $result = [
            '/shop/payment/custom-check',
            'type' => $type->id,
        ];
        $params = array_merge($result, $params);
        return Url::toRoute($params, boolval($scheme));
    }

    /**
     * @param string $url
     * @return \yii\web\Response
     */
    protected function redirect($url = '')
    {
        return \Yii::$app->response->redirect($url);
    }
}


1		<?php
2
3		namespace app\components\payment;
4
5		use app\modules\shop\models\Order;
6		use app\modules\shop\models\OrderTransaction;
7		use app\modules\shop\models\PaymentType;
8		use yii\base\Widget;
9		use yii\helpers\Url;
10		use yii\web\NotFoundHttpException;
11
12		abstract class AbstractPayment extends Widget
13		{
14		/** @property Order $order*/
15		public $order;
16		/** @property OrderTransaction $transaction*/
17		public $transaction;
18
19		public function __construct($config = [])
20		{
21		parent::__construct($config);
22
23		if (!$this->transaction instanceof OrderTransaction) {
24		$this->transaction = new OrderTransaction();
25		}
26		}
27
28		/**
29		* @return string
30		*/
31		abstract public function content();
32
33		/**
34		* @return mixed
35		*/
36		abstract public function checkResult($hash = '');
37
38		/**
39		* @return string\|null
40		*/
41		public function customCheck()
42		{
43		return null;
44		}
45
46		/**
47		* @param bool $success
48		* @param integer\|null $orderId
49		*/
50		// protected function redirect($success, $orderId = null)
51		// {
52		// $url = ['/shop/payment/' . ($success ? 'success' : 'error')];
53		// if (!is_null($orderId)) {
54		// $url['id'] = $orderId;
55		// }
56		// \Yii::$app->response->redirect($url);
57		// }
58
59		/**
60		* @param integer $id
61		* @return OrderTransaction
62		* @throws \yii\web\NotFoundHttpException
63		*/
64		protected function loadTransaction($id)
65		{
66		if (null === $model = OrderTransaction::findOne($id)) {
67		throw new NotFoundHttpException();
68		}
69		return $this->transaction = $model;
		0 ignored issues – show Bug Compatibility introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report The expression `$this->transaction = $model;` of type `yii\db\ActiveRecordInterface\|array` adds the type `array` to the return on line 69 which is incompatible with the return type documented by `app\components\payment\A...ayment::loadTransaction` of type `app\modules\shop\models\OrderTransaction`. Loading history...
70		}
71
72		/**
73		* @param array $params
74		* @param bool\|true $scheme
75		* @return string
76		*/
77		protected function createResultUrl(array $params = [], $scheme = true)
78		{
79		$result = [
80		'/shop/payment/result',
81		'othash' => $this->transaction->generateHash(),
		0 ignored issues – show Bug introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\db\ActiveRecordInterface` as the method `generateHash()` does only exist in the following implementations of said interface: `app\modules\shop\models\OrderTransaction`. 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...
82		];
83		$params = array_merge($result, $params);
84		return Url::toRoute($params, boolval($scheme));
85		}
86
87		/**
88		* @param array $params
89		* @param bool\|true $scheme
90		* @return string
91		*/
92	View Code Duplication	protected function createErrorUrl(array $params = [], $scheme = true)
93		{
94		$result = [
95		'/shop/payment/error',
96		'id' => $this->transaction->id,
97		'othash' => $this->transaction->generateHash(),
		0 ignored issues – show Bug introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\db\ActiveRecordInterface` as the method `generateHash()` does only exist in the following implementations of said interface: `app\modules\shop\models\OrderTransaction`. 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...
98		];
99		$params = array_merge($result, $params);
100		return Url::toRoute($params, boolval($scheme));
101
102		}
103
104		/**
105		* @param array $params
106		* @param bool\|true $scheme
107		* @return string
108		*/
109	View Code Duplication	protected function createSuccessUrl(array $params = [], $scheme = true)
110		{
111		$result = [
112		'/shop/payment/success',
113		'id' => $this->transaction->id,
114		'othash' => $this->transaction->generateHash(),
		0 ignored issues – show Bug introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\db\ActiveRecordInterface` as the method `generateHash()` does only exist in the following implementations of said interface: `app\modules\shop\models\OrderTransaction`. 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...
115		];
116		$params = array_merge($result, $params);
117		return Url::toRoute($params, boolval($scheme));
118		}
119
120		/**
121		* @param array $params
122		* @param bool\|true $scheme
123		* @return string
124		*/
125	View Code Duplication	protected function createFailUrl(array $params = [], $scheme = true)
126		{
127		$result = [
128		'/shop/payment/fail',
129		'id' => $this->transaction->id,
130		'othash' => $this->transaction->generateHash(),
		0 ignored issues – show Bug introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\db\ActiveRecordInterface` as the method `generateHash()` does only exist in the following implementations of said interface: `app\modules\shop\models\OrderTransaction`. 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...
131		];
132		$params = array_merge($result, $params);
133		return Url::toRoute($params, boolval($scheme));
134
135		}
136
137		/**
138		* @param array $params
139		* @param bool\|true $scheme
140		* @return string
141		*/
142	View Code Duplication	protected function createCancelUrl(array $params = [], $scheme = true)
143		{
144		$result = [
145		'/shop/payment/cancel',
146		'id' => $this->transaction->id,
147		'othash' => $this->transaction->generateHash(),
		0 ignored issues – show Bug introduced 2018-06-05 13:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\db\ActiveRecordInterface` as the method `generateHash()` does only exist in the following implementations of said interface: `app\modules\shop\models\OrderTransaction`. 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...
148		];
149		$params = array_merge($result, $params);
150		return Url::toRoute($params, boolval($scheme));
151		}
152
153		/**
154		* @param PaymentType $type
155		* @param array $params
156		* @param bool\|true $scheme
157		* @return string
158		*/
159		protected function createCustomCheckUrl(PaymentType $type, array $params = [], $scheme = true)
160		{
161		$result = [
162		'/shop/payment/custom-check',
163		'type' => $type->id,
164		];
165		$params = array_merge($result, $params);
166		return Url::toRoute($params, boolval($scheme));
167		}
168
169		/**
170		* @param string $url
171		* @return \yii\web\Response
172		*/
173		protected function redirect($url = '')
174		{
175		return \Yii::$app->response->redirect($url);
176		}
177		}
178

DevGroup-ru / dotplant2

GitHub Access Token became invalid

AbstractPayment A last analyzed 2020-02-16 09:05 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractPayment A
last analyzed 2020-02-16 09:05 UTC