Bitrix API

DiscountCompatibility

Table of Contents

Constants

ERROR_ID  = 'BX_SALE_DISCOUNT_COMPATIBILITY'
MODE_CLIENT  = 0x1
MODE_DISABLED  = 0x20
MODE_EXTERNAL  = 0x10
MODE_MANAGER  = 0x2
MODE_ORDER  = 0x4
MODE_SYSTEM  = 0x8

Methods

calculateBasketDiscounts()  : bool
Calculate basket discounts for save.
calculateSaleDiscount()  : bool
Save sale discount.
clearBasketItemData()  : void
Clear basket item data.
clearDiscountResult()  : void
Clear results before calculate.
clearErrors()  : void
Clear errors list.
fillBasketData()  : void
Fill base prices.
getApplyResult()  : array<string|int, mixed>
Return discount list description.
getBasketItemBasePrice()  : float|null
Get base price for basket item.
getBasketItemDiscounts()  : null|array<string|int, mixed>
Get product discounts for basket item.
getConfig()  : array<string|int, mixed>
Returns configuration parameters.
getErrors()  : array<string|int, mixed>
Return error list.
getOldDiscountResult()  : array<string|int, mixed>
Return result discount list in old format. Compatibility only.
getResult()  : array<string|int, mixed>|bool
Return discount result for old api.
getUseMode()  : int
Return use mode.
init()  : void
Initialization discount save information.
initUseMode()  : void
Init use mode.
isInited()  : bool
Check initialization.
isSuccess()  : bool
Return result operation.
isUsed()  : bool
Check used compatible calculate.
OnSaleBasketItemRefreshData()  : EventResult
Handler for use old api.
reInit()  : void
Reinitialization discount save information.
roundPrices()  : void
Round prices.
setApplyMode()  : void
Save apply mode information.
setBasketBasePrice()  : void
Set base price for all basket items.
setBasketCode()  : void
Set basket code.
setBasketItemBasePrice()  : void
Set base price for basket item.
setBasketItemData()  : void
setBasketItemDiscounts()  : void
Set product discounts for basket item.
setOldDiscountResult()  : void
Save result discount list from CSaleDiscount::DoProcessOrder.
setOrderData()  : void
Push to stack current order data.
setShipment()  : void
Set shipment.
usedByClient()  : bool
Check client use mode.
usedByManager()  : bool
Check manager use mode.

Constants

Methods

calculateBasketDiscounts()

Calculate basket discounts for save.

public static calculateBasketDiscounts(array<string|int, mixed> &$basket) : bool
Parameters
$basket : array<string|int, mixed>

Basket items.

Return values
bool

calculateSaleDiscount()

Save sale discount.

public static calculateSaleDiscount(array<string|int, mixed> &$order, array<string|int, mixed> $discount) : bool
Parameters
$order : array<string|int, mixed>

Current order data.

$discount : array<string|int, mixed>

Discount data.

Return values
bool

clearBasketItemData()

Clear basket item data.

public static clearBasketItemData(int $code) : void
Parameters
$code : int

Basket code.

clearDiscountResult()

Clear results before calculate.

public static clearDiscountResult() : void

fillBasketData()

Fill base prices.

public static fillBasketData(array<string|int, mixed> &$basket) : void
Parameters
$basket : array<string|int, mixed>

Basket data.

getApplyResult()

Return discount list description.

public static getApplyResult([bool $extMode = false ]) : array<string|int, mixed>
Parameters
$extMode : bool = false

Extended mode.

Return values
array<string|int, mixed>

getBasketItemBasePrice()

Get base price for basket item.

public static getBasketItemBasePrice(string|int $code) : float|null
Parameters
$code : string|int

Basket code.

Return values
float|null

getBasketItemDiscounts()

Get product discounts for basket item.

public static getBasketItemDiscounts(string|int $code) : null|array<string|int, mixed>
Parameters
$code : string|int

Basket code.

Return values
null|array<string|int, mixed>

getConfig()

Returns configuration parameters.

public static getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getErrors()

Return error list.

public static getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOldDiscountResult()

Return result discount list in old format. Compatibility only.

public static getOldDiscountResult() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResult()

Return discount result for old api.

public static getResult() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

init()

Initialization discount save information.

public static init([int $mode = self::MODE_CLIENT ][, array<string|int, mixed> $config = array() ]) : void
Parameters
$mode : int = self::MODE_CLIENT

Discount manager mode.

$config : array<string|int, mixed> = array()

Initial params (site, currency, order).

initUseMode()

Init use mode.

public static initUseMode([int $mode = self::MODE_CLIENT ][, array<string|int, mixed> $config = array() ]) : void
Parameters
$mode : int = self::MODE_CLIENT

Save discount information mode.

$config : array<string|int, mixed> = array()

Initial params (site, currency). keys are case sensitive:

  • string SITE_ID Current site
  • string CURRENCY Site currency
  • string ORDER_ID Order id
.

OnSaleBasketItemRefreshData()

Handler for use old api.

public static OnSaleBasketItemRefreshData(Event $event) : EventResult
Parameters
$event : Event

Event data.

Return values
EventResult

reInit()

Reinitialization discount save information.

public static reInit([int $mode = self::MODE_CLIENT ][, array<string|int, mixed> $config = array() ]) : void
Parameters
$mode : int = self::MODE_CLIENT

Discount manager mode.

$config : array<string|int, mixed> = array()

Initial params (site, currency, order).

roundPrices()

Round prices.

public static roundPrices(array<string|int, mixed> &$basket[, array<string|int, mixed> $orderData = array() ]) : void
Parameters
$basket : array<string|int, mixed>

Basket items.

$orderData : array<string|int, mixed> = array()

Order (without basket).

setApplyMode()

Save apply mode information.

public static setApplyMode(array<string|int, mixed> &$basket) : void
Parameters
$basket : array<string|int, mixed>

Basket items.

setBasketBasePrice()

Set base price for all basket items.

public static setBasketBasePrice(array<string|int, mixed> $basket) : void
Parameters
$basket : array<string|int, mixed>

Basket.

Tags
throws
ArgumentNullException

setBasketCode()

Set basket code.

public static setBasketCode(string|int $index, string|int $code) : void
Parameters
$index : string|int

Item index.

$code : string|int

Basket code.

setBasketItemBasePrice()

Set base price for basket item.

public static setBasketItemBasePrice(string|int $code, float $price, string $currency) : void
Parameters
$code : string|int

Basket code.

$price : float

Price.

$currency : string

Currency.

setBasketItemData()

public static setBasketItemData(int|string $code, array<string|int, mixed> $providerData) : void
Parameters
$code : int|string

Basket code.

$providerData : array<string|int, mixed>

Product data from provider.

setBasketItemDiscounts()

Set product discounts for basket item.

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

Basket code.

$discountList : array<string|int, mixed>

Discount list.

setOldDiscountResult()

Save result discount list from CSaleDiscount::DoProcessOrder.

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

Result from CSaleDiscount::DoProcessOrder.

setOrderData()

Push to stack current order data.

public static setOrderData(array<string|int, mixed> $order) : void
Parameters
$order : array<string|int, mixed>

Current order data.

setShipment()

Set shipment.

public static setShipment(int $order, int|array<string|int, mixed> $shipment) : void
Parameters
$order : int

Order id.

$shipment : int|array<string|int, mixed>

Shipment id.

usedByClient()

Check client use mode.

public static usedByClient() : bool
Return values
bool

usedByManager()

Check manager use mode.

public static usedByManager() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results