Coupons ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Coupons » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 4.0
Coupons service.
Public Properties ​
| Property | Description |
|---|---|
| allCodes | null, array |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
allCodes ​
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| deleteCouponById() | |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| generateCouponCodes() | |
| getAllCodes() | |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCouponByCode() | |
| getCouponsByDiscountId() | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| saveCoupon() | |
| saveDiscountCoupons() | |
| trigger() | Triggers an event. |
deleteCouponById() ​
Arguments ​
$id(integer)
Returns ​
Throws ​
generateCouponCodes() ​
Arguments ​
Returns ​
string[]
Throws ​
getAllCodes() ​
Returns ​
getCouponByCode() ​
Arguments ​
$code(string)
Returns ​
craft\commerce\models\Coupon, null
Throws ​
getCouponsByDiscountId() ​
Arguments ​
$discountId(integer)
Returns ​
craft\commerce\models\Coupon[]
Throws ​
saveCoupon() ​
Arguments ​
$coupon(craft\commerce\models\Coupon)$runValidation(boolean)
Returns ​
Throws ​
saveDiscountCoupons() ​
- Since
- 4.0
Arguments ​
$discount(craft\commerce\models\Discount)
Returns ​
Throws ​
Protected Methods ​
| Method | Description |
|---|---|
| clearCache() |
clearCache() ​
Returns ​
void
Constants ​
| Constant | Description |
|---|---|
CHARS_LOWER | |
CHARS_NUMBERS | |
CHARS_SPECIAL | |
CHARS_UPPER | |
COUPON_FORMAT_REPLACEMENT_CHAR | |
DEFAULT_COUPON_FORMAT |