-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
Payment.php
389 lines (354 loc) · 11.2 KB
/
Payment.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Quote\Model\Quote;
use Magento\Quote\Api\Data\PaymentInterface;
/**
* Quote payment information
*
* @api
* @method int getQuoteId()
* @method \Magento\Quote\Model\Quote\Payment setQuoteId(int $value)
* @method string getCreatedAt()
* @method \Magento\Quote\Model\Quote\Payment setCreatedAt(string $value)
* @method string getUpdatedAt()
* @method \Magento\Quote\Model\Quote\Payment setUpdatedAt(string $value)
* @method string getCcNumberEnc()
* @method \Magento\Quote\Model\Quote\Payment setCcNumberEnc(string $value)
* @method string getCcLast4()
* @method \Magento\Quote\Model\Quote\Payment setCcLast4(string $value)
* @method string getCcCidEnc()
* @method \Magento\Quote\Model\Quote\Payment setCcCidEnc(string $value)
* @method string getCcSsOwner()
* @method \Magento\Quote\Model\Quote\Payment setCcSsOwner(string $value)
* @method int getCcSsStartMonth()
* @method \Magento\Quote\Model\Quote\Payment setCcSsStartMonth(int $value)
* @method int getCcSsStartYear()
* @method \Magento\Quote\Model\Quote\Payment setCcSsStartYear(int $value)
* @method string getCcSsIssue()
* @method \Magento\Quote\Model\Quote\Payment setCcSsIssue(string $value)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
class Payment extends \Magento\Payment\Model\Info implements PaymentInterface
{
/**
* @var string
*/
protected $_eventPrefix = 'sales_quote_payment';
/**
* @var string
*/
protected $_eventObject = 'payment';
/**
* Quote model object
*
* @var \Magento\Quote\Model\Quote
*/
protected $_quote;
/**
* @var \Magento\Payment\Model\Checks\SpecificationFactory
*/
protected $methodSpecificationFactory;
/**
* @var array
*/
private $additionalChecks;
/**
* @var \Magento\Framework\Serialize\Serializer\Json
*/
private $serializer;
/**
* @var \Magento\Framework\Serialize\JsonValidator
*/
private $jsonValidator;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
* @param \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory
* @param \Magento\Payment\Helper\Data $paymentData
* @param \Magento\Framework\Encryption\EncryptorInterface $encryptor
* @param \Magento\Payment\Model\Checks\SpecificationFactory $methodSpecificationFactory
* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
* @param array $data
* @param array $additionalChecks
* @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
* @param \Magento\Framework\Serialize\JsonValidator|null $jsonValidator
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
\Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
\Magento\Payment\Helper\Data $paymentData,
\Magento\Framework\Encryption\EncryptorInterface $encryptor,
\Magento\Payment\Model\Checks\SpecificationFactory $methodSpecificationFactory,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = [],
array $additionalChecks = [],
\Magento\Framework\Serialize\Serializer\Json $serializer = null,
\Magento\Framework\Serialize\JsonValidator $jsonValidator = null
) {
$this->methodSpecificationFactory = $methodSpecificationFactory;
$this->additionalChecks = $additionalChecks;
$this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Serialize\Serializer\Json::class);
$this->jsonValidator = $jsonValidator ?: \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Serialize\JsonValidator::class);
parent::__construct(
$context,
$registry,
$extensionFactory,
$customAttributeFactory,
$paymentData,
$encryptor,
$resource,
$resourceCollection,
$data
);
}
/**
* Initialize resource model
*
* @return void
*/
protected function _construct()
{
$this->_init(\Magento\Quote\Model\ResourceModel\Quote\Payment::class);
}
/**
* Declare quote model instance
*
* @param \Magento\Quote\Model\Quote $quote
* @return $this
*/
public function setQuote(\Magento\Quote\Model\Quote $quote)
{
$this->_quote = $quote;
$this->setQuoteId($quote->getId());
return $this;
}
/**
* Retrieve quote model instance
*
* @codeCoverageIgnore
*
* @return \Magento\Quote\Model\Quote
*/
public function getQuote()
{
return $this->_quote;
}
/**
* Import data array to payment method object,
* Method calls quote totals collect because payment method availability
* can be related to quote totals
*
* @param array $data
* @return $this
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function importData(array $data)
{
$data = $this->convertPaymentData($data);
$data = new \Magento\Framework\DataObject($data);
$this->_eventManager->dispatch(
$this->_eventPrefix . '_import_data_before',
[$this->_eventObject => $this, 'input' => $data]
);
$this->setMethod($data->getMethod());
$method = $this->getMethodInstance();
$quote = $this->getQuote();
/**
* Payment availability related with quote totals.
* We have to recollect quote totals before checking
*/
$quote->collectTotals();
$checks = array_merge($data->getChecks(), $this->additionalChecks);
$methodSpecification = $this->methodSpecificationFactory->create($checks);
if (!$method->isAvailable($quote) || !$methodSpecification->isApplicable($method, $quote)) {
throw new \Magento\Framework\Exception\LocalizedException(
__('The requested Payment Method is not available.')
);
}
$method->assignData($data);
/*
* validating the payment data
*/
$method->validate();
return $this;
}
/**
* Converts request to payment data
*
* @param array $rawData
* @return array
*/
private function convertPaymentData(array $rawData)
{
$paymentData = [
PaymentInterface::KEY_METHOD => null,
PaymentInterface::KEY_PO_NUMBER => null,
PaymentInterface::KEY_ADDITIONAL_DATA => [],
'checks' => []
];
foreach (array_keys($rawData) as $requestKey) {
if (!array_key_exists($requestKey, $paymentData)) {
$paymentData[PaymentInterface::KEY_ADDITIONAL_DATA][$requestKey] = $rawData[$requestKey];
} elseif ($requestKey === PaymentInterface::KEY_ADDITIONAL_DATA) {
$paymentData[PaymentInterface::KEY_ADDITIONAL_DATA] = array_merge(
$paymentData[PaymentInterface::KEY_ADDITIONAL_DATA],
(array) $rawData[$requestKey]
);
} else {
$paymentData[$requestKey] = $rawData[$requestKey];
}
}
return $paymentData;
}
/**
* Prepare object for save
*
* @return $this
*/
public function beforeSave()
{
if ($this->getQuote()) {
$this->setQuoteId($this->getQuote()->getId());
}
return parent::beforeSave();
}
/**
* Checkout redirect URL getter
*
* @return string
*/
public function getCheckoutRedirectUrl()
{
$method = $this->getMethodInstance();
if ($method) {
return $method->getCheckoutRedirectUrl();
}
return '';
}
/**
* Checkout order place redirect URL getter
*
* @return string
*/
public function getOrderPlaceRedirectUrl()
{
$method = $this->getMethodInstance();
if ($method) {
return $method->getConfigData('order_place_redirect_url');
}
return '';
}
/**
* Retrieve payment method model object
*
* @return \Magento\Payment\Model\MethodInterface
*/
public function getMethodInstance()
{
$method = parent::getMethodInstance();
$method->setStore($this->getQuote()->getStoreId());
return $method;
}
/**
* @codeCoverageIgnoreStart
*/
/**
* Get purchase order number
*
* @return string|null
*/
public function getPoNumber()
{
return $this->getData(self::KEY_PO_NUMBER);
}
/**
* Set purchase order number
*
* @param string $poNumber
* @return $this
*/
public function setPoNumber($poNumber)
{
return $this->setData(self::KEY_PO_NUMBER, $poNumber);
}
/**
* Get payment method code
*
* @return string
*/
public function getMethod()
{
return $this->getData(self::KEY_METHOD);
}
/**
* Set payment method code
*
* @param string $method
* @return $this
*/
public function setMethod($method)
{
return $this->setData(self::KEY_METHOD, $method);
}
/**
* Get payment additional details
*
* @return string[]|null
*/
public function getAdditionalData()
{
$additionalDataValue = $this->getData(self::KEY_ADDITIONAL_DATA);
if (is_array($additionalDataValue)) {
return $additionalDataValue;
}
if (is_string($additionalDataValue) && $this->jsonValidator->isValid($additionalDataValue)) {
$additionalData = $this->serializer->unserialize($additionalDataValue);
if (is_array($additionalData)) {
return $additionalData;
}
}
return null;
}
/**
* Set payment additional details
*
* @param string $additionalData
* @return $this
*/
public function setAdditionalData($additionalData)
{
return $this->setData(self::KEY_ADDITIONAL_DATA, $additionalData);
}
//@codeCoverageIgnoreEnd
/**
* {@inheritdoc}
*
* @return \Magento\Quote\Api\Data\PaymentExtensionInterface|null
*/
public function getExtensionAttributes()
{
return $this->_getExtensionAttributes();
}
/**
* {@inheritdoc}
*
* @param \Magento\Quote\Api\Data\PaymentExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(\Magento\Quote\Api\Data\PaymentExtensionInterface $extensionAttributes)
{
return $this->_setExtensionAttributes($extensionAttributes);
}
}