Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Actions

Открытые статические члены

static roundZeroValue ($value)
 
static roundValue ($value, $currency)
 
static setUseMode ($mode, array $config=array())
 
static getUseMode ()
 
static isCalculateMode ()
 
static isManualMode ()
 
static isMixedMode ()
 
static checkUseMode (array $list)
 
static getPercentMode ()
 
static getCurrency ()
 
static clearApplyCounter ()
 
static getApplyCounter ()
 
static increaseApplyCounter ()
 
static disableBasketFilter ()
 
static enableBasketFilter ()
 
static usedBasketFilter ()
 
static fillCompatibleFields (array &$order)
 
static filterBasketForAction (array $item)
 
static getActionDescription ()
 
static getActionResult ()
 
static setApplyResultMode ($mode)
 
static getApplyResultMode ()
 
static setApplyResult (array $applyResult)
 
static setStoredData (array $data)
 
static getStoredData ()
 
static setActionStoredData (array $data)
 
static getActionStoredData ()
 
static clearAction ()
 
static applyToBasket (array &$order, array $action, $filter)
 
static applyCumulativeToBasket (array &$order, array $ranges, array $configuration=array(), $filter=null)
 
static applyToDelivery (array &$order, array $action)
 
static applySimpleGift (array &$order, $filter)
 
static getBasketForApply (array $basket, $filter, $action=array())
 
static setActionDescription ($type, $description)
 
static setActionResult ($entity, array $actionResult)
 
static clearEntityActionResult ($entity, array $entityParams=array())
 
static getPercentByValue ($basket, $value)
 
static percentToValue ($basketRow, $percent)
 
static getActionConfiguration (array $discount)
 

Открытые атрибуты

const VALUE_TYPE_FIX = 'F'
 
const VALUE_TYPE_PERCENT = 'P'
 
const VALUE_TYPE_SUMM = 'S'
 
const VALUE_TYPE_CLOSEOUT = 'C'
 
const GIFT_SELECT_TYPE_ONE = 'one'
 
const GIFT_SELECT_TYPE_ALL = 'all'
 
const BASKET_APPLIED_FIELD = 'DISCOUNT_APPLIED'
 
const VALUE_EPS = 1E-5
 
const MODE_CALCULATE = 0x0001
 
const MODE_MANUAL = 0x0002
 
const MODE_MIXED = 0x0004
 
const APPLY_COUNTER_START = -1
 
const PERCENT_FROM_CURRENT_PRICE = 0x0001
 
const PERCENT_FROM_BASE_PRICE = 0x0002
 
const RESULT_ENTITY_BASKET = 0x0001
 
const RESULT_ENTITY_DELIVERY = 0x0002
 
const RESULT_ENTITY_ORDER = 0x0004
 
const APPLY_RESULT_MODE_COUNTER = 0x0001
 
const APPLY_RESULT_MODE_DESCR = 0x0002
 
const APPLY_RESULT_MODE_SIMPLE = 0x0004
 
const ACTION_TYPE_DISCOUNT = 'D'
 
const ACTION_TYPE_EXTRA = 'E'
 

Защищенные статические члены

static getActionStructure (array $discount)
 
static compareBasketResultDescr (array $action, $resultDescr)
 
static calculateDiscountPrice ($value, $unit, array $basketRow, $limitValue, $maxBound)
 
static fillDiscountPrice (array &$basketRow, $price, $discount)
 

Статические защищенные данные

static $useMode = self::MODE_CALCULATE
 
static $applyCounter = self::APPLY_COUNTER_START
 
static $actionResult = array()
 
static $actionDescription = array()
 
static $applyResult = array()
 
static $applyResultMode = self::APPLY_RESULT_MODE_COUNTER
 
static $storedData = array()
 
static $useBasketFilter = true
 
static $percentValueMode = self::PERCENT_FROM_CURRENT_PRICE
 
static $currencyId = ''
 
static $siteId = ''
 

Подробное описание

См. определение в файле actions.php строка 10

Методы

◆ applyCumulativeToBasket()

static applyCumulativeToBasket ( array & $order,
array $ranges,
array $configuration = array(),
$filter = null )
static

Cumulative action.

Аргументы
array&$orderOrder data.
array$ranges
array$configuration
callable | null$filter
Возвращает
void
Исключения
Main

ArgumentOutOfRangeException

См. определение в файле actions.php строка 613

◆ applySimpleGift()

static applySimpleGift ( array & $order,
$filter )
static

