AirLay backend

MilestoneController extends ApiController
in package

Class ApiBaseController.

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$request  : Request
$user  : UserEntity
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
addCommentAction()  : string
Add new comment to milestone.
addObjectAction()  : string
Add related object.
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
createAction()  : string
POST Create milestone request([ "method" => "POST", "url" => "api/v4/milestone/create", "params" => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'Milestone name', 'required' => true ], [ 'name' => 'description', 'type' => 'string' | 'null', 'description' => 'Milestone description', 'required' => false ], [ 'name' => 'startDate', 'type' => 'int' | 'null', 'description' => 'Milestone start date', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int' | 'null', 'description' => 'Milestone end date', 'required' => false ], [ 'name' => 'status', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone status', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone dataSetId', 'required' => false ] ] ]) response([ "status" => 200, "message" => MilestoneEntity "code" => 0 ])
createByTemplateAction()  : string
POST Create milestone from request([ 'method' => 'POST', 'url' => 'api/v4/milestone/createByTemplate', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone 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' => 'MilestoneEntity' 'code' => 0 ])
createTemplateAction()  : string
POST Create milestone template, if send id create new template from exited milestone, else create new milestone template request([ 'method' => 'POST', 'url' => 'api/v4/milestone/createTemplate', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone id', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'milestone name', 'required' => false ], [ 'name' => 'description', 'type' => 'string', 'description' => 'milestone description', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'MilestoneEntity' 'code' => 0 ])
deleteAction()  : string
POST Delete milestone request([ "method" => "POST", "url" => "api/v4/milestone/delete", 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone id', 'required' => true ], [ 'name' => 'withIssues', 'type' => 'bool', 'description' => 'delete with issues flag', 'required' => false, 'default' => 'false' ] ] ]) response([ "status" => 200, "message" => Ok "code" => 0 ])
getAction()  : string
Get milestones.
getCommentsAction()  : string
Get issue comments request( 'method' => 'GET', 'url' => '/api/v4/milestone/getComments', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true, 'description' => 'Milestone 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' => array 'code' => 0 ] )
getObjectsAction()  : string
Get milestone objects.
indexAction()  : mixed
initialize()  : void
removeCommentAction()  : string
Remove comment from milestone.
removeObjectAction()  : string
Remove related object.
updateAction()  : string
POST Update milestone request([ "method" => "POST", "url" => "api/v4/milestone/update", "params" => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Milestone id', 'required' => true ], [ 'name' => 'name', 'type' => 'string' | 'null', 'description' => 'Milestone name', 'required' => false ], [ 'name' => 'description', 'type' => 'string' | 'null', 'description' => 'Milestone description', 'required' => false ], [ 'name' => 'startDate', 'type' => 'int' | 'null', 'description' => 'Milestone start date', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int' | 'null', 'description' => 'Milestone end date', 'required' => false ], [ 'name' => 'status', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone status', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone dataSetId', 'required' => false ] ] ]) response([ "status" => 200, "message" => MilestoneEntity "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
extractMilestoneFromPost()  : MilestoneEntity
getMilestoneParams()  : array<string|int, mixed>

Properties

Methods

addCommentAction()

Add new comment to milestone.

public addCommentAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/milestone/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 ])

Tags
throws
AirlayException
Return values
string

addObjectAction()

Add related object.

public addObjectAction() : string

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

Tags
throws
AirlayException
Return values
string

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()

POST Create milestone request([ "method" => "POST", "url" => "api/v4/milestone/create", "params" => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'Milestone name', 'required' => true ], [ 'name' => 'description', 'type' => 'string' | 'null', 'description' => 'Milestone description', 'required' => false ], [ 'name' => 'startDate', 'type' => 'int' | 'null', 'description' => 'Milestone start date', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int' | 'null', 'description' => 'Milestone end date', 'required' => false ], [ 'name' => 'status', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone status', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone dataSetId', 'required' => false ] ] ]) response([ "status" => 200, "message" => MilestoneEntity "code" => 0 ])

public createAction() : string
Tags
throws
AirlayException
Return values
string

createByTemplateAction()

POST Create milestone from request([ 'method' => 'POST', 'url' => 'api/v4/milestone/createByTemplate', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone 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' => 'MilestoneEntity' 'code' => 0 ])

public createByTemplateAction() : string
Tags
throws
AirlayException
Return values
string

createTemplateAction()

POST Create milestone template, if send id create new template from exited milestone, else create new milestone template request([ 'method' => 'POST', 'url' => 'api/v4/milestone/createTemplate', 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone id', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'description' => 'milestone name', 'required' => false ], [ 'name' => 'description', 'type' => 'string', 'description' => 'milestone description', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'MilestoneEntity' 'code' => 0 ])

public createTemplateAction() : string
Tags
throws
AirlayException
Return values
string

deleteAction()

POST Delete milestone request([ "method" => "POST", "url" => "api/v4/milestone/delete", 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'milestone id', 'required' => true ], [ 'name' => 'withIssues', 'type' => 'bool', 'description' => 'delete with issues flag', 'required' => false, 'default' => 'false' ] ] ]) response([ "status" => 200, "message" => Ok "code" => 0 ])

public deleteAction() : string
Tags
throws
AirlayException
Return values
string

getAction()

Get milestones.

public getAction() : string

request([ 'method' => 'GET', 'url' => '/api/v4/milestone/get', 'params' => [ [ 'name' => 'status', 'type' => 'ObjectId' | 'null', 'required' => false ], [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'isTemplate' 'type' => 'bool', 'required' => false ], [ 'name' => 'id' 'type' => 'ObjectId', 'required' => false ], [ 'name' => 'objectId' 'type' => 'ObjectId', 'required' => false ], [ 'name' => 'dataSetId' 'type' => 'ObjectId', 'required' => false ], [ 'name' => 'issueRelatedObjectId' 'type' => 'ObjectId', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' => MilestoneEntity[] 'code' => 0 ])

Tags
throws
AirlayException
Return values
string

getCommentsAction()

Get issue comments request( 'method' => 'GET', 'url' => '/api/v4/milestone/getComments', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true, 'description' => 'Milestone 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' => array 'code' => 0 ] )

public getCommentsAction() : string
Tags
throws
AirlayException
Return values
string

getObjectsAction()

Get milestone objects.

public getObjectsAction() : string

request([ 'method' => 'GET', 'url' => '/api/v4/milestone/getObjects', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => FeatureEntity[] 'code' => 0 ])

Tags
throws
AirlayException
Return values
string

removeCommentAction()

Remove comment from milestone.

public removeCommentAction() : string

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

Tags
throws
AirlayException
Return values
string

removeObjectAction()

Remove related object.

public removeObjectAction() : string

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

Tags
throws
AirlayException
Return values
string

updateAction()

POST Update milestone request([ "method" => "POST", "url" => "api/v4/milestone/update", "params" => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Milestone id', 'required' => true ], [ 'name' => 'name', 'type' => 'string' | 'null', 'description' => 'Milestone name', 'required' => false ], [ 'name' => 'description', 'type' => 'string' | 'null', 'description' => 'Milestone description', 'required' => false ], [ 'name' => 'startDate', 'type' => 'int' | 'null', 'description' => 'Milestone start date', 'required' => false ], [ 'name' => 'endDate', 'type' => 'int' | 'null', 'description' => 'Milestone end date', 'required' => false ], [ 'name' => 'status', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone status', 'required' => false ], [ 'name' => 'dataSetId', 'type' => 'ObjectId' | 'null', 'description' => 'Milestone dataSetId', 'required' => false ] ] ]) response([ "status" => 200, "message" => MilestoneEntity "code" => 0 ])

public updateAction() : string
Tags
throws
AirlayException
Return values
string

updateCommentAction()

Update comment.

public updateCommentAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/milestone/updateComment' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Comment id', 'required' => true ], [ 'name' => 'text', 'type' => 'string', 'description' => 'Comment text', 'required' => false ], [ 'name' => 'important', 'type' => 'bool', 'description' => 'important flag', '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 ])

Tags
throws
AirlayException
Return values
string

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

getTranslator()

protected getTranslator([string|null $language = null ]) : NativeArray
Parameters
$language : string|null = null
Tags
throws
Exception
Return values
NativeArray

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

getMilestoneParams()

private getMilestoneParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results