Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-sales-rule/Model/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\SalesRule\Model;
/**
* SalesRule Coupon Model
*
* @api
* @since 100.0.2
*/
class Coupon extends \Magento\Framework\Model\AbstractExtensibleModel implements
\Magento\SalesRule\Api\Data\CouponInterface
{
const KEY_COUPON_ID = 'coupon_id';
const KEY_RULE_ID = 'rule_id';
const KEY_CODE = 'code';
const KEY_USAGE_LIMIT = 'usage_limit';
const KEY_USAGE_PER_CUSTOMER = 'usage_per_customer';
const KEY_TIMES_USED = 'times_used';
/**
* @deprecated Coupon expiration must follow sales rule expiration date.
*/
const KEY_EXPIRATION_DATE = 'expiration_date';
const KEY_IS_PRIMARY = 'is_primary';
const KEY_CREATED_AT = 'created_at';
const KEY_TYPE = 'type';
/**
* Constructor
*
* @return void
*/
protected function _construct()
{
parent::_construct();
$this->_init(\Magento\SalesRule\Model\ResourceModel\Coupon::class);
}
/**
* Set rule instance
*
* @param Rule $rule
* @return $this
*/
public function setRule(Rule $rule)
{
$this->setRuleId($rule->getId());
return $this;
}
/**
* Load primary coupon for specified rule
*
* @param Rule|int $rule
* @return $this
*/
public function loadPrimaryByRule($rule)
{
$this->getResource()->loadPrimaryByRule($this, $rule);
return $this;
}
/**
* Load Cart Price Rule by coupon code
*
* @param string $couponCode
* @return $this
*/
public function loadByCode($couponCode)
{
$this->load($couponCode, 'code');
return $this;
}
//@codeCoverageIgnoreStart
/**
* Get coupon id
*
* @return int|null
*/
public function getCouponId()
{
return $this->getData(self::KEY_COUPON_ID);
}
/**
* Set coupon id
*
* @param int $couponId
* @return $this
*/
public function setCouponId($couponId)
{
return $this->setData(self::KEY_COUPON_ID, $couponId);
}
/**
* Get the id of the rule associated with the coupon
*
* @return int
*/
public function getRuleId()
{
return $this->getData(self::KEY_RULE_ID);
}
/**
* Set rule id
*
* @param int $ruleId
* @return $this
*/
public function setRuleId($ruleId)
{
return $this->setData(self::KEY_RULE_ID, $ruleId);
}
/**
* Get coupon code
*
* @return string|null
*/
public function getCode()
{
return $this->getData(self::KEY_CODE);
}
/**
* Set coupon code
*
* @param string $code
* @return $this
*/
public function setCode($code)
{
return $this->setData(self::KEY_CODE, $code);
}
/**
* Get usage limit
*
* @return int|null
*/
public function getUsageLimit()
{
return $this->getData(self::KEY_USAGE_LIMIT);
}
/**
* Set usage limit
*
* @param int $usageLimit
* @return $this
*/
public function setUsageLimit($usageLimit)
{
return $this->setData(self::KEY_USAGE_LIMIT, $usageLimit);
}
/**
* Get usage limit per customer
*
* @return int|null
*/
public function getUsagePerCustomer()
{
return $this->getData(self::KEY_USAGE_PER_CUSTOMER);
}
/**
* Set usage limit per customer
*
* @param int $usagePerCustomer
* @return $this
*/
public function setUsagePerCustomer($usagePerCustomer)
{
return $this->setData(self::KEY_USAGE_PER_CUSTOMER, $usagePerCustomer);
}
/**
* Get the number of times the coupon has been used
*
* @return int
*/
public function getTimesUsed()
{
return $this->getData(self::KEY_TIMES_USED);
}
/**
* Set Times Used
*
* @param int $timesUsed
* @return $this
*/
public function setTimesUsed($timesUsed)
{
return $this->setData(self::KEY_TIMES_USED, $timesUsed);
}
/**
* Get expiration date
*
* @return string|null
* @deprecated 101.1.3 Coupon expiration must follow sales rule expiration date.
*/
public function getExpirationDate()
{
return $this->getData(self::KEY_EXPIRATION_DATE);
}
/**
* Set expiration date
*
* @param string $expirationDate
* @return $this
* @deprecated 101.1.3 Coupon expiration must follow sales rule expiration date.
*/
public function setExpirationDate($expirationDate)
{
return $this->setData(self::KEY_EXPIRATION_DATE, $expirationDate);
}
/**
* Whether the coupon is primary coupon for the rule that it's associated with
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getIsPrimary()
{
return $this->getData(self::KEY_IS_PRIMARY);
}
/**
* Set whether the coupon is the primary coupon for the rule that it's associated with
*
* @param bool $isPrimary
* @return $this
*/
public function setIsPrimary($isPrimary)
{
return $this->setData(self::KEY_IS_PRIMARY, $isPrimary);
}
/**
* Date when the coupon is created
*
* @return string|null
*/
public function getCreatedAt()
{
return $this->getData(self::KEY_CREATED_AT);
}
/**
* Set the date the coupon is created
*
* @param string $createdAt
* @return $this
*/
public function setCreatedAt($createdAt)
{
return $this->setData(self::KEY_CREATED_AT, $createdAt);
}
/**
* Type of coupon
*
* @return int|null
*/
public function getType()
{
return $this->getData(self::KEY_TYPE);
}
/**
* Set type
*
* @param int $type
* @return $this
*/
public function setType($type)
{
return $this->setData(self::KEY_TYPE, $type);
}
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\SalesRule\Api\Data\CouponExtensionInterface|null
*/
public function getExtensionAttributes()
{
return $this->_getExtensionAttributes();
}
/**
* Set an extension attributes object.
*
* @param \Magento\SalesRule\Api\Data\CouponExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(
\Magento\SalesRule\Api\Data\CouponExtensionInterface $extensionAttributes
) {
return $this->_setExtensionAttributes($extensionAttributes);
}
//@codeCoverageIgnoreEnd
}