Bitrix API

State

FinalYes

Class State Provides methods for checking product restrictions and obtaining current settings based on constraints.

Table of Contents

Methods

getCrmExceedingProductLimit()  : array<string|int, mixed>|null
Returns information about exceeding the number of goods for crm catalog.
getExceedingProductLimit()  : array<string|int, mixed>|null
Returns information about exceeding the number of goods in the landing for the information block.
getProductLimitState()  : array<string|int, mixed>|null
handlerAfterIblockElementAdd()  : void
OnAfterIBlockElementAdd event handler. Do not use directly.
handlerAfterIblockElementDelete()  : void
OnAfterIBlockElementDelete event handler. Do not use directly.
handlerAfterIblockElementUpdate()  : void
OnAfterIBlockElementUpdate event handler. Do not use directly.
handlerAfterIblockSectionAdd()  : void
OnAfterIBlockSectionAdd event handler. Do not use directly.
handlerAfterIblockSectionDelete()  : void
OnAfterIBlockSectionDelete event handler. Do not use directly.
handlerAfterIblockSectionUpdate()  : void
OnAfterIBlockSectionUpdate event handler. Do not use directly.
handlerBeforeIblockElementAdd()  : bool
OnIBlockElementAdd event handler. Do not use directly.
handlerBeforeIblockElementUpdate()  : bool
OnBeforeIBlockElementUpdate event handler. Do not use directly.
handlerBeforeIblockSectionUpdate()  : bool
OnBeforeIBlockSectionUpdate event handler. Do not use directly.
isAllowedNewPriceType()  : bool
Returns true if it is allowed to add a new price type.
isAllowedNewStore()  : bool
Returns true if it is allowed to add a new warehouse.
isEnabledInventoryManagement()  : bool
Returns true if warehouse inventory management is enabled, without feature check.
isExceededPriceTypeLimit()  : bool
Returns true if the limit on the number of price types is exceeded.
isExceededStoreLimit()  : bool
Returns true if the limit on the number of warehouses is exceeded.
isExternalCatalog()  : bool
isProductBatchMethodSelected()  : bool
Returns true if product batch method calculation is selected.
isProductCardSliderEnabled()  : bool
Returns true if product card slider option is checked.
isShowedStoreReserve()  : bool
Returns true if used store quantity reserve.
isUsedInventoryManagement()  : bool
Returns true if warehouse inventory management is allowed and enabled.
setIsExternalCatalog()  : void

Methods

getCrmExceedingProductLimit()

Returns information about exceeding the number of goods for crm catalog.

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

getExceedingProductLimit()

Returns information about exceeding the number of goods in the landing for the information block.

public static getExceedingProductLimit(int $iblockId[, int|null $sectionId = null ]) : array<string|int, mixed>|null
Parameters
$iblockId : int

Iblock Id.

$sectionId : int|null = null

Current section (can be absent).

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

getProductLimitState()

public static getProductLimitState(int $iblockId) : array<string|int, mixed>|null
Parameters
$iblockId : int
Return values
array<string|int, mixed>|null

handlerAfterIblockElementAdd()

OnAfterIBlockElementAdd event handler. Do not use directly.

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

handlerAfterIblockElementDelete()

OnAfterIBlockElementDelete event handler. Do not use directly.

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

handlerAfterIblockElementUpdate()

OnAfterIBlockElementUpdate event handler. Do not use directly.

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

handlerAfterIblockSectionAdd()

OnAfterIBlockSectionAdd event handler. Do not use directly.

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

handlerAfterIblockSectionDelete()

OnAfterIBlockSectionDelete event handler. Do not use directly.

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

handlerAfterIblockSectionUpdate()

OnAfterIBlockSectionUpdate event handler. Do not use directly.

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

handlerBeforeIblockElementAdd()

OnIBlockElementAdd event handler. Do not use directly.

public static handlerBeforeIblockElementAdd(array<string|int, mixed> &$fields) : bool
Parameters
$fields : array<string|int, mixed>
Return values
bool

handlerBeforeIblockElementUpdate()

OnBeforeIBlockElementUpdate event handler. Do not use directly.

public static handlerBeforeIblockElementUpdate(array<string|int, mixed> &$fields) : bool
Parameters
$fields : array<string|int, mixed>
Return values
bool

handlerBeforeIblockSectionUpdate()

OnBeforeIBlockSectionUpdate event handler. Do not use directly.

public static handlerBeforeIblockSectionUpdate(array<string|int, mixed> &$fields) : bool
Parameters
$fields : array<string|int, mixed>
Return values
bool

isAllowedNewPriceType()

Returns true if it is allowed to add a new price type.

public static isAllowedNewPriceType() : bool
Return values
bool

isAllowedNewStore()

Returns true if it is allowed to add a new warehouse.

public static isAllowedNewStore() : bool
Return values
bool

isEnabledInventoryManagement()

Returns true if warehouse inventory management is enabled, without feature check.

public final static isEnabledInventoryManagement() : bool
Return values
bool

isExceededPriceTypeLimit()

Returns true if the limit on the number of price types is exceeded.

public static isExceededPriceTypeLimit() : bool
Return values
bool

isExceededStoreLimit()

Returns true if the limit on the number of warehouses is exceeded.

public static isExceededStoreLimit() : bool
Return values
bool

isExternalCatalog()

public final static isExternalCatalog() : bool
Return values
bool

isProductBatchMethodSelected()

Returns true if product batch method calculation is selected.

public static isProductBatchMethodSelected() : bool
Return values
bool

isProductCardSliderEnabled()

Returns true if product card slider option is checked.

public static isProductCardSliderEnabled() : bool
Return values
bool

isShowedStoreReserve()

Returns true if used store quantity reserve.

public static isShowedStoreReserve() : bool
Return values
bool

isUsedInventoryManagement()

Returns true if warehouse inventory management is allowed and enabled.

public static isUsedInventoryManagement() : bool
Return values
bool

setIsExternalCatalog()

public final static setIsExternalCatalog(bool $isEnabled) : void
Parameters
$isEnabled : bool

        
On this page

Search results