Bitrix API

DiscountCouponTable extends DataManager

Class DiscountCouponTable

Fields:

ID int mandatory
DISCOUNT_ID int mandatory
ACTIVE bool optional default 'Y'
ACTIVE_FROM datetime optional
ACTIVE_TO datetime optional
COUPON string(32) mandatory
TYPE int mandatory
MAX_USE int mandatory
USE_COUNT int mandatory
USER_ID int mandatory
DATE_APPLY datetime optional
TIMESTAMP_X datetime optional
MODIFIED_BY int optional
DATE_CREATE datetime optional
CREATED_BY int optional
DESCRIPTION text optional
CREATED_BY_USER reference to [](\Bitrix\Main\UserTable)
MODIFIED_BY_USER reference to [](\Bitrix\Main\UserTable)
DISCOUNT reference to [](\Bitrix\Sale\Internals\DiscountTable)

Constants

EVENT_ON_AFTER_DELETE_DISCOUNT = 'onAfterDeleteDiscountCoupons'
EVENT_ON_GENERATE_COUPON = 'onGenerateCoupon'
TYPE_ARCHIVED = 0x8
TYPE_BASKET_ROW = 0x1
TYPE_MULTI_ORDER = 0x4
TYPE_ONE_ORDER = 0x2
TYPE_UNKNOWN = 0x0

Methods

addPacket() : Result: Create one and more coupons for discount.
checkCoupon() : bool|string: Check coupon - unique and exist.
checkDiscountId() : bool|string: Check discount id.
checkPacket() : Result: Check data for create one or more coupons.
checkType() : bool|string: Check coupon type.
clearDiscountCheckList() : void: Clear discount list for update use coupons flag.
createCollection() : EO_DiscountCoupon_Collection
createObject() : EO_DiscountCoupon
deleteByDiscount() : void: Delete all coupons for discount.
disableCheckCouponsUse() : void: Disable checking use coupons for discount before multiuse add/update/delete.
enableCheckCouponsUse() : void: Enable checking use coupons for discount after multiuse add/update/delete.
generateCoupon() : string: Create coupon code.
getById() : EO_DiscountCoupon_Result
getByPrimary() : EO_DiscountCoupon_Result
getCouponTypes() : array<string|int, mixed>: Returns coupon types list.
getEntity() : EO_DiscountCoupon_Entity
getList() : EO_DiscountCoupon_Result
getMap() : array<string|int, mixed>: Returns entity map definition.
getTableName() : string: Returns DB table name for entity.
isCheckedCouponsUse() : bool: Returns current checking use coupons mode.
isValidCouponType() : bool: Check valid coupon type.
onAfterAdd() : void: Default onAfterAdd handler. Absolutely necessary.
onAfterDelete() : void: Default onAfterDelete handler. Absolutely necessary.
onAfterUpdate() : void: Default onAfterUpdate handler. Absolutely necessary.
onBeforeAdd() : EventResult: Default onBeforeAdd handler. Absolutely necessary.
onBeforeUpdate() : EventResult: Default onBeforeUpdate handler. Absolutely necessary.
onDelete() : void: Default onDelete handler. Absolutely necessary.
onUpdate() : void: Default onUpdate handler. Absolutely necessary.
prepareCouponData() : Result: Prepare coupon data. Only for admin list pages.
query() : EO_DiscountCoupon_Query
saveApplied() : array<string|int, mixed>|bool: Save coupons applyed info.
setDiscountCheckList() : void: Fill discount list for update use coupons flag.
updateUseCoupons() : void: Update use coupon flag for discount list.
validateCoupon() : array<string|int, mixed>: Returns validators for COUPON field.
validateDiscountId() : array<string|int, mixed>: Returns validators for DISCOUNT_ID field.
validateType() : array<string|int, mixed>: Returns validators for TYPE field.
wakeUpCollection() : EO_DiscountCoupon_Collection
wakeUpObject() : EO_DiscountCoupon

EVENT_ON_AFTER_DELETE_DISCOUNT


    public
        mixed
    EVENT_ON_AFTER_DELETE_DISCOUNT
    = 'onAfterDeleteDiscountCoupons'

EVENT_ON_GENERATE_COUPON


    public
        mixed
    EVENT_ON_GENERATE_COUPON
    = 'onGenerateCoupon'

TYPE_ARCHIVED


    public
        mixed
    TYPE_ARCHIVED
    = 0x8

TYPE_BASKET_ROW


    public
        mixed
    TYPE_BASKET_ROW
    = 0x1

TYPE_MULTI_ORDER


    public
        mixed
    TYPE_MULTI_ORDER
    = 0x4

