AirLay backend

IssueController extends ApiController
in package

Application

Class ApiBaseController.

$config : AirlayConfig
$config : AirlayConfig
$request : Request
$user : UserEntity
$status : StatusPage|null
$tokenHandler : TokenHandler|null
__destruct() : mixed
addCommentAction() : string: Add new comment to issue.
addObserverAction() : string: Add observer request([ 'method' => 'POST', 'url' => '/api/v4/issue/addObserver' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'type', 'type' => 'string' ('user' | 'group' | 'email' | 'telegram'), 'description' => 'type of observer', 'required' => true ], [ 'name' => 'observerId', 'type' => 'objectId' when ('user' | 'group') | 'string' when ('email' | 'telegram'), 'description' => 'observers id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
addRelatedObjectAction() : string: Add related object.
addXlsxMonitoringAction() : string|false: add monitoring objects from xlsx file.
afterExecuteRoute() : mixed
beforeExecuteRoute() : mixed
createAction() : string: request([ 'method' => 'POST', 'url' => '/api/v4/issue/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'issue name', 'required' => true ], [ 'name' => 'description', 'type' => 'string', 'description' => 'issue description', 'required' => false ], [ 'name' => 'assign', 'type' => 'json', 'description' => 'Assign user or group on issue, {"type": "user"/"group"/"brigade", "id": objectId}', 'example' => "{"type": "user", "id": "6029eaec0ef871625e51c1cc"}" 'required' => false ], [ 'name' => 'priorityId', 'type' => 'objectId'|null, 'description' => 'priority id', 'required' => false ], [ 'name' => 'statusId', 'type' => 'objectId'|null, 'description' => 'status id', 'required' => false ], [ 'name' => 'milestoneId', 'type' => 'objectId'|null, 'description' => 'milestone id', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int'|null, 'description' => 'close date', 'required' => false ], [ 'name' => 'spentTime', 'type' => 'int'|null, 'description' => 'spent time', 'required' => false ], [ 'name' => 'estimatedTime', 'type' => 'int'|null, 'description' => 'estimated time', 'required' => false ], [ 'name' => 'progress', 'type' => 'int'|null, 'description' => 'percentage of issue completed', 'required' => false ], [ 'name' => 'parents', 'type' => 'ObjectId[]', 'description' => 'parent issue ids', 'required' => false ], [ 'name' => 'children', 'type' => 'ObjectId[]', 'description' => 'children issue ids', 'required' => false ], [ 'name' => 'type', 'type' => 'string', ('Common' | 'Monitoring' | 'Itinerary' | 'ObjectCollection') 'description' => 'issue type', 'required' => false ], [ 'name' => 'monitoring', 'type' => 'array|null', ['dataSetId' => ObjectId, 'departmentId' => ObjectId, 'filter' => string] 'description' => 'issue monitoring', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'data set with related objects', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity, 'code' => 0 ])
createByTemplateAction() : string: Create issue by template.
createTemplateAction() : string: Create issue template by issue.
deleteAction() : string: Delete issue request([ 'method' => 'POST', 'url' => '/api/v4/issue/delete' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
getAction() : string: Get issues request([ 'method' => 'GET', 'url' => '/api/v4/issue/get' 'params' => [ [ 'name' => 'milestoneIds', 'type' => 'ObjectId[]', 'description' => 'milestones filter', 'required' => false ], [ 'name' => 'assignIds', 'type' => 'ObjectId[]', 'description' => 'assigns filter', 'required' => false ], [ 'name' => 'observersIds', 'type' => 'ObjectId[]', 'description' => 'observers filter', 'required' => false ], [ 'name' => 'priorityIds', 'type' => 'ObjectId[]', 'description' => 'priorities filter', 'required' => false ], [ 'name' => 'statusId', 'type' => 'ObjectId|null', 'description' => 'status id', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'name starts with', 'required' => false ], [ 'name' => 'template', 'type' => 'bool', 'required' => false, 'default' => false ], [ 'name' => 'skip', 'type' => 'int', 'required' => false, 'default' => 0 ], [ 'name' => 'limit', 'type' => 'int', 'required' => false, 'default' => 10000 ], [ 'name' => 'id', 'type' => 'ObjectId', 'required' => false, 'default' => null ], [ 'name' => 'number', 'type' => 'int', 'required' => false, 'default' => null ], [ 'name' => 'ids', 'type' => 'ObjectId[]', 'required' => false, 'default' => null ], [ 'name' => 'sort', 'type' => 'string', 'required' => false, 'default' => "" ], [ 'name' => 'order', 'type' => 'string', 'required' => false, 'default' => "" ], [ 'name' => 'objectId' 'type' => 'ObjectId', 'required' => false ], [ 'name' => 'dataSetId' 'type' => 'ObjectId', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity[], 'code' => 0 ])
getCommentsAction() : string: Get issue comments request( 'method' => 'GET', 'url' => '/api/v4/issue/getComments', 'params' => [ [ 'name' => 'issueId', 'type' => 'ObjectId', 'required' => true, 'description' => 'Issue id' ], [ 'name' => 'skip', 'type' => 'int', 'required' => false, 'description' => 'Skip comments in result' ], [ 'name' => 'limit', 'type' => 'int', 'required' => false, 'description' => 'Limit comments in result' ] ] ) response( '200' => [ 'status' => 200, 'message' => CommentEntity[] 'code' => 0 ] )
getCountAction() : string
getCurrentAction() : string: Get issues of current user request([ 'method' => 'GET', 'url' => '/api/v4/issue/getCurrent' 'params' => [ [ 'name' => 'priorityIds', 'type' => 'ObjectId[]', 'description' => 'priorities filter', 'required' => false ], [ 'name' => 'statusIds', 'type' => 'ObjectId[]', 'description' => 'status filter', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'name starts with', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity[] 'code' => 0 ])
getRelationsTreeAction() : string|false: Get tree of issue objects.
indexAction() : mixed
initialize() : void
removeCommentAction() : string: Remove comment from issue.
removeObserverAction() : string: Remove observer request([ 'method' => 'POST', 'url' => '/api/v4/issue/removeObserver' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'observerId', 'type' => 'string', 'description' => 'observers id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
removeRelatedObjectAction() : string: Remove related object.
searchAction() : string: Search issues by number or name request([ 'method' => 'GET', 'url' => '/api/v4/issue/search' 'params' => [ [ 'name' => 'query', 'type' => 'string', 'description' => 'number or name of issue', 'required' => true ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ])
updateAction() : string: Update issue request([ 'method' => 'POST', 'url' => '/api/v4/issue/update' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'description' => 'issue name', 'required' => false ], [ 'name' => 'statusId', 'type' => 'objectId'|null, 'description' => 'status id', 'required' => false ], [ 'name' => 'description', 'type' => 'string', 'description' => 'issue description', 'required' => false ], [ 'name' => 'assign', 'type' => 'objectId|null', 'description' => 'Assign user or group on issue, {"type": "user"/"group/"brigade"", "id": objectId}', 'example' => "{"type": "user", "id": "6029eaec0ef871625e51c1cc"}" 'required' => false ], [ 'name' => 'priorityId', 'type' => 'objectId'|null, 'description' => 'priority id', 'required' => false ], [ 'name' => 'milestoneId', 'type' => 'objectId'|null, 'description' => 'milestone id', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int'|null, 'description' => 'close date', 'required' => false ], [ 'name' => 'spentTime', 'type' => 'int'|null, 'description' => 'spent time', 'required' => false ], [ 'name' => 'estimatedTime', 'type' => 'int'|null, 'description' => 'estimated time', 'required' => false ], [ 'name' => 'progress', 'type' => 'int'|null, 'description' => 'percentage of issue completed', 'required' => false ], [ 'name' => 'parents', 'type' => 'ObjectId[]', 'description' => 'parent issue ids', 'required' => false ], [ 'name' => 'children', 'type' => 'ObjectId[]', 'description' => 'children issue ids', 'required' => false ], [ 'name' => 'type', 'type' => 'string', ('Common' | 'Monitoring' | 'Itinerary' | 'ObjectCollection') 'description' => 'issue type', 'required' => false ], [ 'name' => 'monitoring', 'type' => 'array|null', ['dataSetId' => ObjectId, 'departmentId' => ObjectId, 'filter' => string] 'description' => 'issue monitoring', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'data set with related objects', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity, 'code' => 0 ])
updateCommentAction() : string: Update comment.
attachTmpFile() : Response
firesAnRelationUpdateEvents() : void
getId() : mixed
getNormalizedUserId() : int|ObjectId
getTranslator() : NativeArray
getUserInfo() : UserEntity
secureData() : mixed
sendEmail() : mixed
deleteCommentFilesAndImages() : void
extractComment() : CommentEntity
extractIssueFromRequest() : IssueEntity
fireUpdateIssuesEvent() : void
getIssueParams() : array<string|int, mixed>
getSharedFilterFields() : array<string|int, mixed>
makeImagePreview() : void
sanitizeObject() : array<string|int, mixed>|null
updateMileStone() : void

$config


    public
        AirlayConfig
    $config

$config


    public
        AirlayConfig
    $config

$request


    public
        Request
    $request

$user


    public
        UserEntity
    $user

$status


    protected
        StatusPage|null
    $status

$tokenHandler


    protected
        TokenHandler|null
    $tokenHandler

__destruct()


    public
                __destruct() : mixed

Return values

mixed —

addCommentAction()

Add new comment to issue.


    public
                addCommentAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/addComment' 'params' => [ [ 'name' => 'text', 'type' => 'string', 'description' => 'comments text', 'required' => false ], [ 'name' => 'files', 'type' => 'string[]', 'description' => 'urls of files', 'required' => false ], [ 'name' => 'images', 'type' => 'json', 'description' => 'list of images', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'CommentEntity', 'code' => 0 ])

Return values

string —

addObserverAction()

Add observer request([ 'method' => 'POST', 'url' => '/api/v4/issue/addObserver' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'type', 'type' => 'string' ('user' | 'group' | 'email' | 'telegram'), 'description' => 'type of observer', 'required' => true ], [ 'name' => 'observerId', 'type' => 'objectId' when ('user' | 'group') | 'string' when ('email' | 'telegram'), 'description' => 'observers id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])


    public
                addObserverAction() : string

Return values

string —

addRelatedObjectAction()

Add related object.


    public
                addRelatedObjectAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/addRelatedObject' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'relatedObjectId', 'type' => 'objectId', 'description' => 'related object id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

Return values

string —

addXlsxMonitoringAction()

add monitoring objects from xlsx file.


    public
                addXlsxMonitoringAction() : string|false

request([ 'method' => 'POST', 'url' => '/api/v4/issue/addXlsxMonitoring' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'dataSet id', 'required' => true ], [ 'name' => 'file', 'type' => 'xlsx file', 'description' => 'xlsx file', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'IssueEntity', 'code' => 0 ])

Return values

string|false —

afterExecuteRoute()


    public
                afterExecuteRoute(Dispatcher $dispatcher) : mixed

Parameters

$dispatcher : Dispatcher

Return values

mixed —

beforeExecuteRoute()


    public
                beforeExecuteRoute(Dispatcher $dispatcher) : mixed

Parameters

$dispatcher : Dispatcher

Return values

mixed —

createAction()

request([ 'method' => 'POST', 'url' => '/api/v4/issue/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'issue name', 'required' => true ], [ 'name' => 'description', 'type' => 'string', 'description' => 'issue description', 'required' => false ], [ 'name' => 'assign', 'type' => 'json', 'description' => 'Assign user or group on issue, {"type": "user"/"group"/"brigade", "id": objectId}', 'example' => "{"type": "user", "id": "6029eaec0ef871625e51c1cc"}" 'required' => false ], [ 'name' => 'priorityId', 'type' => 'objectId'|null, 'description' => 'priority id', 'required' => false ], [ 'name' => 'statusId', 'type' => 'objectId'|null, 'description' => 'status id', 'required' => false ], [ 'name' => 'milestoneId', 'type' => 'objectId'|null, 'description' => 'milestone id', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int'|null, 'description' => 'close date', 'required' => false ], [ 'name' => 'spentTime', 'type' => 'int'|null, 'description' => 'spent time', 'required' => false ], [ 'name' => 'estimatedTime', 'type' => 'int'|null, 'description' => 'estimated time', 'required' => false ], [ 'name' => 'progress', 'type' => 'int'|null, 'description' => 'percentage of issue completed', 'required' => false ], [ 'name' => 'parents', 'type' => 'ObjectId[]', 'description' => 'parent issue ids', 'required' => false ], [ 'name' => 'children', 'type' => 'ObjectId[]', 'description' => 'children issue ids', 'required' => false ], [ 'name' => 'type', 'type' => 'string', ('Common' | 'Monitoring' | 'Itinerary' | 'ObjectCollection') 'description' => 'issue type', 'required' => false ], [ 'name' => 'monitoring', 'type' => 'array|null', ['dataSetId' => ObjectId, 'departmentId' => ObjectId, 'filter' => string] 'description' => 'issue monitoring', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'data set with related objects', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity, 'code' => 0 ])


    public
                createAction() : string

Return values

string —

createByTemplateAction()

Create issue by template.


    public
                createByTemplateAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/createByTemplate' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue template id', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'dataSet id', 'required' => false ], [ 'name' => 'objectId', 'type' => 'objectId', 'description' => 'object id', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'IssueEntity', 'code' => 0 ])

Return values

string —

createTemplateAction()

Create issue template by issue.


    public
                createTemplateAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/createTemplate' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true (if create from id) ], [ 'if create not from id params same as createAction' ] ] ]) response([ 'status' => 200, 'message' => 'IssueEntity', 'code' => 0 ])

Return values

string —

deleteAction()

Delete issue request([ 'method' => 'POST', 'url' => '/api/v4/issue/delete' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])


    public
                deleteAction() : string

Return values

string —

getAction()

Get issues request([ 'method' => 'GET', 'url' => '/api/v4/issue/get' 'params' => [ [ 'name' => 'milestoneIds', 'type' => 'ObjectId[]', 'description' => 'milestones filter', 'required' => false ], [ 'name' => 'assignIds', 'type' => 'ObjectId[]', 'description' => 'assigns filter', 'required' => false ], [ 'name' => 'observersIds', 'type' => 'ObjectId[]', 'description' => 'observers filter', 'required' => false ], [ 'name' => 'priorityIds', 'type' => 'ObjectId[]', 'description' => 'priorities filter', 'required' => false ], [ 'name' => 'statusId', 'type' => 'ObjectId|null', 'description' => 'status id', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'name starts with', 'required' => false ], [ 'name' => 'template', 'type' => 'bool', 'required' => false, 'default' => false ], [ 'name' => 'skip', 'type' => 'int', 'required' => false, 'default' => 0 ], [ 'name' => 'limit', 'type' => 'int', 'required' => false, 'default' => 10000 ], [ 'name' => 'id', 'type' => 'ObjectId', 'required' => false, 'default' => null ], [ 'name' => 'number', 'type' => 'int', 'required' => false, 'default' => null ], [ 'name' => 'ids', 'type' => 'ObjectId[]', 'required' => false, 'default' => null ], [ 'name' => 'sort', 'type' => 'string', 'required' => false, 'default' => "" ], [ 'name' => 'order', 'type' => 'string', 'required' => false, 'default' => "" ], [ 'name' => 'objectId' 'type' => 'ObjectId', 'required' => false ], [ 'name' => 'dataSetId' 'type' => 'ObjectId', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity[], 'code' => 0 ])


    public
                getAction() : string

Return values

string —

getCommentsAction()

Get issue comments request( 'method' => 'GET', 'url' => '/api/v4/issue/getComments', 'params' => [ [ 'name' => 'issueId', 'type' => 'ObjectId', 'required' => true, 'description' => 'Issue id' ], [ 'name' => 'skip', 'type' => 'int', 'required' => false, 'description' => 'Skip comments in result' ], [ 'name' => 'limit', 'type' => 'int', 'required' => false, 'description' => 'Limit comments in result' ] ] ) response( '200' => [ 'status' => 200, 'message' => CommentEntity[] 'code' => 0 ] )


    public
                getCommentsAction() : string

Return values

string —

getCountAction()


    public
                getCountAction() : string

Return values

string —

getCurrentAction()

Get issues of current user request([ 'method' => 'GET', 'url' => '/api/v4/issue/getCurrent' 'params' => [ [ 'name' => 'priorityIds', 'type' => 'ObjectId[]', 'description' => 'priorities filter', 'required' => false ], [ 'name' => 'statusIds', 'type' => 'ObjectId[]', 'description' => 'status filter', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'name starts with', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity[] 'code' => 0 ])


    public
                getCurrentAction() : string

Return values

string —

getRelationsTreeAction()

Get tree of issue objects.


    public
                getRelationsTreeAction() : string|false

request([ 'method' => 'GET', 'url' => '/api/v4/issue/getRelationsTree' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'withGeometry', 'type' => 'bool', 'description' => 'flag for get geometry in objects', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'tree of related objects', 'code' => 0 ])

Return values

string|false —

indexAction()


    public
                indexAction() : mixed

Return values

mixed —

initialize()


    public
                initialize() : void

Return values

void —

removeCommentAction()

Remove comment from issue.


    public
                removeCommentAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/removeComment' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Comment id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])

Return values

string —

removeObserverAction()

Remove observer request([ 'method' => 'POST', 'url' => '/api/v4/issue/removeObserver' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'observerId', 'type' => 'string', 'description' => 'observers id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])


    public
                removeObserverAction() : string

Return values

string —

removeRelatedObjectAction()

Remove related object.


    public
                removeRelatedObjectAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/removeRelatedObject' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'relatedObjectId', 'type' => 'objectId', 'description' => 'related object id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

Return values

string —

searchAction()

Search issues by number or name request([ 'method' => 'GET', 'url' => '/api/v4/issue/search' 'params' => [ [ 'name' => 'query', 'type' => 'string', 'description' => 'number or name of issue', 'required' => true ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ])


    public
                searchAction() : string

Return values

string —

updateAction()

Update issue request([ 'method' => 'POST', 'url' => '/api/v4/issue/update' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'issue id', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'description' => 'issue name', 'required' => false ], [ 'name' => 'statusId', 'type' => 'objectId'|null, 'description' => 'status id', 'required' => false ], [ 'name' => 'description', 'type' => 'string', 'description' => 'issue description', 'required' => false ], [ 'name' => 'assign', 'type' => 'objectId|null', 'description' => 'Assign user or group on issue, {"type": "user"/"group/"brigade"", "id": objectId}', 'example' => "{"type": "user", "id": "6029eaec0ef871625e51c1cc"}" 'required' => false ], [ 'name' => 'priorityId', 'type' => 'objectId'|null, 'description' => 'priority id', 'required' => false ], [ 'name' => 'milestoneId', 'type' => 'objectId'|null, 'description' => 'milestone id', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int'|null, 'description' => 'close date', 'required' => false ], [ 'name' => 'spentTime', 'type' => 'int'|null, 'description' => 'spent time', 'required' => false ], [ 'name' => 'estimatedTime', 'type' => 'int'|null, 'description' => 'estimated time', 'required' => false ], [ 'name' => 'progress', 'type' => 'int'|null, 'description' => 'percentage of issue completed', 'required' => false ], [ 'name' => 'parents', 'type' => 'ObjectId[]', 'description' => 'parent issue ids', 'required' => false ], [ 'name' => 'children', 'type' => 'ObjectId[]', 'description' => 'children issue ids', 'required' => false ], [ 'name' => 'type', 'type' => 'string', ('Common' | 'Monitoring' | 'Itinerary' | 'ObjectCollection') 'description' => 'issue type', 'required' => false ], [ 'name' => 'monitoring', 'type' => 'array|null', ['dataSetId' => ObjectId, 'departmentId' => ObjectId, 'filter' => string] 'description' => 'issue monitoring', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'data set with related objects', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => IssueEntity, 'code' => 0 ])


    public
                updateAction() : string

Return values

string —

updateCommentAction()

Update comment.


    public
                updateCommentAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/issue/updateComment' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Comment id', 'required' => true ], [ 'name' => 'text', 'type' => 'string', 'description' => 'Comment text', 'required' => false ], [ 'name' => 'images', 'type' => 'json', 'description' => 'list of images', 'required' => false ], [ 'name' => 'files', 'type' => 'string[]', 'description' => 'list of urls', 'required' => false ], [ 'name' => 'important', 'type' => 'bool', 'description' => 'important flag', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'CommentEntity', 'code' => 0 ])

Return values

string —

attachTmpFile()


    protected
                attachTmpFile(TmpFile $tmpFile) : Response

Parameters

$tmpFile : TmpFile

Return values

Response —

firesAnRelationUpdateEvents()


    protected
                firesAnRelationUpdateEvents(array<string|int, mixed> $relations, ObjectId $dataSetId[, DataSetLogEntity|null $log = null ]) : void

Parameters

$relations : array<string|int, mixed>
$dataSetId : ObjectId
$log : DataSetLogEntity|null = null

Return values

void —

getId()


    protected
                getId() : mixed

Return values

mixed —

getNormalizedUserId()


    protected
                getNormalizedUserId() : int|ObjectId

Return values

int|ObjectId —

getTranslator()


    protected
                getTranslator([string|null $language = null ]) : NativeArray

Parameters

$language : string|null = null

Return values

NativeArray —

getUserInfo()


    protected
                getUserInfo() : UserEntity

Return values

UserEntity —

secureData()


    protected
                secureData(mixed $data) : mixed

Parameters

$data : mixed

Return values

mixed —

sendEmail()


    protected
                sendEmail(string $email, string $name, string $subject, string $body) : mixed

Parameters

$email : string
$name : string
$subject : string
$body : string

Return values

mixed —

deleteCommentFilesAndImages()


    private
                deleteCommentFilesAndImages(CommentEntity $comment) : void

Parameters

$comment : CommentEntity

Return values

void —

extractComment()


    private
                extractComment() : CommentEntity

Return values

CommentEntity —

extractIssueFromRequest()


    private
                extractIssueFromRequest() : IssueEntity

Return values

IssueEntity —

fireUpdateIssuesEvent()


    private
                fireUpdateIssuesEvent(IssueEntity $issue, string $operation) : void

Parameters

$issue : IssueEntity
$operation : string

Return values

void —

getIssueParams()


    private
                getIssueParams() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getSharedFilterFields()


    private
                getSharedFilterFields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

makeImagePreview()


    private
                makeImagePreview(mixed $pathMain, mixed $pathPreview) : void

Parameters

$pathMain : mixed
$pathPreview : mixed

Return values

void —

sanitizeObject()


    private
                sanitizeObject(array<string|int, mixed> $object, mixed $filters) : array<string|int, mixed>|null

Parameters

$object : array<string|int, mixed>
$filters : mixed

Return values

array<string|int, mixed>|null —

updateMileStone()


    private
                updateMileStone(IssueEntity $issue, array<string|int, mixed> $info) : void

Parameters

$issue : IssueEntity
$info : array<string|int, mixed>

Return values

void —

IssueController extends ApiController in package Application

Table of Contents

Properties

$config

$config

$request

$user

$status

$tokenHandler

Methods

__destruct()

Return values

addCommentAction()

Tags

Return values

addObserverAction()

Tags

Return values

addRelatedObjectAction()

Tags

Return values

addXlsxMonitoringAction()

Tags

Return values

afterExecuteRoute()

Parameters

Return values

beforeExecuteRoute()

Parameters

Return values

createAction()

Tags

Return values

createByTemplateAction()

Tags

Return values

createTemplateAction()

Tags

Return values

deleteAction()

Tags

Return values

getAction()

Tags

Return values

getCommentsAction()

Tags

Return values

getCountAction()

Return values

getCurrentAction()

Return values

getRelationsTreeAction()

Tags

Return values

indexAction()

Return values

initialize()

Return values

removeCommentAction()

Tags

Return values

removeObserverAction()

Tags

Return values

removeRelatedObjectAction()

Tags

Return values

searchAction()

Tags

Return values

updateAction()

Tags

Return values

updateCommentAction()

Tags

Return values

attachTmpFile()

Parameters

Return values

IssueController extends ApiController
in package

Application