Bitrix API

DiscountManager

Table of Contents

Methods

applyDiscount()  : void
Apply catalog discount by basket item.
calculateApplyCoupons()  : array<string|int, mixed>
Check apply coupons.
catalogDiscountManager()  : EventResult
Return methods for prepare discount.
clearProductPricesCache()  : void
Clear product prices cache.
clearProductPropertiesCache()  : void
Clear property values cache.
clearProductsCache()  : void
Clear products cache.
extendOrderData()  : EventResult
Extend basket data.
getEditUrl()  : string
Return url for edit discount.
getPriceDataByProductId()  : null|array<string|int, mixed>
Returns price for product which has catalog group.
preloadPriceData()  : void
Preloads prices for products with catalog groups.
preloadProductDataToExtendOrder()  : void
Load product data for calculate discounts.
prepareData()  : array<string|int, mixed>|bool
Prepare discount before saving.
roundBasket()  : array<string|int, mixed>
Round basket prices.
roundPrice()  : array<string|int, mixed>
Round basket item price.
setProductPropertiesCache()  : void
Set property values cache for product.

Methods

applyDiscount()

Apply catalog discount by basket item.

public static applyDiscount(array<string|int, mixed> &$product, array<string|int, mixed> $discount) : void
Parameters
$product : array<string|int, mixed>

Product data.

$discount : array<string|int, mixed>

Discount data.

Tags
noinspection

PhpMissingParamTypeInspection

calculateApplyCoupons()

Check apply coupons.

public static calculateApplyCoupons(array<string|int, mixed> $couponsList, array<string|int, mixed> $basket, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$couponsList : array<string|int, mixed>

Coupons.

$basket : array<string|int, mixed>

Basket data.

$params : array<string|int, mixed>

Calculate params.

Tags
throws
ArgumentException
Return values
array<string|int, mixed>

catalogDiscountManager()

Return methods for prepare discount.

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

Event data from discount manager.

Tags
noinspection

PhpUnusedParameterInspection

Return values
EventResult

clearProductPricesCache()

Clear product prices cache.

public static clearProductPricesCache() : void

clearProductPropertiesCache()

Clear property values cache.

public static clearProductPropertiesCache() : void

clearProductsCache()

Clear products cache.

public static clearProductsCache() : void

extendOrderData()

Extend basket data.

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

Event.

Return values
EventResult

getEditUrl()

Return url for edit discount.

public static getEditUrl(array<string|int, mixed> $discount) : string
Parameters
$discount : array<string|int, mixed>

Discount data.

Return values
string

getPriceDataByProductId()

Returns price for product which has catalog group.

public static getPriceDataByProductId(int $productId, int $catalogGroupId) : null|array<string|int, mixed>
Parameters
$productId : int

Product id.

$catalogGroupId : int

Catalog group.

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

preloadPriceData()

Preloads prices for products with catalog groups.

public static preloadPriceData(array<string|int, mixed> $productIds, array<string|int, mixed> $catalogGroups) : void
Parameters
$productIds : array<string|int, mixed>

List of product ids.

$catalogGroups : array<string|int, mixed>

Catalog groups.

preloadProductDataToExtendOrder()

Load product data for calculate discounts.

public static preloadProductDataToExtendOrder(array<string|int, mixed> $productIds, array<string|int, mixed> $userGroups) : void
Parameters
$productIds : array<string|int, mixed>

Product id list.

$userGroups : array<string|int, mixed>

User group list.

prepareData()

Prepare discount before saving.

public static prepareData(array<string|int, mixed> $discount[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|bool
Parameters
$discount : array<string|int, mixed>

Discount data.

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

Params.

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

roundBasket()

Round basket prices.

public static roundBasket(array<string|int, mixed> $basket[, array<string|int, mixed> $basketRoundData = [] ][, array<string|int, mixed> $order = [] ]) : array<string|int, mixed>
Parameters
$basket : array<string|int, mixed>

Basket.

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

Round rules.

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

Order fields (without basket, can be absent).

Tags
noinspection

PhpUnusedParameterInspection

Return values
array<string|int, mixed>

roundPrice()

Round basket item price.

public static roundPrice(array<string|int, mixed> $basketItem[, array<string|int, mixed> $roundData = [] ]) : array<string|int, mixed>
Parameters
$basketItem : array<string|int, mixed>

Basket item data.

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

Round rule.

Tags
see
DiscountManager::roundBasket
Return values
array<string|int, mixed>

setProductPropertiesCache()

Set property values cache for product.

public static setProductPropertiesCache(int $productId, array<string|int, mixed> $props) : void
Parameters
$productId : int

Product id.

$props : array<string|int, mixed>

Property values.

Tags
noinspection

PhpMissingParamTypeInspection


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results