PHP Class Bitrix24\Task\Item

Inheritance: extends Bitrix24\Bitrix24Entity
Exibir arquivo Open project: mesilov/bitrix24-php-sdk

Public Methods

Method Description
add ( array $taskData ) : array add new task
approve ( $taskId ) : array Change status of task waiting for confirmation to Completed.
complete ( $taskId ) : array Change status to Completed or Supposedly completed (requires creator's attention).
defer ( $taskId ) : array Change task status to Deferred
delegate ( $taskId, $userId ) : array Delegate task to a user.
delete ( $taskId ) : array Delete task.
disapprove ( $taskId ) : array Change status of task waiting for confirmation to Pending.
getAllowedActions ( $taskId ) : array Return array of allowed task actions IDs (see PHP class constants CTaskItem).
getAllowedTaskActionsAsStrings ( $taskId ) : array Return an array whose keys are acton names (the names correspond to PHP class constants CTaskItem) and values show whether the action is allowed (true) or not allowed (false).
getData ( $taskId ) : array Return array of task data fields (TITLE, DESCRIPTION, etc.)
getDependSon ( $taskId ) : array Return array with parent task IDs
getDescription ( $taskId, $format ) : array Return task description.
getFiles ( $taskId ) : array Return array of links to files attached to the task.
getManifest ( ) : array get all methods and fields of B24 entity CTaskItem. Only for information!
isActionAllowed ( $taskId, $actionId ) : array Return true if action is allowed, else returns false.
renew ( $taskId ) : array Change status to Pending.
startExecution ( $taskId ) : array Change task status to In Progress
update ( $taskId, $taskData ) : array Update task data. The following fields may be updated. Business logic and permissions are taken into account when updating task data.

Method Details

add() public method

add new task
See link: http://dev.1c-bitrix.ru/rest_help/tasks/task/item/add.php
See link: http://dev.1c-bitrix.ru/rest_help/tasks/fields.php
public add ( array $taskData ) : array
$taskData array
return array new task ID

approve() public method

Change status of task waiting for confirmation to Completed.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/approve.php
public approve ( $taskId ) : array
$taskId integer Task ID
return array

complete() public method

Change status to Completed or Supposedly completed (requires creator's attention).
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/complete.php
public complete ( $taskId ) : array
$taskId integer Task ID
return array

defer() public method

Change task status to Deferred
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/defer.php
public defer ( $taskId ) : array
$taskId integer Task ID
return array

delegate() public method

Delegate task to a user.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/delegate.php
public delegate ( $taskId, $userId ) : array
$taskId integer Task ID
$userId integer New responsible person ID
return array

delete() public method

Delete task.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/delete.php
public delete ( $taskId ) : array
$taskId integer Task ID.
return array

disapprove() public method

Change status of task waiting for confirmation to Pending.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/disapprove.php
public disapprove ( $taskId ) : array
$taskId integer Task ID
return array

getAllowedActions() public method

Return array of allowed task actions IDs (see PHP class constants CTaskItem).
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getallowedactions.php
public getAllowedActions ( $taskId ) : array
$taskId integer Task ID.
return array

getAllowedTaskActionsAsStrings() public method

Return an array whose keys are acton names (the names correspond to PHP class constants CTaskItem) and values show whether the action is allowed (true) or not allowed (false).
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getallowedtaskactionsasstrings.php
public getAllowedTaskActionsAsStrings ( $taskId ) : array
$taskId integer Task ID.
return array

getData() public method

Return array of task data fields (TITLE, DESCRIPTION, etc.)
public getData ( $taskId ) : array
$taskId
return array

getDependSon() public method

Return array with parent task IDs
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getdependson.php
public getDependSon ( $taskId ) : array
$taskId integer Task ID.
return array

getDescription() public method

Return task description.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getdescription.php
public getDescription ( $taskId, $format ) : array
$taskId integer Task ID.
$format integer 1 (Corresponds to the PHP constant CTaskItem::DESCR_FORMAT_RAW) � description will be returned in the format it is stored in the database (HTML or BB-code), will not be sanitized; 2 (Corresponds to the PHP constant CTaskItem::DESCR_FORMAT_HTML) � description will be returned in HTML, will first be sanitized (if included in task module settings); 3 (Corresponds to the PHP constant CTaskItem::DESCR_FORMAT_PLAIN_TEXT) � description will be returned as plain text (no HTML tags).
return array

getFiles() public method

Return array of links to files attached to the task.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getfiles.php
public getFiles ( $taskId ) : array
$taskId integer Task ID.
return array

getManifest() public method

get all methods and fields of B24 entity CTaskItem. Only for information!
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/getmanifest.php
public getManifest ( ) : array
return array

isActionAllowed() public method

Return true if action is allowed, else returns false.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/isactionallowed.php
public isActionAllowed ( $taskId, $actionId ) : array
$taskId integer Task ID.
$actionId integer Validated action ID (see CTaskItem::ACTION_* constants of PHP class CTaskItem).
return array

renew() public method

Change status to Pending.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/renew.php
public renew ( $taskId ) : array
$taskId integer Task ID
return array

startExecution() public method

Change task status to In Progress
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/startexecution.php
public startExecution ( $taskId ) : array
$taskId integer Task ID
return array

update() public method

Update task data. The following fields may be updated. Business logic and permissions are taken into account when updating task data.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/item/update.php
public update ( $taskId, $taskData ) : array
$taskId integer Task ID.
$taskData array List of updated fields.
return array