CIBlockElement extends CAllIBlockElement
Table of Contents
Constants
- WORKFLOW_STATUS_CURRENT_LOCK = 'yellow'
- WORKFLOW_STATUS_LOCK = 'red'
- WORKFLOW_STATUS_UNLOCK = 'green'
Properties
- $arFilter : mixed
- $arFilterIBlocks : mixed
- $arIBlockAllProps : mixed
- $arIBlockConvProps : mixed
- $arIBlockLongProps : mixed
- $arIBlockMultProps : mixed
- $arIBlockNumProps : mixed
- $bCatalogSort : mixed
- $bDistinct : mixed
- $bOnlyCount : mixed
- $countFrom : string|null
- $LAST_ERROR : string
- $sFrom : mixed
- $sGroupBy : mixed
- $sOrderBy : mixed
- $sSelect : mixed
- $strField : mixed
- $sWhere : mixed
Methods
- __construct() : mixed
- __GetFileContent() : mixed
- __InitFile() : mixed
- Add() : mixed
- CancelWFSetMove() : mixed
- CheckFields() : mixed
- CounterInc() : mixed
- createMnemonicCode() : string|null
- Delete() : mixed
- DeleteFile() : mixed
- DeletePropertySQL() : mixed
- generateMnemonicCode() : string|null
- GetByID() : mixed
- GetElementGroups() : mixed
- GetIBlockByID() : bool|int
- Return IBLOCK_ID for element.
- GetIBlockByIDList() : array<string|int, mixed>
- Return IBLOCK_ID for element.
- GetIBVersion() : mixed
- getLastError() : string
- GetList() : int|CIBlockResult
- List of elements.
- GetProperty() : mixed
- GetPropertyValues() : mixed
- GetPropertyValuesArray() : mixed
- getPublicElementsOrmFilter() : array<string|int, mixed>
- GetRandFunction() : mixed
- GetRealElement() : int
- GetShowedFunction() : mixed
- getUniqueMnemonicCode() : string|null
- isExistsMnemonicCode() : bool
- MkAlias() : mixed
- MkFilter() : mixed
- MkPropertyFilter() : mixed
- MkPropertyGroup() : mixed
- MkPropertyOrder() : mixed
- MkPropertySelect() : mixed
- PrepareGetList() : mixed
- prepareSql() : mixed
- RecalcSections() : mixed
- SetElementSection() : mixed
- setIblock() : void
- SetPropertyValueCode() : bool
- SetPropertyValues() : mixed
- SetPropertyValuesEx() : mixed
- SubQuery() : CIBlockElement|null
- Update() : mixed
- UpdateSearch() : mixed
- WF_CleanUpHistory() : mixed
- WF_CleanUpHistoryCopies() : mixed
- WF_GetCurrentStatus() : mixed
- WF_GetHistoryList() : CDBResult|false
- List the workflow history items.
- WF_GetLast() : mixed
- WF_GetLockStatus() : string
- Returns lock status of element (red, yellow, green)
- WF_GetSqlLimit() : mixed
- WF_GetStatusPermission() : mixed
- WF_GetStatusTitle() : mixed
- WF_IsLocked() : mixed
- WF_Lock() : void
- Locking element.
- WF_Restore() : mixed
- WF_SetMove() : mixed
- WF_UnLock() : void
- Unlock element.
Constants
WORKFLOW_STATUS_CURRENT_LOCK
public
mixed
WORKFLOW_STATUS_CURRENT_LOCK
= 'yellow'
WORKFLOW_STATUS_LOCK
public
mixed
WORKFLOW_STATUS_LOCK
= 'red'
WORKFLOW_STATUS_UNLOCK
public
mixed
WORKFLOW_STATUS_UNLOCK
= 'green'
Properties
$arFilter
public
mixed
$arFilter
$arFilterIBlocks
public
mixed
$arFilterIBlocks
= array()
$arIBlockAllProps
public
mixed
$arIBlockAllProps
= array()
$arIBlockConvProps
public
mixed
$arIBlockConvProps
= array()
$arIBlockLongProps
public
mixed
$arIBlockLongProps
= array()
$arIBlockMultProps
public
mixed
$arIBlockMultProps
= array()
$arIBlockNumProps
public
mixed
$arIBlockNumProps
= array()
$bCatalogSort
public
mixed
$bCatalogSort
$bDistinct
public
mixed
$bDistinct
$bOnlyCount
public
mixed
$bOnlyCount
$countFrom
public
string|null
$countFrom
= \null
$LAST_ERROR
public
string
$LAST_ERROR
= ''
$sFrom
public
mixed
$sFrom
$sGroupBy
public
mixed
$sGroupBy
$sOrderBy
public
mixed
$sOrderBy
$sSelect
public
mixed
$sSelect
$strField
public
mixed
$strField
$sWhere
public
mixed
$sWhere
Methods
__construct()
public
__construct() : mixed
__GetFileContent()
public
static __GetFileContent(mixed $FILE_ID) : mixed
Parameters
- $FILE_ID : mixed
__InitFile()
public
__InitFile(mixed $old_id, mixed &$arFields, mixed $fname) : mixed
Parameters
- $old_id : mixed
- $arFields : mixed
- $fname : mixed
Add()
public
Add(mixed $arFields[, mixed $bWorkFlow = false ][, mixed $bUpdateSearch = true ][, mixed $bResizePictures = false ]) : mixed
Parameters
- $arFields : mixed
- $bWorkFlow : mixed = false
- $bUpdateSearch : mixed = true
- $bResizePictures : mixed = false
CancelWFSetMove()
public
CancelWFSetMove() : mixed
CheckFields()
public
CheckFields(mixed &$arFields[, mixed $ID = false ][, mixed $bCheckDiskQuota = true ]) : mixed
Parameters
- $arFields : mixed
- $ID : mixed = false
- $bCheckDiskQuota : mixed = true
CounterInc()
public
static CounterInc(mixed $ID) : mixed
Parameters
- $ID : mixed
createMnemonicCode()
public
createMnemonicCode(array<string|int, mixed> $element[, array<string|int, mixed> $options = [] ]) : string|null
Parameters
- $element : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
string|nullDelete()
public
static Delete(mixed $ID) : mixed
Parameters
- $ID : mixed
DeleteFile()
public
static DeleteFile(mixed $FILE_ID, mixed $ELEMENT_ID[, mixed $TYPE = false ][, mixed $PARENT_ID = -1 ][, mixed $IBLOCK_ID = false ][, mixed $bCheckOnly = false ]) : mixed
Parameters
- $FILE_ID : mixed
- $ELEMENT_ID : mixed
- $TYPE : mixed = false
- $PARENT_ID : mixed = -1
- $IBLOCK_ID : mixed = false
- $bCheckOnly : mixed = false
DeletePropertySQL()
public
static DeletePropertySQL(mixed $property, mixed $iblock_element_id) : mixed
Parameters
- $property : mixed
- $iblock_element_id : mixed
generateMnemonicCode()
public
generateMnemonicCode(string $name, int $iblockId[, array<string|int, mixed> $options = [] ]) : string|null
Parameters
- $name : string
- $iblockId : int
- $options : array<string|int, mixed> = []
Return values
string|nullGetByID()
public
static GetByID(mixed $ID) : mixed
Parameters
- $ID : mixed
GetElementGroups()
public
static GetElementGroups(mixed $ID[, mixed $bElementOnly = false ][, mixed $arSelect = array() ]) : mixed
Parameters
- $ID : mixed
- $bElementOnly : mixed = false
- $arSelect : mixed = array()
GetIBlockByID()
Return IBLOCK_ID for element.
public
static GetIBlockByID(int $ID) : bool|int
Parameters
- $ID : int
-
Element id.
Return values
bool|intGetIBlockByIDList()
Return IBLOCK_ID for element.
public
static GetIBlockByIDList(array<string|int, mixed> $list) : array<string|int, mixed>
Parameters
- $list : array<string|int, mixed>
Return values
array<string|int, mixed>GetIBVersion()
public
static GetIBVersion(mixed $iblock_id) : mixed
Parameters
- $iblock_id : mixed
getLastError()
public
getLastError() : string
Return values
stringGetList()
List of elements.
public
static GetList([array<string|int, mixed> $arOrder = array("SORT" => "ASC") ][, array<string|int, mixed> $arFilter = array() ][, bool|array<string|int, mixed> $arGroupBy = false ][, bool|array<string|int, mixed> $arNavStartParams = false ][, array<string|int, mixed> $arSelectFields = array() ]) : int|CIBlockResult
Parameters
- $arOrder : array<string|int, mixed> = array("SORT" => "ASC")
- $arFilter : array<string|int, mixed> = array()
- $arGroupBy : bool|array<string|int, mixed> = false
- $arNavStartParams : bool|array<string|int, mixed> = false
- $arSelectFields : array<string|int, mixed> = array()
Return values
int|CIBlockResultGetProperty()
public
static GetProperty(mixed $IBLOCK_ID, mixed $ELEMENT_ID[, mixed $by = "sort" ][, mixed $order = "asc" ][, mixed $arFilter = array() ]) : mixed
Parameters
- $IBLOCK_ID : mixed
- $ELEMENT_ID : mixed
- $by : mixed = "sort"
- $order : mixed = "asc"
- $arFilter : mixed = array()
GetPropertyValues()
public
static GetPropertyValues(mixed $IBLOCK_ID, mixed $arElementFilter[, mixed $extMode = false ][, mixed $propertyFilter = array() ]) : mixed
Parameters
- $IBLOCK_ID : mixed
- $arElementFilter : mixed
- $extMode : mixed = false
- $propertyFilter : mixed = array()
GetPropertyValuesArray()
public
static GetPropertyValuesArray(mixed &$result, mixed $iblockID, mixed $filter[, mixed $propertyFilter = array() ][, mixed $options = array() ]) : mixed
Parameters
- $result : mixed
- $iblockID : mixed
- $filter : mixed
- $propertyFilter : mixed = array()
- $options : mixed = array()
getPublicElementsOrmFilter()
public
static getPublicElementsOrmFilter(array<string|int, mixed> $filter) : array<string|int, mixed>
Parameters
- $filter : array<string|int, mixed>
Return values
array<string|int, mixed>GetRandFunction()
public
static GetRandFunction() : mixed
GetRealElement()
public
static GetRealElement(int $ID) : int
Parameters
- $ID : int
Return values
intGetShowedFunction()
public
static GetShowedFunction() : mixed
getUniqueMnemonicCode()
public
getUniqueMnemonicCode(string $code, int|null $elementId, int $iblockId[, array<string|int, mixed> $options = [] ]) : string|null
Parameters
- $code : string
- $elementId : int|null
- $iblockId : int
- $options : array<string|int, mixed> = []
Return values
string|nullisExistsMnemonicCode()
public
isExistsMnemonicCode(string $code, int|null $elementId, int $iblockId) : bool
Parameters
- $code : string
- $elementId : int|null
- $iblockId : int
Return values
boolMkAlias()
public
MkAlias(mixed $max_alias_len, mixed $alias, mixed &$arIBlockLongProps) : mixed
Parameters
- $max_alias_len : mixed
- $alias : mixed
- $arIBlockLongProps : mixed
MkFilter()
public
MkFilter(mixed $arFilter, mixed &$arJoinProps, mixed &$arAddWhereFields[, mixed $level = 0 ][, mixed $bPropertyLeftJoin = false ]) : mixed
Parameters
- $arFilter : mixed
- $arJoinProps : mixed
- $arAddWhereFields : mixed
- $level : mixed = 0
- $bPropertyLeftJoin : mixed = false
MkPropertyFilter()
public
MkPropertyFilter(mixed $res, mixed $cOperationType, mixed $propVAL, mixed $db_prop, mixed &$arJoinProps, mixed &$arSqlSearch) : mixed
Parameters
- $res : mixed
- $cOperationType : mixed
- $propVAL : mixed
- $db_prop : mixed
- $arJoinProps : mixed
- $arSqlSearch : mixed
MkPropertyGroup()
public
MkPropertyGroup(mixed $db_prop, mixed &$arJoinProps[, mixed $bSort = false ]) : mixed
Parameters
- $db_prop : mixed
- $arJoinProps : mixed
- $bSort : mixed = false
MkPropertyOrder()
public
MkPropertyOrder(mixed $by, mixed $order, mixed $bSort, mixed $db_prop, mixed &$arJoinProps, mixed &$arSqlOrder) : mixed
Parameters
- $by : mixed
- $order : mixed
- $bSort : mixed
- $db_prop : mixed
- $arJoinProps : mixed
- $arSqlOrder : mixed
MkPropertySelect()
public
MkPropertySelect(mixed $PR_ID, mixed $db_prop, mixed &$arJoinProps, mixed $bWasGroup, mixed $sGroupBy, mixed &$sSelect[, mixed $bSort = false ]) : mixed
Parameters
- $PR_ID : mixed
- $db_prop : mixed
- $arJoinProps : mixed
- $bWasGroup : mixed
- $sGroupBy : mixed
- $sSelect : mixed
- $bSort : mixed = false
PrepareGetList()
public
PrepareGetList(mixed &$arIblockElementFields, mixed &$arJoinProps, mixed &$arSelectFields, mixed &$sSelect, mixed &$arAddSelectFields, mixed &$arFilter, mixed &$sWhere, mixed &$sSectionWhere, mixed &$arAddWhereFields, mixed &$arGroupBy, mixed &$sGroupBy, mixed &$arOrder, mixed &$arSqlOrder, mixed &$arAddOrderByFields) : mixed
Parameters
- $arIblockElementFields : mixed
- $arJoinProps : mixed
- $arSelectFields : mixed
- $sSelect : mixed
- $arAddSelectFields : mixed
- $arFilter : mixed
- $sWhere : mixed
- $sSectionWhere : mixed
- $arAddWhereFields : mixed
- $arGroupBy : mixed
- $sGroupBy : mixed
- $arOrder : mixed
- $arSqlOrder : mixed
- $arAddOrderByFields : mixed
prepareSql()
public
prepareSql([mixed $arSelectFields = array() ][, mixed $arFilter = array() ][, mixed $arGroupBy = false ][, mixed $arOrder = array("SORT" => "ASC") ]) : mixed
Parameters
- $arSelectFields : mixed = array()
- $arFilter : mixed = array()
- $arGroupBy : mixed = false
- $arOrder : mixed = array("SORT" => "ASC")
RecalcSections()
public
static RecalcSections(mixed $ID[, mixed $sectionId = null ]) : mixed
Parameters
- $ID : mixed
- $sectionId : mixed = null
SetElementSection()
public
static SetElementSection(mixed $ID, mixed $arSections[, mixed $bNew = false ][, mixed $bRightsIBlock = 0 ][, mixed $sectionId = null ]) : mixed
Parameters
- $ID : mixed
- $arSections : mixed
- $bNew : mixed = false
- $bRightsIBlock : mixed = 0
- $sectionId : mixed = null
setIblock()
public
setIblock(int|null $iblockId) : void
Parameters
- $iblockId : int|null
SetPropertyValueCode()
public
static SetPropertyValueCode(int $ELEMENT_ID, string|int $PROPERTY_CODE, mixed $PROPERTY_VALUE) : bool
Parameters
- $ELEMENT_ID : int
- $PROPERTY_CODE : string|int
- $PROPERTY_VALUE : mixed
Return values
boolSetPropertyValues()
public
static SetPropertyValues(mixed $ELEMENT_ID, mixed $IBLOCK_ID, mixed $PROPERTY_VALUES[, mixed $PROPERTY_CODE = false ]) : mixed
Parameters
- $ELEMENT_ID : mixed
- $IBLOCK_ID : mixed
- $PROPERTY_VALUES : mixed
- $PROPERTY_CODE : mixed = false
SetPropertyValuesEx()
public
static SetPropertyValuesEx(mixed $ELEMENT_ID, mixed $IBLOCK_ID, mixed $PROPERTY_VALUES[, mixed $FLAGS = [] ]) : mixed
Parameters
- $ELEMENT_ID : mixed
- $IBLOCK_ID : mixed
- $PROPERTY_VALUES : mixed
- $FLAGS : mixed = []
SubQuery()
public
static SubQuery(mixed $strField, mixed $arFilter) : CIBlockElement|null
Parameters
- $strField : mixed
- $arFilter : mixed
Return values
CIBlockElement|nullUpdate()
public
Update(mixed $ID, mixed $arFields[, mixed $bWorkFlow = false ][, mixed $bUpdateSearch = true ][, mixed $bResizePictures = false ][, mixed $bCheckDiskQuota = true ]) : mixed
Parameters
- $ID : mixed
- $arFields : mixed
- $bWorkFlow : mixed = false
- $bUpdateSearch : mixed = true
- $bResizePictures : mixed = false
- $bCheckDiskQuota : mixed = true
UpdateSearch()
public
static UpdateSearch(mixed $ID[, mixed $bOverWrite = false ]) : mixed
Parameters
- $ID : mixed
- $bOverWrite : mixed = false
WF_CleanUpHistory()
public
static WF_CleanUpHistory() : mixed
WF_CleanUpHistoryCopies()
public
static WF_CleanUpHistoryCopies([mixed $ELEMENT_ID = false ][, mixed $HISTORY_COPIES = false ]) : mixed
Parameters
- $ELEMENT_ID : mixed = false
- $HISTORY_COPIES : mixed = false
WF_GetCurrentStatus()
public
static WF_GetCurrentStatus(mixed $ELEMENT_ID, mixed &$STATUS_TITLE) : mixed
Parameters
- $ELEMENT_ID : mixed
- $STATUS_TITLE : mixed
WF_GetHistoryList()
List the workflow history items.
public
static WF_GetHistoryList(mixed $ELEMENT_ID[, mixed $by = 's_id' ][, mixed $order = 'desc' ][, mixed $arFilter = [] ]) : CDBResult|false
Parameters
- $ELEMENT_ID : mixed
- $by : mixed = 's_id'
- $order : mixed = 'desc'
- $arFilter : mixed = []
Return values
CDBResult|falseWF_GetLast()
public
static WF_GetLast(mixed $ID) : mixed
Parameters
- $ID : mixed
WF_GetLockStatus()
Returns lock status of element (red, yellow, green)
public
static WF_GetLockStatus(mixed $ID, mixed &$locked_by, mixed &$date_lock) : string
Parameters
- $ID : mixed
- $locked_by : mixed
- $date_lock : mixed
Return values
stringWF_GetSqlLimit()
public
static WF_GetSqlLimit([mixed $PS = "BE." ][, mixed $SHOW_NEW = "N" ]) : mixed
Parameters
- $PS : mixed = "BE."
- $SHOW_NEW : mixed = "N"
WF_GetStatusPermission()
public
static WF_GetStatusPermission(mixed $STATUS_ID[, mixed $ID = false ]) : mixed
Parameters
- $STATUS_ID : mixed
- $ID : mixed = false
WF_GetStatusTitle()
public
static WF_GetStatusTitle(mixed $STATUS_ID) : mixed
Parameters
- $STATUS_ID : mixed
WF_IsLocked()
public
static WF_IsLocked(mixed $ID, mixed &$locked_by, mixed &$date_lock) : mixed
Parameters
- $ID : mixed
- $locked_by : mixed
- $date_lock : mixed
WF_Lock()
Locking element.
public
static WF_Lock(mixed $lastId[, mixed $bWorkFlow = true ]) : void
Parameters
- $lastId : mixed
- $bWorkFlow : mixed = true
WF_Restore()
public
static WF_Restore(mixed $ID) : mixed
Parameters
- $ID : mixed
WF_SetMove()
public
WF_SetMove(mixed $NEW_ID[, mixed $OLD_ID = 0 ]) : mixed
Parameters
- $NEW_ID : mixed
- $OLD_ID : mixed = 0
WF_UnLock()
Unlock element.
public
static WF_UnLock(mixed $lastId[, mixed $bWorkFlow = true ]) : void
Parameters
- $lastId : mixed
- $bWorkFlow : mixed = true