Bitrix API

Discount extends DiscountBase

Table of Contents

Constants

APPLY_MODE_ADD  = 0x1

APPLY_MODE_DISABLE  = 0x2

APPLY_MODE_FULL_DISABLE  = 0x8

APPLY_MODE_FULL_LAST  = 0x10

APPLY_MODE_LAST  = 0x4

ENTITY_BASKET_ITEM  = 'BASKET_ITEM'

ENTITY_DELIVERY  = 'DELIVERY'

ENTITY_ORDER  = 'ORDER'

ERROR_ID  = 'BX_SALE_DISCOUNT'

EVENT_EXTEND_ORDER_DATA  = 'onExtendOrderData'

EXECUTE_FIELD_PREFIX  = 'EXECUTE_'

ROUND_MODE_BASKET_DISCOUNT  = 0x1

ROUND_MODE_FINAL_PRICE  = 0x4

ROUND_MODE_SALE_DISCOUNT  = 0x2

USE_MODE_APPLY  = 0x2

USE_MODE_COUPONS  = 0x8

USE_MODE_FULL  = 0x1

USE_MODE_MIXED  = 0x4

Methods

__destruct()  : mixed

buildFromBasket()  : DiscountBase|null

Builds discounts from basket. Basket doesn't have to have a order.

buildFromOrder()  : DiscountBase

Builds discounts from order.

calculate()  : Result

Calculate discounts.

calculateDiscountPercent()  : float|int|null

Calculate discount percent for public components.

clearBasketItemData()  : void

Clear basket item data.

disableCheckingPrediction()  : void

Disables prediction checking instead real condition.

enableCheckingPrediction()  : void

Enables prediction checking instead real condition.

getApplyMode()  : int

Returns current sale discount apply mode.

getApplyModeList()  : array<string|int, mixed>

Return apply mode list.

getApplyResult()  : array<string|int, mixed>

Return discount list description.

getBasketItemBasePrice()  : float|null

Get base price for basket item.

getEmptyApplyBlock()  : array<string|int, mixed>

Return empty apply block.

getOrder()  : OrderBase|null

Return order.

getShipmentsIds()  : array<string|int, mixed>

Return shipment id list for existing order.

getShowPrices()  : array<string|int, mixed>

Returns show prices for public components.

getUseMode()  : int

Return calculate mode.

isClone()  : bool

Returns true if discount entity is cloned.

isOrderExists()  : bool

Return flag is order exists.

isOrderNew()  : bool

Returns new order flag value.

isOrderRefresh()  : bool

Returns full refresh status value.

isValidState()  : mixed

load()  : Discount|DiscountBase

Get discount by order.

loadByBasket()  : Discount|DiscountBase|null

Get discount by basket.

loadByFuser()  : null|Discount|DiscountBase

Get discount by fuser and site.

save()  : Result

Save discount result.

saveExternalLastApplyblock()  : void

setApplyResult()  : void

Change applied discount list.

setBasketBasePrice()  : void

Set base price for all basket items.

setBasketItemBasePrice()  : void

Set base price for basket item.

setBasketItemData()  : void

Set various basket item data.

setBasketItemDiscounts()  : void

Set product discounts for basket item.

setCalculateShipments()  : void

Set calculate shipments.

setOrder()  : DiscountBase

Get discount by order basket.

setOrderRefresh()  : void

Set full refresh status from edit order form.

setUseMode()  : void

Set calculate mode.

verify()  : Result

Verifies discounts before order save.