Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Rule.php
Go to the documentation of this file.
1 <?php
9 
12 
21 {
22  const KEY_RULE_ID = 'rule_id';
23  const KEY_NAME = 'name';
24  const KEY_STORE_LABELS = 'store_labels';
25  const KEY_DESCRIPTION = 'description';
26  const KEY_FROM_DATE = 'from_date';
27  const KEY_TO_DATE = 'to_date';
28  const KEY_USES_PER_CUSTOMER = 'uses_per_customer';
29  const KEY_IS_ACTIVE = 'is_active';
30  const KEY_CONDITION = 'condition';
31  const KEY_ACTION_CONDITION = 'action_condition';
32  const KEY_STOP_RULES_PROCESSING = 'stop_rules_processing';
33  const KEY_IS_ADVANCED = 'is_advanced';
34  const KEY_WEBSITES = 'website_ids';
35  const KEY_PRODUCT_IDS = 'product_ids';
36  const KEY_CUSTOMER_GROUPS = 'customer_group_ids';
37  const KEY_SORT_ORDER = 'sort_order';
38  const KEY_SIMPLE_ACTION = 'simple_action';
39  const KEY_DISCOUNT_AMOUNT = 'discount_amount';
40  const KEY_DISCOUNT_QTY = 'discount_qty';
41  const KEY_DISCOUNT_STEP = 'discount_step';
42  const KEY_APPLY_TO_SHIPPING = 'apply_to_shipping';
43  const KEY_TIMES_USED = 'times_used';
44  const KEY_IS_RSS = 'is_rss';
45  const KEY_COUPON_TYPE = 'coupon_type';
46  const KEY_USE_AUTO_GENERATION = 'use_auto_generation';
47  const KEY_USES_PER_COUPON = 'uses_per_coupon';
48  const KEY_SIMPLE_FREE_SHIPPING = 'simple_free_shipping';
49 
55  public function getRuleId()
56  {
57  return $this->_get(self::KEY_RULE_ID);
58  }
59 
66  public function setRuleId($ruleId)
67  {
68  return $this->setData(self::KEY_RULE_ID, $ruleId);
69  }
70 
76  public function getName()
77  {
78  return $this->_get(self::KEY_NAME);
79  }
80 
87  public function setName($name)
88  {
89  return $this->setData(self::KEY_NAME, $name);
90  }
91 
97  public function getDescription()
98  {
99  return $this->_get(self::KEY_DESCRIPTION);
100  }
101 
108  public function setDescription($description)
109  {
110  return $this->setData(self::KEY_DESCRIPTION, $description);
111  }
112 
118  public function getFromDate()
119  {
120  return $this->_get(self::KEY_FROM_DATE);
121  }
122 
129  public function setFromDate($fromDate)
130  {
131  return $this->setData(self::KEY_FROM_DATE, $fromDate);
132  }
133 
139  public function getToDate()
140  {
141  return $this->_get(self::KEY_TO_DATE);
142  }
143 
150  public function setToDate($toDate)
151  {
152  return $this->setData(self::KEY_TO_DATE, $toDate);
153  }
154 
160  public function getUsesPerCustomer()
161  {
162  return $this->_get(self::KEY_USES_PER_CUSTOMER);
163  }
164 
171  public function setUsesPerCustomer($usesPerCustomer)
172  {
173  return $this->setData(self::KEY_USES_PER_CUSTOMER, $usesPerCustomer);
174  }
175 
182  public function getIsActive()
183  {
184  return $this->_get(self::KEY_IS_ACTIVE);
185  }
186 
193  public function setIsActive($isActive)
194  {
195  return $this->setData(self::KEY_IS_ACTIVE, $isActive);
196  }
197 
203  public function getCondition()
204  {
205  return $this->_get(self::KEY_CONDITION);
206  }
207 
214  public function setCondition(ConditionInterface $condition = null)
215  {
216  return $this->setData(self::KEY_CONDITION, $condition);
217  }
218 
224  public function getActionCondition()
225  {
226  return $this->_get(self::KEY_ACTION_CONDITION);
227  }
228 
235  public function setActionCondition(ConditionInterface $actionCondition = null)
236  {
237  return $this->setData(self::KEY_ACTION_CONDITION, $actionCondition);
238  }
239 
246  public function getStopRulesProcessing()
247  {
248  return $this->_get(self::KEY_STOP_RULES_PROCESSING);
249  }
250 
257  public function setStopRulesProcessing($stopRulesProcessing)
258  {
259  return $this->setData(self::KEY_STOP_RULES_PROCESSING, $stopRulesProcessing);
260  }
261 
268  public function getIsAdvanced()
269  {
270  return $this->_get(self::KEY_IS_ADVANCED);
271  }
272 
277  public function setIsAdvanced($isAdvanced)
278  {
279  return $this->setData(self::KEY_IS_ADVANCED, $isAdvanced);
280  }
281 
287  public function getStoreLabels()
288  {
289  return $this->_get(self::KEY_STORE_LABELS);
290  }
291 
298  public function setStoreLabels(array $storeLabels = null)
299  {
300  return $this->setData(self::KEY_STORE_LABELS, $storeLabels);
301  }
302 
308  public function getWebsiteIds()
309  {
310  return $this->_get(self::KEY_WEBSITES);
311  }
312 
319  public function setWebsiteIds(array $websites)
320  {
321  return $this->setData(self::KEY_WEBSITES, $websites);
322  }
323 
329  public function getCustomerGroupIds()
330  {
331  return $this->_get(self::KEY_CUSTOMER_GROUPS);
332  }
333 
340  public function setCustomerGroupIds(array $customerGroups)
341  {
342  return $this->setData(self::KEY_CUSTOMER_GROUPS, $customerGroups);
343  }
344 
350  public function getProductIds()
351  {
352  return $this->_get(self::KEY_PRODUCT_IDS);
353  }
354 
361  public function setProductIds(array $productIds = null)
362  {
363  return $this->setData(self::KEY_PRODUCT_IDS, $productIds);
364  }
365 
371  public function getSortOrder()
372  {
373  return $this->_get(self::KEY_SORT_ORDER);
374  }
375 
380  public function setSortOrder($sortOrder)
381  {
382  return $this->setData(self::KEY_SORT_ORDER, $sortOrder);
383  }
384 
390  public function getSimpleAction()
391  {
392  return $this->_get(self::KEY_SIMPLE_ACTION);
393  }
394 
401  public function setSimpleAction($simpleAction)
402  {
403  return $this->setData(self::KEY_SIMPLE_ACTION, $simpleAction);
404  }
405 
411  public function getDiscountAmount()
412  {
413  return $this->_get(self::KEY_DISCOUNT_AMOUNT);
414  }
415 
422  public function setDiscountAmount($discountAmount)
423  {
424  return $this->setData(self::KEY_DISCOUNT_AMOUNT, $discountAmount);
425  }
426 
432  public function getDiscountQty()
433  {
434  return $this->_get(self::KEY_DISCOUNT_QTY);
435  }
436 
443  public function setDiscountQty($discountQty)
444  {
445  return $this->setData(self::KEY_DISCOUNT_QTY, $discountQty);
446  }
447 
453  public function getDiscountStep()
454  {
455  return $this->_get(self::KEY_DISCOUNT_STEP);
456  }
457 
464  public function setDiscountStep($discountStep)
465  {
466  return $this->setData(self::KEY_DISCOUNT_STEP, $discountStep);
467  }
468 
475  public function getApplyToShipping()
476  {
477  return $this->_get(self::KEY_APPLY_TO_SHIPPING);
478  }
479 
486  public function setApplyToShipping($applyToShipping)
487  {
488  return $this->setData(self::KEY_APPLY_TO_SHIPPING, $applyToShipping);
489  }
490 
496  public function getTimesUsed()
497  {
498  return $this->_get(self::KEY_TIMES_USED);
499  }
500 
507  public function setTimesUsed($timesUsed)
508  {
509  return $this->setData(self::KEY_TIMES_USED, $timesUsed);
510  }
511 
518  public function getIsRss()
519  {
520  return $this->_get(self::KEY_IS_RSS);
521  }
522 
529  public function setIsRss($isRss)
530  {
531  return $this->setData(self::KEY_IS_RSS, $isRss);
532  }
533 
539  public function getCouponType()
540  {
541  return $this->_get(self::KEY_COUPON_TYPE);
542  }
543 
550  public function setCouponType($couponType)
551  {
552  return $this->setData(self::KEY_COUPON_TYPE, $couponType);
553  }
554 
561  public function getUseAutoGeneration()
562  {
563  return $this->_get(self::KEY_USE_AUTO_GENERATION);
564  }
565 
572  public function setUseAutoGeneration($useAutoGeneration)
573  {
574  return $this->setData(self::KEY_USE_AUTO_GENERATION, $useAutoGeneration);
575  }
576 
582  public function getUsesPerCoupon()
583  {
584  return $this->_get(self::KEY_USES_PER_COUPON);
585  }
586 
593  public function setUsesPerCoupon($usesPerCoupon)
594  {
595  return $this->setData(self::KEY_USES_PER_COUPON, $usesPerCoupon);
596  }
597 
603  public function getSimpleFreeShipping()
604  {
605  return $this->_get(self::KEY_SIMPLE_FREE_SHIPPING);
606  }
607 
614  public function setSimpleFreeShipping($simpleFreeShipping)
615  {
616  return $this->setData(self::KEY_SIMPLE_FREE_SHIPPING, $simpleFreeShipping);
617  }
618 
624  public function getExtensionAttributes()
625  {
626  return $this->_getExtensionAttributes();
627  }
628 
635  public function setExtensionAttributes(
636  \Magento\SalesRule\Api\Data\RuleExtensionInterface $extensionAttributes
637  ) {
638  return $this->_setExtensionAttributes($extensionAttributes);
639  }
640 }
setApplyToShipping($applyToShipping)
Definition: Rule.php:486
setUsesPerCoupon($usesPerCoupon)
Definition: Rule.php:593
_setExtensionAttributes(\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
setDiscountStep($discountStep)
Definition: Rule.php:464
setCondition(ConditionInterface $condition=null)
Definition: Rule.php:214
setStopRulesProcessing($stopRulesProcessing)
Definition: Rule.php:257
setActionCondition(ConditionInterface $actionCondition=null)
Definition: Rule.php:235
setUsesPerCustomer($usesPerCustomer)
Definition: Rule.php:171
setDiscountAmount($discountAmount)
Definition: Rule.php:422
setStoreLabels(array $storeLabels=null)
Definition: Rule.php:298
setExtensionAttributes(\Magento\SalesRule\Api\Data\RuleExtensionInterface $extensionAttributes)
Definition: Rule.php:635
$extensionAttributes
Definition: payment.php:22
setSimpleFreeShipping($simpleFreeShipping)
Definition: Rule.php:614
setCustomerGroupIds(array $customerGroups)
Definition: Rule.php:340
setProductIds(array $productIds=null)
Definition: Rule.php:361
setDescription($description)
Definition: Rule.php:108
setSimpleAction($simpleAction)
Definition: Rule.php:401
setUseAutoGeneration($useAutoGeneration)
Definition: Rule.php:572
setWebsiteIds(array $websites)
Definition: Rule.php:319
setDiscountQty($discountQty)
Definition: Rule.php:443
if(!isset($_GET['name'])) $name
Definition: log.php:14