Bitrix API

Task extends Base

Table of Contents

Constants

ERROR_REQUIRED_PARAMETER  = 'MAIN_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION  = 'MAIN_CONTROLLER_22002'
EVENT_ON_AFTER_ACTION  = 'onAfterAction'
EVENT_ON_BEFORE_ACTION  = 'onBeforeAction'
EXCEPTION_UNKNOWN_ACTION  = 22002
SCOPE_AJAX  = 'ajax'
SCOPE_CLI  = 'cli'
SCOPE_REST  = 'rest'

Methods

__construct()  : mixed
Constructor Controller.
addAction()  : array<string|int, mixed>|null
approveAction()  : array<string|int, mixed>|null
attachUploadedFilesAction()  : DiskFileDto|null
className()  : string
Returns the fully qualified name of this class.
completeAction()  : array<string|int, mixed>|null
configureActions()  : array<string|int, mixed>
convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string
Converts keys of array to camel case notation.
deferAction()  : array<string|int, mixed>|null
delegateAction()  : array<string|int, mixed>|null
disapproveAction()  : array<string|int, mixed>|null
finalizeResponse()  : void
Finalizes response.
followAction()  : array<string|int, mixed>|null
forward()  : HttpResponse|mixed
generateActionMethodName()  : string
getAction()  : array<string|int, mixed>|TaskDto
getActionUri()  : Uri
Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
getAutoWiredParameters()  : array<string|int, Parameter>
getConfigurationOfActions()  : array<string|int, mixed>|null
getCurrentUser()  : CurrentUser
getDashboardSettingsAction()  : array<string|int, mixed>
getDefaultAutoWiredParameters()  : array<string|int, Parameter>
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getFullEventName()  : string
getModuleId()  : string
Returns module id.
getPrimaryAutoWiredParameter()  : Parameter|null
getProjectDeadlineTasksAction()  : array<string|int, mixed>
getProjectKanbanTasksAction()  : array<string|int, mixed>
getProjectListTasksAction()  : array<string|int, mixed>
getProjectPlannerTasksAction()  : array<string|int, mixed>
getRequest()  : HttpRequest
getScope()  : string
getSourceParametersList()  : array<string|int, mixed>
getUnsignedParameters()  : mixed
getUserDeadlineTasksAction()  : array<string|int, mixed>
getUserListTasksAction()  : array<string|int, mixed>
getUserPlannerTasksAction()  : array<string|int, mixed>
isLocatedUnderPsr4()  : bool
listNameActions()  : array<string|int, mixed>
Returns list of all
muteAction()  : array<string|int, mixed>|null
pauseAction()  : array<string|int, mixed>|null
pauseTimerAction()  : array<string|int, mixed>|null
pinAction()  : array<string|int, mixed>|null
pingAction()  : array<string|int, mixed>|null
readAction()  : array<string|int, mixed>|null
redirectTo()  : Redirect
Redirect to URL.
removeAction()  : array<string|int, mixed>|null
renewAction()  : array<string|int, mixed>|null
run()  : HttpResponse|mixed
setCurrentUser()  : void
setScope()  : Controller
setSourceParametersList()  : Controller
startAction()  : array<string|int, mixed>|null
startTimerAction()  : array<string|int, mixed>|null
takeAction()  : array<string|int, mixed>|null
unfollowAction()  : array<string|int, mixed>|null
unmuteAction()  : array<string|int, mixed>|null
unpinAction()  : array<string|int, mixed>|null
updateAction()  : array<string|int, mixed>|null
updateDeadlineAction()  : array<string|int, mixed>|null
updateParentIdToTaskIdsAction()  : array<string|int, mixed>
updateProjectDeadlineTaskStageAction()  : bool
updateProjectKanbanTaskStageAction()  : bool
updateProjectPlannerTaskStageAction()  : bool
updateRelatedTasksAction()  : array<string|int, mixed>
updateUserDeadlineTaskStageAction()  : bool
updateUserPlannerTaskStageAction()  : bool

Constants

ERROR_REQUIRED_PARAMETER

public mixed ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION

public mixed ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'

EVENT_ON_AFTER_ACTION

public mixed EVENT_ON_AFTER_ACTION = 'onAfterAction'

