Completed
Push — master ( 2d293e...b89557 )
by Vuong
02:12
created

RequestData::ensureAttributes()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 12
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 16
ccs 12
cts 12
cp 1
rs 9.7333
c 0
b 0
f 0
cc 2
nc 2
nop 1
crap 2
1
<?php
2
/**
3
 * @link https://github.com/yiiviet/yii2-payment
4
 * @copyright Copyright (c) 2017 Yii Viet
5
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
6
 */
7
8
namespace yiiviet\payment\momo;
9
10
use yii\base\NotSupportedException;
11
use yii\behaviors\AttributeTypecastBehavior;
12
13
use vxm\gatewayclients\RequestData as BaseRequestData;
14
15
/**
16
 * Lớp RequestData cung cấp dữ liệu đã được kiểm tra tính trọn vẹn khi tạo [[request()]] ở [[PaymentGateway]].
17
 *
18
 * @method PaymentClient getClient() đối tượng client đã dùng để thực thi request.
19
 *
20
 * @property PaymentClient $client đối tượng client đã dùng để thực thi request.
21
 *
22
 * @author Vuong Minh <[email protected]>
23
 * @since 1.0.3
24
 */
25
class RequestData extends BaseRequestData
26
{
27
    /**
28
     * @inheritdoc
29
     */
30 1
    public function behaviors()
31
    {
32
        $attributeTypes = [
33 1
            'orderId' => 'string'
34
        ];
35
36 1
        if (in_array($this->command, [PaymentGateway::RC_PURCHASE, PaymentGateway::RC_QUERY_REFUND], true)) {
37 1
            $attributeTypes['amount'] = 'string';
38
        }
39
40
        return [
41 1
            'typeCast' => [
42
                'class' => AttributeTypecastBehavior::class,
43 1
                'attributeTypes' => $attributeTypes
44
            ]
45
        ];
46
    }
47
48
    /**
49
     * @inheritdoc
50
     */
51 1
    public function rules()
52
    {
53
        return [
54 1
            [['amount'], 'required', 'on' => [PaymentGateway::RC_REFUND, PaymentGateway::RC_PURCHASE]],
55
            [['returnUrl', 'notifyUrl'], 'required', 'on' => PaymentGateway::RC_PURCHASE],
56
            [['transId'], 'required', 'on' => PaymentGateway::RC_REFUND],
57
            [['partnerCode', 'accessKey', 'requestId', 'orderId', 'signature', 'requestType'], 'required', 'on' => [
58
                PaymentGateway::RC_PURCHASE, PaymentGateway::RC_QUERY_DR, PaymentGateway::RC_REFUND, PaymentGateway::RC_QUERY_REFUND
59
            ]],
60
        ];
61
    }
62
63
    /**
64
     * @inheritdoc
65
     * @throws NotSupportedException
66
     */
67 1
    protected function ensureAttributes(array &$attributes)
68
    {
69 1
        parent::ensureAttributes($attributes);
70 1
        $client = $this->getClient();
71 1
        $command = $this->getCommand();
72 1
        $attributes['partnerCode'] = $client->partnerCode;
73 1
        $attributes['accessKey'] = $client->accessKey;
74
75 1
        if ($command === PaymentGateway::RC_PURCHASE) {
76 1
            $attributes['orderInfo'] = $attributes['orderInfo'] ?? '';
77 1
            $attributes['extraData'] = $attributes['extraData'] ?? '';
78
        }
79
80 1
        $attributes['signature'] = $this->getSignature($attributes);
81 1
        $attributes['requestType'] = $this->getRequestType();
82 1
    }
83
84
    /**
85
     * Phương thức hổ trợ lấy `requestType` tương ứng với [[getCommand()]] khi gửi dữ liệu đến MOMO.
86
     *
87
     * @return string `requestType` gửi đến MOMO
88
     * @throws NotSupportedException
89
     */
90 1
    protected function getRequestType(): string
91
    {
92 1
        switch ($command = $this->getCommand()) {
93 1
            case PaymentGateway::RC_PURCHASE:
94 1
                return 'captureMoMoWallet';
95
            case PaymentGateway::RC_QUERY_DR:
96
                return 'transactionStatus';
97
            case PaymentGateway::RC_REFUND:
98
                return 'refundMoMoWallet';
99
            case PaymentGateway::RC_QUERY_REFUND:
100
                return 'refundStatus';
101
            default:
102
                throw new NotSupportedException("Not supported command: `$command`");
103
        }
104
    }
105
106
    /**
107
     * Phương thức hồ trợ ký dữ liệu gửi đến MOMO.
108
     *
109
     * @param array $attributes mảng chứa các thông tin dùng để tạo chữ ký.
110
     * @return string chữ ký dữ liệu.
111
     * @throws NotSupportedException
112
     */
113 1
    protected function getSignature(array $attributes): string
114
    {
115 1
        switch ($command = $this->getCommand()) {
116 1
            case PaymentGateway::RC_PURCHASE:
117
                $attributesSign = [
118 1
                    'partnerCode', 'accessKey', 'requestId', 'amount', 'orderId',
119
                    'orderInfo', 'returnUrl', 'notifyUrl', 'extraData',
120
                ];
121 1
                break;
122
            case PaymentGateway::RC_QUERY_DR:
123 View Code Duplication
            case PaymentGateway::RC_QUERY_REFUND:
0 ignored issues
show
Duplication introduced by
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...
124
                $attributesSign = [
125
                    'partnerCode', 'accessKey', 'requestId', 'orderId', 'requestType' => $this->getRequestType()
126
                ];
127
                break;
128 View Code Duplication
            case PaymentGateway::RC_REFUND:
0 ignored issues
show
Duplication introduced by
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...
129
                $attributesSign = [
130
                    'partnerCode', 'accessKey', 'requestId', 'amount', 'orderId', 'transId', 'requestType' => $this->getRequestType()
131
                ];
132
                break;
133
            default:
134
                throw new NotSupportedException("Not supported command: `$command`");
135
        }
136
137 1
        $dataSign = array_intersect_key($attributes, array_flip($attributesSign));
138 1
        $strSign = urldecode(http_build_query($dataSign));
139
140 1
        return $this->getClient()->signature($strSign);
141
    }
142
}
143