TYPE_ONE_ORDER


    public
        mixed
    TYPE_ONE_ORDER
    = 0x2

TYPE_UNKNOWN


    public
        mixed
    TYPE_UNKNOWN
    = 0x0

addPacket()

Create one and more coupons for discount.


    public
            static        addPacket(array<string|int, mixed> $data, int $count[, int $limit = 0 ]) : Result

Parameters

$data : array<string|int, mixed>: Coupon data.
$count : int: Coupos count.
$limit : int = 0: Maximum number of attempts.

Return values

Result

checkCoupon()

Check coupon - unique and exist.


    public
            static        checkCoupon(int $value, array<string|int, mixed>|int $primary, array<string|int, mixed> $row, Field $field) : bool|string

Parameters

$value : int: Coupon.
$primary : array<string|int, mixed>|int: Primary key.
$row : array<string|int, mixed>: Current data.
$field : Field: Field object.

Return values

bool|string

checkDiscountId()

Check discount id.


    public
            static        checkDiscountId(int $value, array<string|int, mixed>|int $primary, array<string|int, mixed> $row, Field $field) : bool|string

Parameters

$value : int: Discount id.
$primary : array<string|int, mixed>|int: Primary key.
$row : array<string|int, mixed>: Current data.
$field : Field: Field object.

Return values

bool|string

checkPacket()

Check data for create one or more coupons.


    public
            static        checkPacket(array<string|int, mixed> $data[, bool $newDiscount = false ]) : Result

Parameters

$data : array<string|int, mixed>: Coupon data.
$newDiscount : bool = false: New discount flag.

Return values

Result

checkType()

Check coupon type.


    public
            static        checkType(int $value, array<string|int, mixed>|int $primary, array<string|int, mixed> $row, Field $field) : bool|string

Parameters

$value : int: Coupon type.
$primary : array<string|int, mixed>|int: Primary key.
$row : array<string|int, mixed>: Current data.
$field : Field: Field object.

Return values

bool|string

clearDiscountCheckList()

Clear discount list for update use coupons flag.


    public
            static        clearDiscountCheckList() : void

createCollection()


    public
            static        createCollection() : EO_DiscountCoupon_Collection

Return values

EO_DiscountCoupon_Collection

createObject()


    public
            static        createObject([mixed $setDefaultValues =  = 'true' ]) : EO_DiscountCoupon

Parameters

$setDefaultValues : mixed = = 'true'

Return values

EO_DiscountCoupon

deleteByDiscount()

Delete all coupons for discount.


    public
            static        deleteByDiscount(int $discount) : void

Parameters

$discount : int: Discount id.

disableCheckCouponsUse()

Disable checking use coupons for discount before multiuse add/update/delete.


    public
            static        disableCheckCouponsUse() : void

enableCheckCouponsUse()

Enable checking use coupons for discount after multiuse add/update/delete.


    public
            static        enableCheckCouponsUse() : void

generateCoupon()

Create coupon code.


    public
            static        generateCoupon([bool $check = false ]) : string

Parameters

$check : bool = false: Check new coupon or no.

Return values

string

getById()


    public
            static        getById(mixed $id) : EO_DiscountCoupon_Result

Parameters

$id : mixed

Return values

EO_DiscountCoupon_Result

getByPrimary()


    public
            static        getByPrimary(mixed $primary[, array<string|int, mixed> $parameters =  = '[]' ]) : EO_DiscountCoupon_Result

Parameters

$primary : mixed
$parameters : array<string|int, mixed> = = '[]'

Return values

EO_DiscountCoupon_Result

getCouponTypes()

Returns coupon types list.


    public
            static        getCouponTypes([bool $extendedMode = false ]) : array<string|int, mixed>

Parameters

$extendedMode : bool = false: Get type ids or ids with title.

Return values

array<string|int, mixed>

getEntity()


    public
            static        getEntity() : EO_DiscountCoupon_Entity

Return values

EO_DiscountCoupon_Entity

getList()


    public
            static        getList([array<string|int, mixed> $parameters =  = '[]' ]) : EO_DiscountCoupon_Result

Parameters

$parameters : array<string|int, mixed> = = '[]'

Return values

EO_DiscountCoupon_Result

getMap()

Returns entity map definition.


    public
            static        getMap() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTableName()

Returns DB table name for entity.


    public
            static        getTableName() : string

Return values

string

isCheckedCouponsUse()

Returns current checking use coupons mode.


    public
            static        isCheckedCouponsUse() : bool

Return values

bool

isValidCouponType()

Check valid coupon type.


    public
            static        isValidCouponType(int $couponType) : bool

Parameters

$couponType : int: Coupon type.

Return values