EVENT_ON_BEFORE_ACTION

public mixed EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

EXCEPTION_UNKNOWN_ACTION

public mixed EXCEPTION_UNKNOWN_ACTION = 22002

Methods

__construct()

Constructor Controller.

public __construct([Request|null $request = null ]) : mixed
Parameters
$request : Request|null = null

addAction()

public addAction(array<string|int, mixed> $fields) : array<string|int, mixed>|null
Parameters
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>|null

approveAction()

public approveAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

attachUploadedFilesAction()

public attachUploadedFilesAction(int $taskId, string $fileId) : DiskFileDto|null
Parameters
$taskId : int
$fileId : string
Return values
DiskFileDto|null

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

completeAction()

public completeAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

configureActions()

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

convertKeysToCamelCase()

Converts keys of array to camel case notation.

public convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string
Parameters
$data : mixed

Data.

Tags
see
Converter::OUTPUT_JSON_FORMAT
Return values
array<string|int, mixed>|mixed|string

deferAction()

public deferAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

delegateAction()

public delegateAction(int $taskId, int $userId) : array<string|int, mixed>|null
Parameters
$taskId : int
$userId : int
Return values
array<string|int, mixed>|null

disapproveAction()

public disapproveAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

finalizeResponse()

Finalizes response.

public finalizeResponse(Response $response) : void

The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.

Parameters
$response : Response

followAction()

public followAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

forward()

public forward(Controller|string $controller, string $actionName[, array<string|int, mixed>|null $parameters = null ]) : HttpResponse|mixed
Parameters
$controller : Controller|string
$actionName : string
$parameters : array<string|int, mixed>|null = null
Tags
throws
SystemException
Return values
HttpResponse|mixed

generateActionMethodName()

public final generateActionMethodName(mixed $action) : string
Parameters
$action : mixed
Return values
string

getAction()

public getAction(int $taskId[, mixed $params = [] ]) : array<string|int, mixed>|TaskDto
Parameters
$taskId : int
$params : mixed = []
Return values
array<string|int, mixed>|TaskDto

getActionUri()

Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.