Simple gift action.

Аргументы
array&$orderOrder data.
callable$filterFilter.
Исключения
Main

ArgumentOutOfRangeException

Возвращает
void

См. определение в файле actions.php строка 942

◆ applyToBasket()

static applyToBasket ( array & $order,
array $action,
$filter )
static

Basket action.

Аргументы
array&$orderOrder data.
array$actionAction detail keys are case sensitive:
  • float|int VALUE Discount value.
  • char UNIT Discount type.
  • string CURRENCY Currency discount (optional).
  • char MAX_BOUND Max bound (optional).
.
callable$filterFilter for basket items.
Возвращает
void

См. определение в файле actions.php строка 455

◆ applyToDelivery()

static applyToDelivery ( array & $order,
array $action )
static

Delivery action.

Аргументы
array&$orderOrder data.
array$actionAction detail keys are case sensitive:
  • float|int VALUE Discount value.
  • char UNIT Discount type.
  • string CURRENCY Currency discount (optional).
  • char MAX_BOUND Max bound.
.
Возвращает
void

См. определение в файле actions.php строка 852

◆ calculateDiscountPrice()

static calculateDiscountPrice ( $value,
$unit,
array $basketRow,
$limitValue,
$maxBound )
staticprotected

Calculate simple discount result.

Аргументы
int | float$valueDiscount value.
string$unitDiscount value type.
array$basketRowBasket item.
int | float | null$limitValueMax discount value.
bool$maxBoundAllow set price to 0, if discount more than price.
Возвращает
array

См. определение в файле actions.php строка 1394

◆ checkUseMode()

static checkUseMode ( array $list)
static

Check current use actions mode.

Аргументы
array$list
Возвращает
bool

См. определение в файле actions.php строка 181

◆ clearAction()

static clearAction ( )
static

Clear actions description and result.

Возвращает
void

См. определение в файле actions.php строка 431

◆ clearApplyCounter()

static clearApplyCounter ( )
static

Clear apply counter.

Возвращает
void

См. определение в файле actions.php строка 211

◆ clearEntityActionResult()

static clearEntityActionResult ( $entity,
array $entityParams = array() )
static
Аргументы
int$entityEntity id.
array$entityParamsEntity params (optional).
Возвращает
void

См. определение в файле actions.php строка 1166

◆ compareBasketResultDescr()

static compareBasketResultDescr ( array $action,
$resultDescr )
staticprotected

Return check result for error mode.

Аргументы
array$actionAction description.
array$resultDescrResult description.
Возвращает
bool

См. определение в файле actions.php строка 1320

◆ disableBasketFilter()

static disableBasketFilter ( )
static

Disable basket filter for mixed apply mode.

Возвращает
void

См. определение в файле actions.php строка 241

◆ enableBasketFilter()

static enableBasketFilter ( )
static

Enable basket filter for mixed apply mode.

Возвращает
void

См. определение в файле actions.php строка 253

◆ fillCompatibleFields()

static fillCompatibleFields ( array & $order)
static

Fill compatible fields for old public api.

Аргументы
array&$orderOrder data.
Возвращает
void

См. определение в файле actions.php строка 276

◆ fillDiscountPrice()

static fillDiscountPrice ( array & $basketRow,
$price,
$discount )
staticprotected

Fill price fields in basket item.

Аргументы
array&$basketRowBasket item fields.
int | float$priceNew price.
int | float$discountValue of the discount change.
Возвращает
void

См. определение в файле actions.php строка 1437

◆ filterBasketForAction()

static filterBasketForAction ( array $item)
static

Basket filter.

Аргументы
array$itemBasket item.
Возвращает
bool

См. определение в файле actions.php строка 307

◆ getActionConfiguration()

static getActionConfiguration ( array $discount)
static

См. определение в файле actions.php строка 1239

◆ getActionDescription()

static getActionDescription ( )
static

Return all actions description.

Возвращает
array

См. определение в файле actions.php строка 326

◆ getActionResult()

static getActionResult ( )
static

Return all actions results.

Возвращает
array

См. определение в файле actions.php строка 336

◆ getActionStoredData()

static getActionStoredData ( )
static

Return stored action.

Возвращает
array|null

См. определение в файле actions.php строка 418

◆ getActionStructure()

static getActionStructure ( array $discount)
staticprotected

См. определение в файле actions.php строка 1287

◆ getApplyCounter()

static getApplyCounter ( )
static

Return current apply counter.

Возвращает
int

