Bitrix API

KanbanService implements Errorable

Table of Contents

Interfaces

Errorable

Constants

ERROR_COULD_NOT_ADD_ONE_TASK  = 'TASKS_KS_05'
ERROR_COULD_NOT_ADD_TASK  = 'TASKS_KS_01'
ERROR_COULD_NOT_GET_LAST_STAGES  = 'TASKS_KS_03'
ERROR_COULD_NOT_REMOVE_TASK  = 'TASKS_KS_02'

Methods

__construct()  : mixed
addTasksToKanban()  : bool
Add the tasks to default stage of the sprint.
addTaskToFinishStatus()  : void
addTaskToNewStatus()  : void
createSprintStages()  : mixed
extractFinishedTaskIds()  : array<string|int, mixed>
generateKanbanStages()  : array<string|int, mixed>
Gets default stages or stages of last sprint for active sprint.
getDefaultStageId()  : int
getErrorByCode()  : mixed
getErrors()  : mixed
getFinishedTaskIdsInSprint()  : array<string|int, mixed>
getFinishStatus()  : string
getKanbanSortValue()  : string
getLastCompletedSprintIdSameGroup()  : int
getNewStatus()  : string
getSprintStageIds()  : array<string|int, mixed>
getStageIdsMapBetweenTwoSprints()  : array<string|int, mixed>
getStages()  : array<string|int, mixed>
getStagesToTask()  : array<string|int, mixed>
The method returns the stages for the task, depending on whether it is in the active sprint, completed sprint, or in the backlog.
getStageTitles()  : array<string|int, mixed>
getTaskEntityId()  : int
The method returns the entity id for the task.
getTaskStageId()  : int
The method returns the stage id for the task.
getUnfinishedTaskIdsInSprint()  : array<string|int, mixed>
hasDifferencesBetweenTwoSprints()  : bool
Checks if the number of columns differs between sprints.
hasSprintStages()  : bool
isTaskInFinishStatus()  : bool
isTaskInKanban()  : bool
moveTask()  : bool
removeStages()  : void
removeTasksFromKanban()  : bool
Removes the tasks of the sprint.

Constants

ERROR_COULD_NOT_ADD_ONE_TASK

public mixed ERROR_COULD_NOT_ADD_ONE_TASK = 'TASKS_KS_05'

ERROR_COULD_NOT_ADD_TASK

public mixed ERROR_COULD_NOT_ADD_TASK = 'TASKS_KS_01'

ERROR_COULD_NOT_GET_LAST_STAGES

public mixed ERROR_COULD_NOT_GET_LAST_STAGES = 'TASKS_KS_03'

ERROR_COULD_NOT_REMOVE_TASK

public mixed ERROR_COULD_NOT_REMOVE_TASK = 'TASKS_KS_02'

Methods

addTasksToKanban()

Add the tasks to default stage of the sprint.

public addTasksToKanban(int $sprintId, array<string|int, mixed> $taskIds[, int $lastSprintId = 0 ]) : bool
Parameters
$sprintId : int

Sprint id.

$taskIds : array<string|int, mixed>

List task id.

$lastSprintId : int = 0

Last sprint id only for start new sprint.

Return values
bool

addTaskToFinishStatus()

public addTaskToFinishStatus(int $sprintId, int $taskId) : void
Parameters
$sprintId : int
$taskId : int

addTaskToNewStatus()

public addTaskToNewStatus(int $sprintId, int $taskId) : void
Parameters
$sprintId : int
$taskId : int

createSprintStages()

public createSprintStages(int $sprintId[, int $lastSprintId = 0 ]) : mixed
Parameters
$sprintId : int
$lastSprintId : int = 0

extractFinishedTaskIds()

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

generateKanbanStages()

Gets default stages or stages of last sprint for active sprint.

public generateKanbanStages([int $lastSprintId = 0 ]) : array<string|int, mixed>
Parameters
$lastSprintId : int = 0

Last sprint id for copy last stages.

Return values
array<string|int, mixed>

getDefaultStageId()

public getDefaultStageId(int $sprintId) : int
Parameters
$sprintId : int
Return values
int

getErrorByCode()

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

getFinishedTaskIdsInSprint()

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

getFinishStatus()

public getFinishStatus() : string
Return values
string

getKanbanSortValue()

public getKanbanSortValue(int $groupId) : string
Parameters
$groupId : int
Return values
string

getLastCompletedSprintIdSameGroup()

public getLastCompletedSprintIdSameGroup(int $sprintId) : int
Parameters
$sprintId : int
Return values
int

getNewStatus()

public getNewStatus() : string
Return values
string

getSprintStageIds()

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

getStageIdsMapBetweenTwoSprints()

public getStageIdsMapBetweenTwoSprints(int $firstSprintId, int $secondSprintId) : array<string|int, mixed>
Parameters
$firstSprintId : int
$secondSprintId : int
Return values
array<string|int, mixed>

getStages()

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

getStagesToTask()

The method returns the stages for the task, depending on whether it is in the active sprint, completed sprint, or in the backlog.

public getStagesToTask(int $taskId) : array<string|int, mixed>
Parameters
$taskId : int

Task id.

Return values
array<string|int, mixed>

getStageTitles()

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

getTaskEntityId()

The method returns the entity id for the task.

public getTaskEntityId(int $taskId) : int
Parameters
$taskId : int

Task id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
int

getTaskStageId()

The method returns the stage id for the task.

public getTaskStageId(int $taskId) : int
Parameters
$taskId : int

Task id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
int

getUnfinishedTaskIdsInSprint()

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

hasDifferencesBetweenTwoSprints()

Checks if the number of columns differs between sprints.

public hasDifferencesBetweenTwoSprints(int $firstSprintId, int $secondSprintId) : bool
Parameters
$firstSprintId : int

First sprint id.

$secondSprintId : int

Second sprint id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

hasSprintStages()

public hasSprintStages(int $sprintId) : bool
Parameters
$sprintId : int
Return values
bool

isTaskInFinishStatus()

public isTaskInFinishStatus(int $sprintId, int $taskId) : bool
Parameters
$sprintId : int
$taskId : int
Return values
bool

isTaskInKanban()

public isTaskInKanban(int $sprintId, int $taskId) : bool
Parameters
$sprintId : int
$taskId : int
Return values
bool

moveTask()

public moveTask(int $taskId, int $stageId) : bool
Parameters
$taskId : int
$stageId : int
Return values
bool

removeStages()

public removeStages(int $sprintId) : void
Parameters
$sprintId : int

removeTasksFromKanban()

Removes the tasks of the sprint.

public removeTasksFromKanban(int $sprintId, array<string|int, mixed> $taskIds) : bool
Parameters
$sprintId : int

Sprint id.

$taskIds : array<string|int, mixed>

List task id.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results