Bitrix API

DiscountTable extends DataManager

Class DiscountTable

Fields:

  • ID int mandatory
  • XML_ID string(255) optional
  • LID string(2) mandatory
  • NAME string(255) optional
  • PRICE_FROM float optional
  • PRICE_TO float optional
  • CURRENCY string(3) optional
  • DISCOUNT_VALUE float mandatory
  • DISCOUNT_TYPE string(1) mandatory default 'P'
  • ACTIVE bool optional default 'Y'
  • SORT int optional default 100
  • ACTIVE_FROM datetime optional
  • ACTIVE_TO datetime optional
  • TIMESTAMP_X datetime optional
  • MODIFIED_BY int optional
  • DATE_CREATE datetime optional
  • CREATED_BY int optional
  • PRIORITY int optional default 1
  • LAST_DISCOUNT bool optional default 'Y'
  • VERSION int optional default 3
  • CONDITIONS text optional
  • CONDITIONS_LIST text optional
  • UNPACK text optional
  • ACTIONS text optional
  • ACTIONS_LIST text optional
  • APPLICATION text optional
  • PREDICTION_TEXT text optional
  • PREDICTIONS text optional
  • PREDICTIONS_APP text optional
  • USE_COUPONS bool optional default 'N'
  • USE_INDEX bool optional default 'N'
  • PRESET_ID string optional
  • EXECUTE_MODULE string(50) mandatory default 'all'
  • EXECUTE_MODE int default 0
  • CREATED_BY_USER reference to [](\Bitrix\Main\UserTable)
  • MODIFIED_BY_USER reference to [](\Bitrix\Main\UserTable)

Table of Contents

Constants

EXECUTE_MODE_GENERAL  = 0
EXECUTE_MODE_SEPARATELY  = 2
VERSION_15  = 0x3
VERSION_NEW  = 0x2
VERSION_OLD  = 0x1

Methods

createCollection()  : EO_Discount_Collection
createObject()  : EO_Discount
getById()  : EO_Discount_Result
getByPrimary()  : EO_Discount_Result
getEntity()  : EO_Discount_Entity
getList()  : EO_Discount_Result
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity.
onAfterAdd()  : void
Default onAfterAdd handler. Absolutely necessary.
onAfterDelete()  : void
Default onAfterDelete handler. Absolutely necessary.
onAfterUpdate()  : void
Default onAfterUpdate handler. Absolutely necessary.
onBeforeAdd()  : EventResult
Default onBeforeAdd handler. Absolutely necessary.
onBeforeUpdate()  : EventResult
Default onBeforeUpdate handler. Absolutely necessary.
onDelete()  : void
Default onDelete handler. Absolutely necessary.
query()  : EO_Discount_Query
setAllUseCoupons()  : void
Set exist coupons flag for all discounts.
setUseCoupons()  : void
Set exist coupons flag for discount list.
validateCurrency()  : array<string|int, mixed>
Returns validators for CURRENCY field.
validateDiscountType()  : array<string|int, mixed>
Returns validators for DISCOUNT_TYPE field.
validateExecuteModule()  : array<string|int, mixed>
Returns validators for EXECUTE_MODULE field.
validateLid()  : array<string|int, mixed>
Returns validators for LID field.
validateName()  : array<string|int, mixed>
Returns validators for NAME field.
validatePresetId()  : array<string|int, mixed>
Returns validators for PRESET_ID field.
validateXmlId()  : array<string|int, mixed>
Returns validators for XML_ID field.
wakeUpCollection()  : EO_Discount_Collection
wakeUpObject()  : EO_Discount

Constants

EXECUTE_MODE_GENERAL

public mixed EXECUTE_MODE_GENERAL = 0

EXECUTE_MODE_SEPARATELY

public mixed EXECUTE_MODE_SEPARATELY = 2

VERSION_15

public mixed VERSION_15 = 0x3

VERSION_NEW

public mixed VERSION_NEW = 0x2

VERSION_OLD

public mixed VERSION_OLD = 0x1

Methods

createCollection()

public static createCollection() : EO_Discount_Collection
Return values
EO_Discount_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Discount
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_Discount

getById()

public static getById(mixed $id) : EO_Discount_Result
Parameters
$id : mixed
Return values
EO_Discount_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Discount_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Discount_Result

getEntity()

public static getEntity() : EO_Discount_Entity
Return values
EO_Discount_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Discount_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Discount_Result

getMap()

Returns entity map definition.

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

getTableName()

Returns DB table name for entity.

public static getTableName() : string
Return values
string

onAfterAdd()

Default onAfterAdd handler. Absolutely necessary.

public static onAfterAdd(Event $event) : void
Parameters
$event : Event

Event object.

onAfterDelete()

Default onAfterDelete handler. Absolutely necessary.

public static onAfterDelete(Event $event) : void
Parameters
$event : Event

Event object.

onAfterUpdate()

Default onAfterUpdate handler. Absolutely necessary.

public static onAfterUpdate(Event $event) : void
Parameters
$event : Event

Event object.

onBeforeAdd()

Default onBeforeAdd handler. Absolutely necessary.

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

Event object.

Return values
EventResult

onBeforeUpdate()

Default onBeforeUpdate handler. Absolutely necessary.

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

Event object.

Return values
EventResult

onDelete()

Default onDelete handler. Absolutely necessary.

public static onDelete(Event $event) : void
Parameters
$event : Event

Event object.

query()

public static query() : EO_Discount_Query
Return values
EO_Discount_Query

setAllUseCoupons()

Set exist coupons flag for all discounts.

public static setAllUseCoupons(string $use) : void
Parameters
$use : string

Value for update use coupons for all discount.

setUseCoupons()

Set exist coupons flag for discount list.

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

Discount ids for update.

$use : string

Value for update use coupons.

validateCurrency()

Returns validators for CURRENCY field.

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

validateDiscountType()

Returns validators for DISCOUNT_TYPE field.

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

validateExecuteModule()

Returns validators for EXECUTE_MODULE field.

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

validateLid()

Returns validators for LID field.

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

validateName()

Returns validators for NAME field.

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

validatePresetId()

Returns validators for PRESET_ID field.

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

validateXmlId()

Returns validators for XML_ID field.

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

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Discount_Collection
Parameters
$rows : mixed
Return values
EO_Discount_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_Discount
Parameters
$row : mixed
Return values
EO_Discount

        
On this page

Search results