См. определение в файле actions.php строка 221

◆ getApplyResultMode()

static getApplyResultMode ( )
static

Return apply result format mode.

Возвращает
int

См. определение в файле actions.php строка 361

◆ getBasketForApply()

static getBasketForApply ( array $basket,
$filter,
$action = array() )
static

Return basket item for action apply.

Аргументы
array$basketBasket.
mixed$filterFilter.
array$actionPrepare data.
Возвращает
mixed

См. определение в файле actions.php строка 1002

◆ getCurrency()

static getCurrency ( )
static

Return calculate currency.

Возвращает
string

См. определение в файле actions.php строка 201

◆ getPercentByValue()

static getPercentByValue ( $basket,
$value )
static

Return percent value.

Аргументы
array$basketBasket.
int | float$valueValue.
Возвращает
float

См. определение в файле actions.php строка 1196

◆ getPercentMode()

static getPercentMode ( )
static

Return calculate mode for percent discount.

Возвращает
int

См. определение в файле actions.php строка 191

◆ getStoredData()

static getStoredData ( )
static

Return stored data after discount calculation.

Возвращает
array

См. определение в файле actions.php строка 393

◆ getUseMode()

static getUseMode ( )
static

Returns current use actions mode.

Возвращает
int

См. определение в файле actions.php строка 140

◆ increaseApplyCounter()

static increaseApplyCounter ( )
static

Increment current apply counter. Use BEFORE discount action apply.

Возвращает
void

См. определение в файле actions.php строка 231

◆ isCalculateMode()

static isCalculateMode ( )
static

Check calculate mode.

Возвращает
bool

См. определение в файле actions.php строка 150

◆ isManualMode()

static isManualMode ( )
static

Check manual mode.

Возвращает
bool

См. определение в файле actions.php строка 160

◆ isMixedMode()

static isMixedMode ( )
static

Check mixed mode.

Возвращает
bool

См. определение в файле actions.php строка 170

◆ percentToValue()

static percentToValue ( $basketRow,
$percent )
static

Calculate percent price.

Аргументы
array$basketRowBasket item.
float$percentPercent value.
Возвращает
float

См. определение в файле actions.php строка 1223

◆ roundValue()

static roundValue ( $value,
$currency )
static

Rounded value with sale rules.

Аргументы
float | int$valueValue.
string$currencyCurrency.
Возвращает
float

@noinspection PhpInternalEntityUsedInspection

Аргументы
$currency@noinspection PhpUnusedParameterInspection

См. определение в файле actions.php строка 78

◆ roundZeroValue()

static roundZeroValue ( $value)
static

Check for zero value.

Аргументы
float | int$valuePrice or discount value.
Возвращает
float|int

См. определение в файле actions.php строка 66

◆ setActionDescription()

static setActionDescription ( $type,
$description )
static

Save action description.

Аргументы
int$typeAction object type.
array$descriptionDescription.
Возвращает
void

См. определение в файле actions.php строка 1083

◆ setActionResult()

static setActionResult ( $entity,
array $actionResult )
static

Save result.

Аргументы
int$entityAction object type.
array$actionResultResult description.
Возвращает
void

См. определение в файле actions.php строка 1122

◆ setActionStoredData()

static setActionStoredData ( array $data)
static

Fill action data to store.

Аргументы
array$dataAction data to store.
Возвращает
void

См. определение в файле actions.php строка 404

◆ setApplyResult()

static setApplyResult ( array $applyResult)
static

Set apply result list.

Аргументы
array$applyResultApply data.
Возвращает
void

См. определение в файле actions.php строка 372

◆ setApplyResultMode()

static setApplyResultMode ( $mode)
static

Set apply result format mode.

Аргументы
int$modeApply result mode.
Возвращает
void

См. определение в файле actions.php строка 347

◆ setStoredData()

static setStoredData ( array $data)
static

Fill data to store for discount.

Аргументы
array$dataData.
Возвращает
void

См. определение в файле actions.php строка 383

◆ setUseMode()

static setUseMode ( $mode,
array $config = array() )
static

Set use actions mode.

Аргументы
int$modeUse mode.
array$configConfig.
Возвращает
void

См. определение в файле actions.php строка 91

◆ usedBasketFilter()

static usedBasketFilter ( )
static

Return is enabled basket filter mixed apply mode.

Возвращает
bool

См. определение в файле actions.php строка 265

Данные класса

◆ $actionDescription

$actionDescription = array()
staticprotected

