Bitrix API

UserBudgetPool

Table of Contents

Constants

BUDGET_TYPE_EXCESS_SUM_PAID  = 'EXCESS_SUM_PAID'
BUDGET_TYPE_MANUAL  = 'MANUAL'
BUDGET_TYPE_ORDER_CANCEL_PART  = 'ORDER_CANCEL_PART'
BUDGET_TYPE_ORDER_PART_RETURN  = 'ORDER_PART_RETURN'
BUDGET_TYPE_ORDER_PAY  = 'ORDER_PAY'
BUDGET_TYPE_ORDER_PAY_PART  = 'ORDER_PAY_PART'
BUDGET_TYPE_ORDER_UNPAY  = 'ORDER_UNPAY'
BUDGET_TYPE_OUT_CHARGE_OFF  = 'OUT_CHARGE_OFF'

Methods

__destruct()  : mixed
add()  : mixed
addPoolItem()  : mixed
delete()  : bool
get()  : array<string|int, mixed>|false
getUserBudget()  : float|null
getUserBudgetByOrder()  : int
getUserBudgetPool()  : UserBudgetPool
getUserBudgetTransForOrder()  : int
onUserBudgetSave()  : Result

Constants

BUDGET_TYPE_EXCESS_SUM_PAID

public mixed BUDGET_TYPE_EXCESS_SUM_PAID = 'EXCESS_SUM_PAID'

BUDGET_TYPE_ORDER_CANCEL_PART

public mixed BUDGET_TYPE_ORDER_CANCEL_PART = 'ORDER_CANCEL_PART'

BUDGET_TYPE_ORDER_PART_RETURN

public mixed BUDGET_TYPE_ORDER_PART_RETURN = 'ORDER_PART_RETURN'

BUDGET_TYPE_ORDER_PAY

public mixed BUDGET_TYPE_ORDER_PAY = 'ORDER_PAY'

BUDGET_TYPE_ORDER_PAY_PART

public mixed BUDGET_TYPE_ORDER_PAY_PART = 'ORDER_PAY_PART'

BUDGET_TYPE_ORDER_UNPAY

public mixed BUDGET_TYPE_ORDER_UNPAY = 'ORDER_UNPAY'

BUDGET_TYPE_OUT_CHARGE_OFF

public mixed BUDGET_TYPE_OUT_CHARGE_OFF = 'OUT_CHARGE_OFF'

Methods

add()

public add(mixed $sum, mixed $budgetType, Order $order[, Payment|null $payment = null ]) : mixed
Parameters
$sum : mixed
$budgetType : mixed
$order : Order
$payment : Payment|null = null

addPoolItem()

public static addPoolItem(Order $order, mixed $value, mixed $type[, Payment|null $payment = null ]) : mixed
Parameters
$order : Order
$value : mixed
$type : mixed
$payment : Payment|null = null
Tags
throws
SqlQueryException

delete()

public delete(mixed $index) : bool
Parameters
$index : mixed
Tags
throws
SqlQueryException
Return values
bool

get()

public get() : array<string|int, mixed>|false
Return values
array<string|int, mixed>|false

getUserBudget()

public static getUserBudget(mixed $userId, mixed $currency) : float|null
Parameters
$userId : mixed
$currency : mixed
Return values
float|null

getUserBudgetByOrder()

public static getUserBudgetByOrder(Order $order) : int
Parameters
$order : Order
Return values
int

getUserBudgetTransForOrder()

public static getUserBudgetTransForOrder(Order $order) : int
Parameters
$order : Order
Return values
int

onUserBudgetSave()

public static onUserBudgetSave(mixed $userId) : Result
Parameters
$userId : mixed
Return values
Result

        
On this page

Search results