bool

onAfterAdd()

Default onAfterAdd handler. Absolutely necessary.


    public
            static        onAfterAdd(Event $event) : void

Parameters

$event : Event: Current data for add.

onAfterDelete()

Default onAfterDelete handler. Absolutely necessary.


    public
            static        onAfterDelete(Event $event) : void

Parameters

$event : Event: Current data for delete.

onAfterUpdate()

Default onAfterUpdate handler. Absolutely necessary.


    public
            static        onAfterUpdate(Event $event) : void

Parameters

$event : Event: Current data for update.

onBeforeAdd()

Default onBeforeAdd handler. Absolutely necessary.


    public
            static        onBeforeAdd(Event $event) : EventResult

Parameters

$event : Event: Current data for add.

Return values

EventResult

onBeforeUpdate()

Default onBeforeUpdate handler. Absolutely necessary.


    public
            static        onBeforeUpdate(Event $event) : EventResult

Parameters

$event : Event: Current data for update.

Return values

EventResult

onDelete()

Default onDelete handler. Absolutely necessary.


    public
            static        onDelete(Event $event) : void

Parameters

$event : Event: Current data for delete.

onUpdate()

Default onUpdate handler. Absolutely necessary.


    public
            static        onUpdate(Event $event) : void

Parameters

$event : Event: Current data for update.

prepareCouponData()

Prepare coupon data. Only for admin list pages.


    public
            static        prepareCouponData(array<string|int, mixed> &$fields) : Result

Parameters

$fields : array<string|int, mixed>: Coupon data.

Return values

Result

query()


    public
            static        query() : EO_DiscountCoupon_Query

Return values

EO_DiscountCoupon_Query

saveApplied()

Save coupons applyed info.


    public
            static        saveApplied(array<string|int, mixed> $coupons, int $userId, DateTime $currentTime) : array<string|int, mixed>|bool

Parameters

$coupons : array<string|int, mixed>: Coupons list.
$userId : int: User id.
$currentTime : DateTime: Current datetime.

Return values

array<string|int, mixed>|bool

setDiscountCheckList()

Fill discount list for update use coupons flag.


    public
            static        setDiscountCheckList(array<string|int, mixed>|int $discountList) : void

Parameters

$discountList : array<string|int, mixed>|int: Discount ids for check.

updateUseCoupons()

Update use coupon flag for discount list.


    public
            static        updateUseCoupons() : void

validateCoupon()

Returns validators for COUPON field.


    public
            static        validateCoupon() : array<string|int, mixed>

Return values

array<string|int, mixed>

validateDiscountId()

Returns validators for DISCOUNT_ID field.


    public
            static        validateDiscountId() : array<string|int, mixed>

Return values

array<string|int, mixed>

validateType()

Returns validators for TYPE field.


    public
            static        validateType() : array<string|int, mixed>

Return values

array<string|int, mixed>

wakeUpCollection()


    public
            static        wakeUpCollection(mixed $rows) : EO_DiscountCoupon_Collection

Parameters

$rows : mixed

Return values

EO_DiscountCoupon_Collection

wakeUpObject()


    public
            static        wakeUpObject(mixed $row) : EO_DiscountCoupon

Parameters

$row : mixed

Return values

EO_DiscountCoupon

DiscountCouponTable extends DataManager

Table of Contents

Constants

Methods

Constants

EVENT_ON_AFTER_DELETE_DISCOUNT

EVENT_ON_GENERATE_COUPON

TYPE_ARCHIVED

TYPE_BASKET_ROW

TYPE_MULTI_ORDER

TYPE_ONE_ORDER

TYPE_UNKNOWN

Methods

addPacket()

Parameters

Return values

checkCoupon()

Parameters

Return values

checkDiscountId()

Parameters

Return values

checkPacket()

Parameters

Return values

checkType()

Parameters

Return values

clearDiscountCheckList()

createCollection()

Return values

createObject()

Parameters

Return values

deleteByDiscount()

Parameters

disableCheckCouponsUse()

enableCheckCouponsUse()

generateCoupon()

Parameters

Return values

getById()

Parameters

Return values

getByPrimary()

Parameters

Return values

getCouponTypes()

Parameters

Return values

getEntity()

Return values

getList()

Parameters

Return values

getMap()

Return values

getTableName()

Return values

isCheckedCouponsUse()

Return values

isValidCouponType()

Parameters

Return values

onAfterAdd()

Parameters

onAfterDelete()

Parameters

onAfterUpdate()

Parameters

onBeforeAdd()

Parameters

Return values

onBeforeUpdate()

Parameters

Return values

onDelete()

Parameters

onUpdate()

Parameters