public final getActionUri(string $actionName[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri
Parameters
$actionName : string

Action name. It's a relative action name without controller name.

$params : array<string|int, mixed> = []

Parameters for creating uri.

$absolute : bool = false
Return values
Uri

getConfigurationOfActions()

public final getConfigurationOfActions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDashboardSettingsAction()

public getDashboardSettingsAction(Settings $settings[, int $projectId = 0 ][, int $ownerId = 0 ]) : array<string|int, mixed>
Parameters
$settings : Settings
$projectId : int = 0
$ownerId : int = 0
Return values
array<string|int, mixed>

getDefaultAutoWiredParameters()

public final getDefaultAutoWiredParameters() : array<string|int, Parameter>
Return values
array<string|int, Parameter>

getErrorByCode()

Getting once error with the necessary code.

public final getErrorByCode(string $code) : Error
Parameters
$code : string

Code of error.

Return values
Error

getErrors()

Getting array of errors.

public final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFullEventName()

public final static getFullEventName(mixed $eventName) : string
Parameters
$eventName : mixed
Return values
string

getModuleId()

Returns module id.

public final getModuleId() : string

Tries to guess module id by file path and function @see getModuleId().

Return values
string

getProjectDeadlineTasksAction()

public getProjectDeadlineTasksAction(TaskRequestFilter $searchParams, int $projectId[, int|null $stageId = null ][, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$projectId : int
$stageId : int|null = null
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getProjectKanbanTasksAction()

public getProjectKanbanTasksAction(TaskRequestFilter $searchParams, int $projectId[, int|null $stageId = null ][, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$projectId : int
$stageId : int|null = null
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getProjectListTasksAction()

public getProjectListTasksAction(TaskRequestFilter $searchParams, int $projectId[, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$projectId : int
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getProjectPlannerTasksAction()

public getProjectPlannerTasksAction(TaskRequestFilter $searchParams, int $projectId[, int|null $stageId = null ][, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$projectId : int
$stageId : int|null = null
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getRequest()

public final getRequest() : HttpRequest
Return values
HttpRequest

getScope()

public final getScope() : string
Return values
string

getSourceParametersList()

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

getUnsignedParameters()

public final getUnsignedParameters() : mixed

getUserDeadlineTasksAction()

public getUserDeadlineTasksAction(TaskRequestFilter $searchParams[, int|null $stageId = null ][, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$stageId : int|null = null
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getUserListTasksAction()

public getUserListTasksAction(TaskRequestFilter $searchParams[, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

getUserPlannerTasksAction()

public getUserPlannerTasksAction(TaskRequestFilter $searchParams[, int|null $stageId = null ][, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>
Parameters
$searchParams : TaskRequestFilter
$stageId : int|null = null
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$pageNavigation : PageNavigation|null = null
Return values
array<string|int, mixed>

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

listNameActions()

Returns list of all

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

muteAction()

public muteAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

pauseAction()

public pauseAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

pauseTimerAction()

public pauseTimerAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

pinAction()

public pinAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

pingAction()

public pingAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

readAction()

public readAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

removeAction()

public removeAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

renewAction()

public renewAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

run()

public final run(mixed $actionName, array<string|int, mixed> $sourceParametersList) : HttpResponse|mixed
Parameters
$actionName : mixed
$sourceParametersList : array<string|int, mixed>
Tags
throws
SystemException
Return values
HttpResponse|mixed

setSourceParametersList()

public final setSourceParametersList(array<string|int, mixed> $sourceParametersList) : Controller
Parameters
$sourceParametersList : array<string|int, mixed>
Return values
Controller

startAction()

public startAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

startTimerAction()

public startTimerAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

takeAction()

public takeAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

unfollowAction()

public unfollowAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

unmuteAction()

public unmuteAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

unpinAction()

public unpinAction(int $taskId) : array<string|int, mixed>|null
Parameters
$taskId : int
Return values
array<string|int, mixed>|null

updateAction()

public updateAction(int $taskId, array<string|int, mixed> $fields, string|null $withStageData) : array<string|int, mixed>|null
Parameters
$taskId : int
$fields : array<string|int, mixed>
$withStageData : string|null
Return values
array<string|int, mixed>|null

updateDeadlineAction()

public updateDeadlineAction(int $taskId[, string|null $deadline = null ]) : array<string|int, mixed>|null
Parameters
$taskId : int
$deadline : string|null = null
Return values
array<string|int, mixed>|null

updateParentIdToTaskIdsAction()

public updateParentIdToTaskIdsAction(int $parentId[, array<string|int, mixed> $newSubTasks = [] ][, array<string|int, mixed> $deletedSubTasks = [] ]) : array<string|int, mixed>
Parameters
$parentId : int
$newSubTasks : array<string|int, mixed> = []
$deletedSubTasks : array<string|int, mixed> = []
Return values
array<string|int, mixed>

updateProjectDeadlineTaskStageAction()

public updateProjectDeadlineTaskStageAction(int $projectId, int $id, int $stageId) : bool
Parameters
$projectId : int
$id : int
$stageId : int
Return values
bool

updateProjectKanbanTaskStageAction()

public updateProjectKanbanTaskStageAction(int $projectId, int $id, int $stageId) : bool
Parameters
$projectId : int
$id : int
$stageId : int
Return values
bool

updateProjectPlannerTaskStageAction()

public updateProjectPlannerTaskStageAction(int $projectId, int $id, int $stageId) : bool
Parameters
$projectId : int
$id : int
$stageId : int
Return values
bool

updateRelatedTasksAction()

public updateRelatedTasksAction(int $taskId[, array<string|int, mixed> $newRelatedTasks = [] ][, array<string|int, mixed> $deletedRelatedTasks = [] ]) : array<string|int, mixed>
Parameters
$taskId : int
$newRelatedTasks : array<string|int, mixed> = []
$deletedRelatedTasks : array<string|int, mixed> = []
Return values
array<string|int, mixed>

updateUserDeadlineTaskStageAction()

public updateUserDeadlineTaskStageAction(int $id, int $stageId) : bool
Parameters
$id : int
$stageId : int
Return values
bool

updateUserPlannerTaskStageAction()

public updateUserPlannerTaskStageAction(int $id, int $stageId) : bool
Parameters
$id : int
$stageId : int
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results