Bitrix API

ItemService implements Errorable

Table of Contents

Interfaces

Errorable

Constants

ERROR_COULD_NOT_ADD_ITEM  = 'TASKS_IS_01'
ERROR_COULD_NOT_CLEAN_ITEMS_TYPE_ID  = 'TASKS_IS_15'
ERROR_COULD_NOT_GET_LIST  = 'ITEM_LIST_01'
ERROR_COULD_NOT_MOVE_ITEM  = 'TASKS_IS_09'
ERROR_COULD_NOT_READ_ALL_ITEMS  = 'TASKS_IS_13'
ERROR_COULD_NOT_READ_ITEM  = 'TASKS_IS_03'
ERROR_COULD_NOT_READ_ITEM_BY_TYPE_ID  = 'TASKS_IS_14'
ERROR_COULD_NOT_READ_ITEM_INFO  = 'TASKS_IS_11'
ERROR_COULD_NOT_REMOVE_ITEM  = 'TASKS_IS_04'
ERROR_COULD_NOT_UPDATE_ITEM  = 'TASKS_IS_02'
ERROR_COULD_NOT_UPDATE_ITEMS_ENTITY  = 'TASKS_IS_12'

Methods

__construct()  : mixed
changeItem()  : bool
cleanTypeIdToItems()  : void
createTaskItem()  : ItemForm
getErrorByCode()  : mixed
getErrors()  : mixed
getItemById()  : ItemForm
getItemBySourceId()  : ItemForm
getItemData()  : array<string|int, mixed>
The method returns an array of data in the required format for the client app.
getItemIdsByEntityId()  : array<string|int, mixed>
getItemIdsBySourceIds()  : array<string|int, mixed>
getItemIdsByTypeId()  : array<string|int, mixed>
getItemsByIds()  : array<string|int, ItemForm>
getItemsBySourceIds()  : array<string|int, ItemForm>
getItemsData()  : array<string|int, mixed>
The method returns an array of data in the required format for the client app.
getItemsInfoBySourceIds()  : array<string|int, ItemInfo>
getItemsStoryPointsBySourceId()  : array<string|int, mixed>
getList()  : Result|null
getSumStoryPointsBySourceIds()  : float
getTaskIdByItemId()  : int
getTaskIdsByEntityId()  : array<string|int, mixed>
The method returns task ids from active items.
getTaskIdsByEpicId()  : array<string|int, mixed>
getTaskItemsByEntityId()  : array<string|int, ItemForm>
The method returns active items by entity id.
moveItemsToEntity()  : void
Moves up the items in entity.
removeItem()  : bool
sortItems()  : void
updateEntityIdToItems()  : void

Constants

ERROR_COULD_NOT_ADD_ITEM

public mixed ERROR_COULD_NOT_ADD_ITEM = 'TASKS_IS_01'

ERROR_COULD_NOT_CLEAN_ITEMS_TYPE_ID

public mixed ERROR_COULD_NOT_CLEAN_ITEMS_TYPE_ID = 'TASKS_IS_15'

ERROR_COULD_NOT_GET_LIST

public mixed ERROR_COULD_NOT_GET_LIST = 'ITEM_LIST_01'

ERROR_COULD_NOT_MOVE_ITEM

public mixed ERROR_COULD_NOT_MOVE_ITEM = 'TASKS_IS_09'

ERROR_COULD_NOT_READ_ALL_ITEMS

public mixed ERROR_COULD_NOT_READ_ALL_ITEMS = 'TASKS_IS_13'

ERROR_COULD_NOT_READ_ITEM

public mixed ERROR_COULD_NOT_READ_ITEM = 'TASKS_IS_03'

ERROR_COULD_NOT_READ_ITEM_BY_TYPE_ID

public mixed ERROR_COULD_NOT_READ_ITEM_BY_TYPE_ID = 'TASKS_IS_14'

ERROR_COULD_NOT_READ_ITEM_INFO

public mixed ERROR_COULD_NOT_READ_ITEM_INFO = 'TASKS_IS_11'

ERROR_COULD_NOT_REMOVE_ITEM

public mixed ERROR_COULD_NOT_REMOVE_ITEM = 'TASKS_IS_04'

ERROR_COULD_NOT_UPDATE_ITEM

