Bitrix API

Entity

FinalYes

Class Entity

Table of Contents

Methods

changeCategory()  : Result
deleteItem()  : Result
getColumns()  : array<string|int, mixed>
getCounters()  : array<string|int, mixed>
getDesktopLink()  : string
getEntityLink()  : string|null
getEntityTypeId()  : int
getEntityTypeName()  : string
getInstance()  : Entity
getList()  : array<string|int, mixed>
getSearchPresetsAndCounters()  : array<string|int, mixed>
prepare()  : Entity
prepareFilter()  : void
setControllerStrategy()  : Entity
setEntityTypeName()  : Entity
setItemPreparer()  : Entity
setPageNavigation()  : Entity
updateItemStage()  : Result

Methods

changeCategory()

public changeCategory(array<string|int, mixed> $ids, int $categoryId) : Result
Parameters
$ids : array<string|int, mixed>
$categoryId : int
Return values
Result

deleteItem()

public deleteItem(int $id[, array<string|int, mixed> $params = [] ]) : Result
Parameters
$id : int
$params : array<string|int, mixed> = []
Return values
Result

getColumns()

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

getCounters()

public getCounters(int $userId, int|null $categoryId) : array<string|int, mixed>
Parameters
$userId : int
$categoryId : int|null
Return values
array<string|int, mixed>
public getDesktopLink(int|null $categoryId) : string
Parameters
$categoryId : int|null
Return values
string
public getEntityLink() : string|null
Return values
string|null

getEntityTypeId()

public getEntityTypeId() : int
Return values
int

getEntityTypeName()

public getEntityTypeName() : string
Return values
string

getInstance()

public static getInstance(string $entityTypeName) : Entity
Parameters
$entityTypeName : string
Return values
Entity

getList()

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

getSearchPresetsAndCounters()

public getSearchPresetsAndCounters(int $userId[, int|null $currentCategoryId = null ]) : array<string|int, mixed>
Parameters
$userId : int
$currentCategoryId : int|null = null
Return values
array<string|int, mixed>

prepare()

public prepare(array<string|int, mixed> $params) : Entity
Parameters
$params : array<string|int, mixed>
Return values
Entity

setEntityTypeName()

public setEntityTypeName(string $entityTypeName) : Entity
Parameters
$entityTypeName : string
Return values
Entity

updateItemStage()

public updateItemStage(int $id, int $stageId) : Result
Parameters
$id : int
$stageId : int
Return values
Result

        
On this page

Search results