/
Rule.php
629 lines (571 loc) · 18.8 KB
/
Rule.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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\SalesRule\Model;
use Magento\Framework\Api\AttributeValueFactory;
use Magento\Framework\Api\ExtensionAttributesFactory;
use Magento\Quote\Model\Quote\Address;
/**
* Shopping Cart Rule data model
*
* @api
* @method string getName()
* @method \Magento\SalesRule\Model\Rule setName(string $value)
* @method string getDescription()
* @method \Magento\SalesRule\Model\Rule setDescription(string $value)
* @method \Magento\SalesRule\Model\Rule setFromDate(string $value)
* @method \Magento\SalesRule\Model\Rule setToDate(string $value)
* @method int getUsesPerCustomer()
* @method \Magento\SalesRule\Model\Rule setUsesPerCustomer(int $value)
* @method int getUsesPerCoupon()
* @method \Magento\SalesRule\Model\Rule setUsesPerCoupon(int $value)
* @method \Magento\SalesRule\Model\Rule setCustomerGroupIds(string $value)
* @method int getIsActive()
* @method \Magento\SalesRule\Model\Rule setIsActive(int $value)
* @method string getConditionsSerialized()
* @method \Magento\SalesRule\Model\Rule setConditionsSerialized(string $value)
* @method string getActionsSerialized()
* @method \Magento\SalesRule\Model\Rule setActionsSerialized(string $value)
* @method int getStopRulesProcessing()
* @method \Magento\SalesRule\Model\Rule setStopRulesProcessing(int $value)
* @method int getIsAdvanced()
* @method \Magento\SalesRule\Model\Rule setIsAdvanced(int $value)
* @method string getProductIds()
* @method \Magento\SalesRule\Model\Rule setProductIds(string $value)
* @method int getSortOrder()
* @method \Magento\SalesRule\Model\Rule setSortOrder(int $value)
* @method string getSimpleAction()
* @method \Magento\SalesRule\Model\Rule setSimpleAction(string $value)
* @method float getDiscountAmount()
* @method \Magento\SalesRule\Model\Rule setDiscountAmount(float $value)
* @method float getDiscountQty()
* @method \Magento\SalesRule\Model\Rule setDiscountQty(float $value)
* @method int getDiscountStep()
* @method \Magento\SalesRule\Model\Rule setDiscountStep(int $value)
* @method int getApplyToShipping()
* @method \Magento\SalesRule\Model\Rule setApplyToShipping(int $value)
* @method int getTimesUsed()
* @method \Magento\SalesRule\Model\Rule setTimesUsed(int $value)
* @method int getIsRss()
* @method \Magento\SalesRule\Model\Rule setIsRss(int $value)
* @method string getWebsiteIds()
* @method \Magento\SalesRule\Model\Rule setWebsiteIds(string $value)
* @method int getCouponType()
* @method \Magento\SalesRule\Model\Rule setCouponType(int $value)
* @method int getUseAutoGeneration()
* @method \Magento\SalesRule\Model\Rule setUseAutoGeneration(int $value)
* @method string getCouponCode()
* @method \Magento\SalesRule\Model\Rule setCouponCode(string $value)
* @method int getRuleId()
* @method \Magento\SalesRule\Model\Rule setRuleId(int $ruleId)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
class Rule extends \Magento\Rule\Model\AbstractModel
{
/**
* Coupon types
*/
const COUPON_TYPE_NO_COUPON = 1;
const COUPON_TYPE_SPECIFIC = 2;
const COUPON_TYPE_AUTO = 3;
/**
* Rule type actions
*/
const TO_PERCENT_ACTION = 'to_percent';
const BY_PERCENT_ACTION = 'by_percent';
const TO_FIXED_ACTION = 'to_fixed';
const BY_FIXED_ACTION = 'by_fixed';
const CART_FIXED_ACTION = 'cart_fixed';
const BUY_X_GET_Y_ACTION = 'buy_x_get_y';
/**
* Store coupon code generator instance
*
* @var \Magento\SalesRule\Model\Coupon\CodegeneratorInterface
*/
protected $_couponCodeGenerator;
/**
* Prefix of model events names
*
* @var string
*/
protected $_eventPrefix = 'salesrule_rule';
/**
* Parameter name in event
*
* In observe method you can use $observer->getEvent()->getRule() in this case
*
* @var string
*/
protected $_eventObject = 'rule';
/**
* Rule's primary coupon
*
* @var \Magento\SalesRule\Model\Coupon
*/
protected $_primaryCoupon;
/**
* Rule's subordinate coupons
*
* @var \Magento\SalesRule\Model\Coupon[]
*/
protected $_coupons;
/**
* Coupon types cache for lazy getter
*
* @var array
*/
protected $_couponTypes;
/**
* Store already validated addresses and validation results
*
* @var array
*/
protected $_validatedAddresses = [];
/**
* @var \Magento\SalesRule\Model\CouponFactory
*/
protected $_couponFactory;
/**
* @var \Magento\SalesRule\Model\Coupon\CodegeneratorFactory
*/
protected $_codegenFactory;
/**
* @var \Magento\SalesRule\Model\Rule\Condition\CombineFactory
*/
protected $_condCombineFactory;
/**
* @var \Magento\SalesRule\Model\Rule\Condition\Product\CombineFactory
*/
protected $_condProdCombineF;
/**
* @var \Magento\SalesRule\Model\ResourceModel\Coupon\Collection
*/
protected $_couponCollection;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* Rule constructor
*
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Data\FormFactory $formFactory
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
* @param CouponFactory $couponFactory
* @param Coupon\CodegeneratorFactory $codegenFactory
* @param Rule\Condition\CombineFactory $condCombineFactory
* @param Rule\Condition\Product\CombineFactory $condProdCombineF
* @param ResourceModel\Coupon\Collection $couponCollection
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Framework\Model\ResourceModel\AbstractResource|null $resource
* @param \Magento\Framework\Data\Collection\AbstractDb|null $resourceCollection
* @param array $data
* @param ExtensionAttributesFactory|null $extensionFactory
* @param AttributeValueFactory|null $customAttributeFactory
* @param \Magento\Framework\Serialize\Serializer\Json $serializer
*
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Data\FormFactory $formFactory,
\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
\Magento\SalesRule\Model\CouponFactory $couponFactory,
\Magento\SalesRule\Model\Coupon\CodegeneratorFactory $codegenFactory,
\Magento\SalesRule\Model\Rule\Condition\CombineFactory $condCombineFactory,
\Magento\SalesRule\Model\Rule\Condition\Product\CombineFactory $condProdCombineF,
\Magento\SalesRule\Model\ResourceModel\Coupon\Collection $couponCollection,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = [],
ExtensionAttributesFactory $extensionFactory = null,
AttributeValueFactory $customAttributeFactory = null,
\Magento\Framework\Serialize\Serializer\Json $serializer = null
) {
$this->_couponFactory = $couponFactory;
$this->_codegenFactory = $codegenFactory;
$this->_condCombineFactory = $condCombineFactory;
$this->_condProdCombineF = $condProdCombineF;
$this->_couponCollection = $couponCollection;
$this->_storeManager = $storeManager;
parent::__construct(
$context,
$registry,
$formFactory,
$localeDate,
$resource,
$resourceCollection,
$data,
$extensionFactory,
$customAttributeFactory,
$serializer
);
}
/**
* Set resource model and Id field name
*
* @return void
*/
protected function _construct()
{
parent::_construct();
$this->_init(\Magento\SalesRule\Model\ResourceModel\Rule::class);
$this->setIdFieldName('rule_id');
}
/**
* Set coupon code and uses per coupon
*
* @return $this
*/
protected function _afterLoad()
{
$this->loadRelations();
return parent::_afterLoad();
}
/**
* Load all relative data
*
* @return void
*/
public function loadRelations()
{
$this->loadCouponCode();
}
/**
* Load coupon code
*
* @return void
*/
public function loadCouponCode()
{
$this->setCouponCode($this->getPrimaryCoupon()->getCode());
if ($this->getUsesPerCoupon() == null && !$this->getUseAutoGeneration()) {
$this->setUsesPerCoupon($this->getPrimaryCoupon()->getUsageLimit());
}
}
/**
* Save/delete coupon
*
* @return $this
*/
public function afterSave()
{
$couponCode = trim($this->getCouponCode());
if (strlen(
$couponCode
) && $this->getCouponType() == self::COUPON_TYPE_SPECIFIC && !$this->getUseAutoGeneration()
) {
$this->getPrimaryCoupon()->setCode(
$couponCode
)->setUsageLimit(
$this->getUsesPerCoupon() ? $this->getUsesPerCoupon() : null
)->setUsagePerCustomer(
$this->getUsesPerCustomer() ? $this->getUsesPerCustomer() : null
)->save();
} else {
$this->getPrimaryCoupon()->delete();
}
parent::afterSave();
return $this;
}
/**
* Initialize rule model data from array.
* Set store labels if applicable.
*
* @param array $data
* @return $this
*/
public function loadPost(array $data)
{
parent::loadPost($data);
if (isset($data['store_labels'])) {
$this->setStoreLabels($data['store_labels']);
}
return $this;
}
/**
* Get rule condition combine model instance
*
* @return \Magento\SalesRule\Model\Rule\Condition\Combine
*/
public function getConditionsInstance()
{
return $this->_condCombineFactory->create();
}
/**
* Get rule condition product combine model instance
*
* @return \Magento\SalesRule\Model\Rule\Condition\Product\Combine
*/
public function getActionsInstance()
{
return $this->_condProdCombineF->create();
}
/**
* Returns code generator instance for auto generated coupons
*
* @return \Magento\SalesRule\Model\Coupon\CodegeneratorInterface
*/
public function getCouponCodeGenerator()
{
if (!$this->_couponCodeGenerator) {
return $this->_codegenFactory->create(['data' => ['length' => 16]]);
}
return $this->_couponCodeGenerator;
}
/**
* Set code generator instance for auto generated coupons
*
* @param \Magento\SalesRule\Model\Coupon\CodegeneratorInterface $codeGenerator
* @return void
*/
public function setCouponCodeGenerator(\Magento\SalesRule\Model\Coupon\CodegeneratorInterface $codeGenerator)
{
$this->_couponCodeGenerator = $codeGenerator;
}
/**
* Retrieve rule's primary coupon
*
* @return \Magento\SalesRule\Model\Coupon
*/
public function getPrimaryCoupon()
{
if ($this->_primaryCoupon === null) {
$this->_primaryCoupon = $this->_couponFactory->create();
$this->_primaryCoupon->loadPrimaryByRule($this->getId());
$this->_primaryCoupon->setRule($this)->setIsPrimary(true);
}
return $this->_primaryCoupon;
}
/**
* Get sales rule customer group Ids
*
* @return array
*/
public function getCustomerGroupIds()
{
if (!$this->hasCustomerGroupIds()) {
$customerGroupIds = $this->_getResource()->getCustomerGroupIds($this->getId());
$this->setData('customer_group_ids', (array)$customerGroupIds);
}
return $this->_getData('customer_group_ids');
}
/**
* Get Rule label by specified store
*
* @param \Magento\Store\Model\Store|int|bool|null $store
* @return string|bool
*/
public function getStoreLabel($store = null)
{
$storeId = $this->_storeManager->getStore($store)->getId();
$labels = (array)$this->getStoreLabels();
if (isset($labels[$storeId])) {
return $labels[$storeId];
} elseif (isset($labels[0]) && $labels[0]) {
return $labels[0];
}
return false;
}
/**
* Set if not yet and retrieve rule store labels
*
* @return array
*/
public function getStoreLabels()
{
if (!$this->hasStoreLabels()) {
$labels = $this->_getResource()->getStoreLabels($this->getId());
$this->setStoreLabels($labels);
}
return $this->_getData('store_labels');
}
/**
* Retrieve subordinate coupons
*
* @return \Magento\SalesRule\Model\Coupon[]
*/
public function getCoupons()
{
if ($this->_coupons === null) {
$this->_couponCollection->addRuleToFilter($this);
$this->_coupons = $this->_couponCollection->getItems();
}
return $this->_coupons;
}
/**
* Retrieve coupon types
*
* @return array
*/
public function getCouponTypes()
{
if ($this->_couponTypes === null) {
$this->_couponTypes = [
\Magento\SalesRule\Model\Rule::COUPON_TYPE_NO_COUPON => __('No Coupon'),
\Magento\SalesRule\Model\Rule::COUPON_TYPE_SPECIFIC => __('Specific Coupon'),
];
$transport = new \Magento\Framework\DataObject(
['coupon_types' => $this->_couponTypes, 'is_coupon_type_auto_visible' => false]
);
$this->_eventManager->dispatch('salesrule_rule_get_coupon_types', ['transport' => $transport]);
$this->_couponTypes = $transport->getCouponTypes();
if ($transport->getIsCouponTypeAutoVisible()) {
$this->_couponTypes[\Magento\SalesRule\Model\Rule::COUPON_TYPE_AUTO] = __('Auto');
}
}
return $this->_couponTypes;
}
/**
* Acquire coupon instance
*
* @param bool $saveNewlyCreated Whether or not to save newly created coupon
* @param int $saveAttemptCount Number of attempts to save newly created coupon
* @return \Magento\SalesRule\Model\Coupon|null
* @throws \Exception|\Magento\Framework\Exception\LocalizedException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function acquireCoupon($saveNewlyCreated = true, $saveAttemptCount = 10)
{
if ($this->getCouponType() == self::COUPON_TYPE_NO_COUPON) {
return null;
}
if ($this->getCouponType() == self::COUPON_TYPE_SPECIFIC) {
return $this->getPrimaryCoupon();
}
/** @var \Magento\SalesRule\Model\Coupon $coupon */
$coupon = $this->_couponFactory->create();
$coupon->setRule(
$this
)->setIsPrimary(
false
)->setUsageLimit(
$this->getUsesPerCoupon() ? $this->getUsesPerCoupon() : null
)->setUsagePerCustomer(
$this->getUsesPerCustomer() ? $this->getUsesPerCustomer() : null
)->setType(
\Magento\SalesRule\Api\Data\CouponInterface::TYPE_GENERATED
);
$couponCode = self::getCouponCodeGenerator()->generateCode();
$coupon->setCode($couponCode);
$ok = false;
if (!$saveNewlyCreated) {
$ok = true;
} else {
if ($this->getId()) {
for ($attemptNum = 0; $attemptNum < $saveAttemptCount; $attemptNum++) {
try {
$coupon->save();
} catch (\Exception $e) {
if ($e instanceof \Magento\Framework\Exception\LocalizedException || $coupon->getId()) {
throw $e;
}
$coupon->setCode(
$couponCode . self::getCouponCodeGenerator()->getDelimiter() . sprintf(
'%04u',
random_int(0, 9999)
)
);
continue;
}
$ok = true;
break;
}
}
}
if (!$ok) {
throw new \Magento\Framework\Exception\LocalizedException(__('Can\'t acquire coupon.'));
}
return $coupon;
}
/**
* @return string
* @since 100.1.0
*/
public function getFromDate()
{
return $this->getData('from_date');
}
/**
* @return string
* @since 100.1.0
*/
public function getToDate()
{
return $this->getData('to_date');
}
/**
* Check cached validation result for specific address
*
* @param Address $address
* @return bool
*/
public function hasIsValidForAddress($address)
{
$addressId = $this->_getAddressId($address);
return isset($this->_validatedAddresses[$addressId]) ? true : false;
}
/**
* Set validation result for specific address to results cache
*
* @param Address $address
* @param bool $validationResult
* @return $this
*/
public function setIsValidForAddress($address, $validationResult)
{
$addressId = $this->_getAddressId($address);
$this->_validatedAddresses[$addressId] = $validationResult;
return $this;
}
/**
* Get cached validation result for specific address
*
* @param Address $address
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getIsValidForAddress($address)
{
$addressId = $this->_getAddressId($address);
return isset($this->_validatedAddresses[$addressId]) ? $this->_validatedAddresses[$addressId] : false;
}
/**
* Return id for address
*
* @param Address $address
* @return string
*/
private function _getAddressId($address)
{
if ($address instanceof Address) {
return $address->getId();
}
return $address;
}
/**
* @param string $formName
* @return string
* @since 100.1.0
*/
public function getConditionsFieldSetId($formName = '')
{
return $formName . 'rule_conditions_fieldset_' . $this->getId();
}
/**
* @param string $formName
* @return string
* @since 100.1.0
*/
public function getActionsFieldSetId($formName = '')
{
return $formName . 'rule_actions_fieldset_' . $this->getId();
}
}