Bitrix API

EntityService implements Errorable

Table of Contents

Interfaces

Errorable

Constants

ERROR_COULD_NOT_GET_LIST_READ_ENTITY  = 'TASKS_ES_04'
ERROR_COULD_NOT_GET_STORY_POINTS  = 'TASKS_ES_05'
ERROR_COULD_NOT_READ_ENTITY  = 'TASKS_ES_01'
ERROR_COULD_NOT_READ_ENTITY_IDS  = 'TASKS_ES_02'
ERROR_COULD_NOT_REMOVE_ENTITY  = 'TASKS_ES_03'

Methods

__construct()  : mixed
getCounters()  : array<string|int, mixed>
getEntityById()  : EntityForm
Returns an object with entity data by entity id.
getEntityIds()  : array<string|int, mixed>
Returns the ids of the backlog and all sprints of the group.
getErrorByCode()  : mixed
getErrors()  : mixed
getItems()  : EO_Item_Collection
getList()  : Result|null
removeEntity()  : bool
Removes entity by id.

Constants

ERROR_COULD_NOT_GET_LIST_READ_ENTITY

public mixed ERROR_COULD_NOT_GET_LIST_READ_ENTITY = 'TASKS_ES_04'

ERROR_COULD_NOT_GET_STORY_POINTS

public mixed ERROR_COULD_NOT_GET_STORY_POINTS = 'TASKS_ES_05'

ERROR_COULD_NOT_READ_ENTITY

public mixed ERROR_COULD_NOT_READ_ENTITY = 'TASKS_ES_01'

ERROR_COULD_NOT_READ_ENTITY_IDS

public mixed ERROR_COULD_NOT_READ_ENTITY_IDS = 'TASKS_ES_02'

ERROR_COULD_NOT_REMOVE_ENTITY

public mixed ERROR_COULD_NOT_REMOVE_ENTITY = 'TASKS_ES_03'

Methods

__construct()

public __construct([int $userId = 0 ]) : mixed
Parameters
$userId : int = 0

getCounters()

public getCounters(int $groupId, int $entityId, TaskService $taskService[, mixed $skipCompletedTasks = true ]) : array<string|int, mixed>
Parameters
$groupId : int
$entityId : int
$taskService : TaskService
$skipCompletedTasks : mixed = true
Return values
array<string|int, mixed>

getEntityById()

Returns an object with entity data by entity id.

public getEntityById(int $entityId) : EntityForm
Parameters
$entityId : int

Entity id.

Return values
EntityForm

getEntityIds()

Returns the ids of the backlog and all sprints of the group.

public getEntityIds(int $groupId) : array<string|int, mixed>
Parameters
$groupId : int

Group id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

getErrorByCode()

public getErrorByCode(mixed $code) : mixed
Parameters
$code : mixed

getItems()

public getItems(int $entityId) : EO_Item_Collection
Parameters
$entityId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
EO_Item_Collection

getList()

public getList([PageNavigation $nav = null ][, array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $select = [] ][, array<string|int, mixed> $order = [] ]) : Result|null
Parameters
$nav : PageNavigation = null
$filter : array<string|int, mixed> = []
$select : array<string|int, mixed> = []
$order : array<string|int, mixed> = []
Return values
Result|null

removeEntity()

Removes entity by id.

public removeEntity(int $id) : bool
Parameters
$id : int
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results