LabelController
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
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- createAction() : string
- Create label request([ 'method' => 'POST', 'url' => '/api/v4/label/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'label name', 'required' => true ], [ 'name' => 'color', 'type' => 'string', 'description' => 'label color', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'label type', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => LabelEntity, 'code' => 0 ])
- deleteAction() : string
- Delete label request([ 'method' => 'POST', 'url' => '/api/v4/label/delete' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'label id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
- getAction() : string
- Get labels request([ 'method' => 'GET', 'url' => '/api/v4/label/get' 'params' => [ [ 'name' => 'type', 'type' => 'string', 'description' => 'label type', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => LabelsEntity[], 'code' => 0 ])
- indexAction() : mixed
- initialize() : void
- updateAction() : string
- Update label request([ 'method' => 'POST', 'url' => '/api/v4/label/update' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'label id', 'required' => true ], [ 'name' => 'name', 'type' => 'string'|null, 'description' => 'label name', 'required' => false ], [ 'name' => 'color', 'type' => 'string'|null, 'description' => 'label color', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => LabelEntity, 'code' => 0 ])
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- extractLabel() : LabelEntity
Properties
$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
Methods
__destruct()
public
__destruct() : mixed
Return values
mixed —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()
Create label request([ 'method' => 'POST', 'url' => '/api/v4/label/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'label name', 'required' => true ], [ 'name' => 'color', 'type' => 'string', 'description' => 'label color', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'label type', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => LabelEntity, 'code' => 0 ])
public
createAction() : string
Tags
Return values
string —deleteAction()
Delete label request([ 'method' => 'POST', 'url' => '/api/v4/label/delete' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'label id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
public
deleteAction() : string
Tags
Return values
string —getAction()
Get labels request([ 'method' => 'GET', 'url' => '/api/v4/label/get' 'params' => [ [ 'name' => 'type', 'type' => 'string', 'description' => 'label type', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => LabelsEntity[], 'code' => 0 ])
public
getAction() : string
Tags
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —updateAction()
Update label request([ 'method' => 'POST', 'url' => '/api/v4/label/update' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'label id', 'required' => true ], [ 'name' => 'name', 'type' => 'string'|null, 'description' => 'label name', 'required' => false ], [ 'name' => 'color', 'type' => 'string'|null, 'description' => 'label color', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => LabelEntity, 'code' => 0 ])
public
updateAction() : string
Tags
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
Tags
Return values
int|ObjectId —getTranslator()
protected
getTranslator([string|null $language = null ]) : NativeArray
Parameters
- $language : string|null = null
Tags
Return values
NativeArray —getUserInfo()
protected
getUserInfo() : UserEntity
Tags
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 —extractLabel()
private
extractLabel(ObjectId|null $id, UserEntity $user) : LabelEntity
Parameters
- $id : ObjectId|null
- $user : UserEntity