BrigadeController
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
- addMemberAction() : bool|string
- Add member to brigade request([ 'method' => 'POST', 'url' => '/api/v4/brigade/addMember' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Brigade id', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'Member type, user or device', 'required' => true ], [ 'name' => 'memberId', 'type' => 'objectId', 'description' => 'Brigade member id', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Data set id for device', 'required' => true for device ] ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity 'code' => 0 ])
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- createAction() : bool|string
- Create brigade.
- deleteAction() : bool|string
- Delete brigade.
- getAction() : bool|string
- Get available brigade.
- getAvailableDepartmentsAction() : bool|string
- Get available departments.
- getAvailableUsersAction() : bool|string
- Get available users.
- getByIdAction() : bool|string
- Get brigade by id.
- getCurrentAction() : bool|string
- Get brigade by id.
- indexAction() : mixed
- initialize() : void
- removeMemberAction() : bool|string
- Remove member from brigade.
- updateAction() : bool|string
- Update brigade.
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- getBrigadeParams() : array<string|int, mixed>
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 —addMemberAction()
Add member to brigade request([ 'method' => 'POST', 'url' => '/api/v4/brigade/addMember' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Brigade id', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'Member type, user or device', 'required' => true ], [ 'name' => 'memberId', 'type' => 'objectId', 'description' => 'Brigade member id', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Data set id for device', 'required' => true for device ] ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity 'code' => 0 ])
public
addMemberAction() : bool|string
Tags
Return values
bool|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()
Create brigade.
public
createAction() : bool|string
request([ 'method' => 'POST', 'url' => '/api/v4/brigade/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'Brigade name' 'required' => true ], [ 'name' => 'departmentId', 'type' => 'objectId | null', 'description' => 'Brigade department id', 'required' => true ], [ 'name' => 'properties', 'type' => 'json', 'description' => 'Brigade properties', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity, 'code' => 0 ])
Tags
Return values
bool|string —deleteAction()
Delete brigade.
public
deleteAction() : bool|string
request([ 'method' => 'POST', 'url' => '/api/v4/brigade/delete' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Brigade id', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
Tags
Return values
bool|string —getAction()
Get available brigade.
public
getAction() : bool|string
request([ 'method' => 'GET', 'url' => '/api/v4/brigade/get' 'params' => [ [ 'name' => 'filterByDepartment', 'type' => 'bool', 'description' => 'filterByDepartmentFlag' 'required' => false ], ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity[] 'code' => 0 ])
Tags
Return values
bool|string —getAvailableDepartmentsAction()
Get available departments.
public
getAvailableDepartmentsAction() : bool|string
request([ 'method' => 'GET', 'url' => '/api/v4/brigade/getAvailableDepartments' 'params' => [ ] ]) response([ 'status' => 'OK', 'message' => DepartmentsEntity[] 'code' => 0 ])
Tags
Return values
bool|string —getAvailableUsersAction()
Get available users.
public
getAvailableUsersAction() : bool|string
request([ 'method' => 'GET', 'url' => '/api/v4/brigade/getAvailableUsers' 'params' => [ ] ]) response([ 'status' => 'OK', 'message' => UserEntity[] 'code' => 0 ])
Tags
Return values
bool|string —getByIdAction()
Get brigade by id.
public
getByIdAction() : bool|string
request([ 'method' => 'GET', 'url' => '/api/v4/brigade/getById' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Brigade id' 'required' => true ], ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity 'code' => 0 ])
Tags
Return values
bool|string —getCurrentAction()
Get brigade by id.
public
getCurrentAction() : bool|string
request([ 'method' => 'GET', 'url' => '/api/v4/brigade/getCurrent' 'params' => [ ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity[] 'code' => 0 ])
Tags
Return values
bool|string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —removeMemberAction()
Remove member from brigade.
public
removeMemberAction() : bool|string
request([ 'method' => 'POST', 'url' => '/api/v4/brigade/removeMember' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Brigade id', 'required' => true ], [ 'name' => 'memberId', 'type' => 'objectId', 'description' => 'Member id', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'OK' 'code' => 0 ])
Tags
Return values
bool|string —updateAction()
Update brigade.
public
updateAction() : bool|string
request([ 'method' => 'POST', 'url' => '/api/v4/brigade/update' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'Brigade id', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'description' => 'Brigade name', 'required' => false ], [ 'name' => 'departmentId', 'type' => 'objectId', 'description' => 'Brigade department id', 'required' => false ], [ 'name' => 'properties', 'type' => 'json', 'description' => 'Brigade properties', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' => BrigadeEntity 'code' => 0 ])
Tags
Return values
bool|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 —getBrigadeParams()
private
getBrigadeParams() : array<string|int, mixed>