public mixed ERROR_COULD_NOT_UPDATE_ITEM = 'TASKS_IS_02'

ERROR_COULD_NOT_UPDATE_ITEMS_ENTITY

public mixed ERROR_COULD_NOT_UPDATE_ITEMS_ENTITY = 'TASKS_IS_12'

Methods

__construct()

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

cleanTypeIdToItems()

public cleanTypeIdToItems(array<string|int, mixed> $itemIds) : void
Parameters
$itemIds : array<string|int, mixed>

getErrorByCode()

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

getItemData()

The method returns an array of data in the required format for the client app.

public getItemData(ItemForm $item) : array<string|int, mixed>
Parameters
$item : ItemForm

Data object.

Return values
array<string|int, mixed>

getItemIdsByEntityId()

public getItemIdsByEntityId(int $entityId) : array<string|int, mixed>
Parameters
$entityId : int
Return values
array<string|int, mixed>

getItemIdsBySourceIds()

public getItemIdsBySourceIds(array<string|int, mixed> $sourceIds[, array<string|int, mixed> $entityIds = [] ]) : array<string|int, mixed>
Parameters
$sourceIds : array<string|int, mixed>
$entityIds : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getItemIdsByTypeId()

public getItemIdsByTypeId(int $typeId) : array<string|int, mixed>
Parameters
$typeId : int
Return values
array<string|int, mixed>

getItemsByIds()

public getItemsByIds(array<string|int, mixed> $itemIds) : array<string|int, ItemForm>
Parameters
$itemIds : array<string|int, mixed>

Item ids.

Return values
array<string|int, ItemForm>

getItemsBySourceIds()

public getItemsBySourceIds(array<string|int, mixed> $sourceIds) : array<string|int, ItemForm>
Parameters
$sourceIds : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, ItemForm>

getItemsData()

The method returns an array of data in the required format for the client app.

public getItemsData(array<string|int, ItemForm> $items) : array<string|int, mixed>
Parameters
$items : array<string|int, ItemForm>

Items.

Return values
array<string|int, mixed>

getItemsInfoBySourceIds()

public getItemsInfoBySourceIds(array<string|int, mixed> $sourceIds) : array<string|int, ItemInfo>
Parameters
$sourceIds : array<string|int, mixed>
Return values
array<string|int, ItemInfo>

getItemsStoryPointsBySourceId()

public getItemsStoryPointsBySourceId(array<string|int, mixed> $sourceIds) : array<string|int, mixed>
Parameters
$sourceIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getList()

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

getSumStoryPointsBySourceIds()

public getSumStoryPointsBySourceIds(array<string|int, mixed> $sourceIds) : float
Parameters
$sourceIds : array<string|int, mixed>
Return values
float

getTaskIdByItemId()

public getTaskIdByItemId(int $itemId) : int
Parameters
$itemId : int
Return values
int

getTaskIdsByEntityId()

The method returns task ids from active items.

public getTaskIdsByEntityId(int $entityId) : array<string|int, mixed>
Parameters
$entityId : int

Entity id.

Return values
array<string|int, mixed>

getTaskIdsByEpicId()

public getTaskIdsByEpicId(int $epicId) : array<string|int, mixed>
Parameters
$epicId : int
Return values
array<string|int, mixed>

getTaskItemsByEntityId()

The method returns active items by entity id.

public getTaskItemsByEntityId(int $entityId) : array<string|int, ItemForm>
Parameters
$entityId : int

Entity id.

Return values
array<string|int, ItemForm>

moveItemsToEntity()

Moves up the items in entity.

public moveItemsToEntity(array<string|int, mixed> $itemIds, int $entityId[, PushService|null $pushService = null ]) : void
Parameters
$itemIds : array<string|int, mixed>

Items list id.

$entityId : int

Entity id.

$pushService : PushService|null = null

For push.

sortItems()

public sortItems(array<string|int, mixed> $sortInfo[, PushService $pushService = null ]) : void
Parameters
$sortInfo : array<string|int, mixed>
$pushService : PushService = null

updateEntityIdToItems()

public updateEntityIdToItems(int $entityId, array<string|int, mixed> $itemIds) : void
Parameters
$entityId : int
$itemIds : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results