AirLay backend

DepartmentController 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
addContactAction()  : string
Add contact to department request( 'method' => 'POST', 'url' => '/api/v3/department/addContact', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'required' => true ], [ 'name' => 'value', 'type' => 'string', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
addDatasetAction()  : string
Add dataset to department
addUserAction()  : string
Add user to department request( 'method' => 'POST', 'url' => '/api/v3/department/addUser', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
createAction()  : string
Create department request( 'method' => 'POST', 'url' => '/api/v3/department/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ], [ 'name' => 'parentId', 'type' => 'ObjectId', 'required' => true ] ] ) response([ 'status' => 200, 'message' => DepartmentEntity, 'code' => 0 ])
deleteAction()  : string
Delete department request( 'method' => 'POST', 'url' => '/api/v3/department/delete', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] )
getAction()  : string
Get departments request( 'method' => 'GET', 'url' => '/api/v3/department/get', 'params' => [] ) response([ 'status' => 200, 'message' => DepartmentEntity[], 'code' => 0 ])
indexAction()  : mixed
initialize()  : void
moveAction()  : string
Move a department to another department request( 'method' => 'POST', 'url' => '/api/v3/department/move', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Department id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'description' => 'id new parent department', 'required' => true ], [ 'name' => 'position', 'type' => 'objectId', 'description' => 'position to children list', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => OK, 'code' => 0 ] )
removeContactAction()  : string
Remove contact from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeContact', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'required' => true ], [ 'name' => 'value', 'type' => 'string', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
removeDatasetAction()  : string
Remove dataset from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeDataset', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'datasetId', 'type' => 'ObjectId', 'required' => true ] ] ) responce( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
removeUserAction()  : string
Remove user from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeUser', 'params' => [ [ 'name' => 'departmetnId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
sendMessageAction()  : string|false
send push message request( 'method' => 'POST', 'url' => '/api/v3/department/sendMessage', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Department id', 'required' => true ], [ 'name' => 'message', 'type' => 'string', 'description' => 'message', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => ObjectId[], 'code' => 0 ] )
updateAction()  : string
Update department attributes request( 'method' => 'POST', 'url' => '/api/v3/department/update', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'code', 'type' => 'string', 'required' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] )
updateFilterAction()  : string
Update filter of dataset
uploadAction()  : string
Upload organization structure form file
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : mixed
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed

Properties

Methods

addContactAction()

Add contact to department request( 'method' => 'POST', 'url' => '/api/v3/department/addContact', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'required' => true ], [ 'name' => 'value', 'type' => 'string', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )

public addContactAction() : string
Tags
throws
AirlayException
Return values
string —

addDatasetAction()

Add dataset to department

public addDatasetAction() : string
Tags
link

request( 'method' => 'POST', 'url' => '/api/v3/department/addDataset', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'datasetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'filter', 'type' => 'string', 'description' => 'Filter in accordance with the description on the link', 'required' => true ], [ 'name' => 'applyToRead', 'type' => 'bool', 'description' => 'Set apply to read flag', 'required' => false 'defaultValue' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] )
throws
AirlayException
Return values
string —

addUserAction()

Add user to department request( 'method' => 'POST', 'url' => '/api/v3/department/addUser', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )

public addUserAction() : string
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()

Create department request( 'method' => 'POST', 'url' => '/api/v3/department/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ], [ 'name' => 'parentId', 'type' => 'ObjectId', 'required' => true ] ] ) response([ 'status' => 200, 'message' => DepartmentEntity, 'code' => 0 ])

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

deleteAction()

Delete department request( 'method' => 'POST', 'url' => '/api/v3/department/delete', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] )

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

getAction()

Get departments request( 'method' => 'GET', 'url' => '/api/v3/department/get', 'params' => [] ) response([ 'status' => 200, 'message' => DepartmentEntity[], 'code' => 0 ])

public getAction() : string
Return values
string —

moveAction()

Move a department to another department request( 'method' => 'POST', 'url' => '/api/v3/department/move', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Department id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'description' => 'id new parent department', 'required' => true ], [ 'name' => 'position', 'type' => 'objectId', 'description' => 'position to children list', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => OK, 'code' => 0 ] )

public moveAction() : string
Tags
throws
AirlayException
Return values
string —

removeContactAction()

Remove contact from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeContact', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'required' => true ], [ 'name' => 'value', 'type' => 'string', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )

public removeContactAction() : string
Tags
throws
AirlayException
Return values
string —

removeDatasetAction()

Remove dataset from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeDataset', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'datasetId', 'type' => 'ObjectId', 'required' => true ] ] ) responce( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )

public removeDatasetAction() : string
Tags
throws
AirlayException
Return values
string —

removeUserAction()

Remove user from department request( 'method' => 'POST', 'url' => '/api/v3/department/removeUser', 'params' => [ [ 'name' => 'departmetnId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'ObjectId', 'required' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )

public removeUserAction() : string
Tags
throws
AirlayException
Return values
string —

sendMessageAction()

send push message request( 'method' => 'POST', 'url' => '/api/v3/department/sendMessage', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'Department id', 'required' => true ], [ 'name' => 'message', 'type' => 'string', 'description' => 'message', 'required' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => ObjectId[], 'code' => 0 ] )

public sendMessageAction() : string|false
Tags
throws
AirlayException
Return values
string|false —

updateAction()

Update department attributes request( 'method' => 'POST', 'url' => '/api/v3/department/update', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'code', 'type' => 'string', 'required' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => 'OK', 'code' => 0 ] )

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

updateFilterAction()

Update filter of dataset

public updateFilterAction() : string
Tags
link

request( 'method' => 'POST', 'url' => '/api/v3/department/updateFilter', 'params' => [ [ 'name' => 'departmentId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'datasetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'filter', 'type' => 'string', 'description' => 'Filter in accordance with the description on the link', 'required' => true ], [ 'name' => 'applyToRead', 'type' => 'bool', 'description' => 'Set apply to read flag', 'required' => false 'defaultValue' => true ] ] ) response( '200' => [ 'status' => 200, message' => 'OK', 'code' => 0 ] )
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 —

Search results