См. определение в файле actions.php строка 47

◆ $actionResult

$actionResult = array()
staticprotected

См. определение в файле actions.php строка 46

◆ $applyCounter

$applyCounter = self::APPLY_COUNTER_START
staticprotected

См. определение в файле actions.php строка 45

◆ $applyResult

$applyResult = array()
staticprotected

См. определение в файле actions.php строка 48

◆ $applyResultMode

$applyResultMode = self::APPLY_RESULT_MODE_COUNTER
staticprotected

См. определение в файле actions.php строка 49

◆ $currencyId

$currencyId = ''
staticprotected

См. определение в файле actions.php строка 55

◆ $percentValueMode

$percentValueMode = self::PERCENT_FROM_CURRENT_PRICE
staticprotected

См. определение в файле actions.php строка 54

◆ $siteId

$siteId = ''
staticprotected

См. определение в файле actions.php строка 56

◆ $storedData

$storedData = array()
staticprotected

См. определение в файле actions.php строка 50

◆ $useBasketFilter

$useBasketFilter = true
staticprotected

См. определение в файле actions.php строка 52

◆ $useMode

$useMode = self::MODE_CALCULATE
staticprotected

См. определение в файле actions.php строка 44

◆ ACTION_TYPE_DISCOUNT

const ACTION_TYPE_DISCOUNT = 'D'

См. определение в файле actions.php строка 41

◆ ACTION_TYPE_EXTRA

const ACTION_TYPE_EXTRA = 'E'

См. определение в файле actions.php строка 42

◆ APPLY_COUNTER_START

const APPLY_COUNTER_START = -1

См. определение в файле actions.php строка 28

◆ APPLY_RESULT_MODE_COUNTER

const APPLY_RESULT_MODE_COUNTER = 0x0001

См. определение в файле actions.php строка 37

◆ APPLY_RESULT_MODE_DESCR

const APPLY_RESULT_MODE_DESCR = 0x0002

См. определение в файле actions.php строка 38

◆ APPLY_RESULT_MODE_SIMPLE

const APPLY_RESULT_MODE_SIMPLE = 0x0004

См. определение в файле actions.php строка 39

◆ BASKET_APPLIED_FIELD

const BASKET_APPLIED_FIELD = 'DISCOUNT_APPLIED'

См. определение в файле actions.php строка 20

◆ GIFT_SELECT_TYPE_ALL

const GIFT_SELECT_TYPE_ALL = 'all'

См. определение в файле actions.php строка 18

◆ GIFT_SELECT_TYPE_ONE

const GIFT_SELECT_TYPE_ONE = 'one'

См. определение в файле actions.php строка 17

◆ MODE_CALCULATE

const MODE_CALCULATE = 0x0001

См. определение в файле actions.php строка 24

◆ MODE_MANUAL

const MODE_MANUAL = 0x0002

См. определение в файле actions.php строка 25

◆ MODE_MIXED

const MODE_MIXED = 0x0004

См. определение в файле actions.php строка 26

◆ PERCENT_FROM_BASE_PRICE

const PERCENT_FROM_BASE_PRICE = 0x0002

См. определение в файле actions.php строка 31

◆ PERCENT_FROM_CURRENT_PRICE

const PERCENT_FROM_CURRENT_PRICE = 0x0001

См. определение в файле actions.php строка 30

◆ RESULT_ENTITY_BASKET

const RESULT_ENTITY_BASKET = 0x0001

См. определение в файле actions.php строка 33

◆ RESULT_ENTITY_DELIVERY

const RESULT_ENTITY_DELIVERY = 0x0002

См. определение в файле actions.php строка 34

◆ RESULT_ENTITY_ORDER

const RESULT_ENTITY_ORDER = 0x0004

См. определение в файле actions.php строка 35

◆ VALUE_EPS

const VALUE_EPS = 1E-5

См. определение в файле actions.php строка 22

◆ VALUE_TYPE_CLOSEOUT

const VALUE_TYPE_CLOSEOUT = 'C'

См. определение в файле actions.php строка 15

◆ VALUE_TYPE_FIX

const VALUE_TYPE_FIX = 'F'

См. определение в файле actions.php строка 12

◆ VALUE_TYPE_PERCENT

const VALUE_TYPE_PERCENT = 'P'

См. определение в файле actions.php строка 13

◆ VALUE_TYPE_SUMM

const VALUE_TYPE_SUMM = 'S'

См. определение в файле actions.php строка 14