AirLay backend

GroupController extends ApiController
in package

Class GroupController

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$request  : Request
$user  : UserEntity
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
addDataSetAction()  : string
POST Action add DataSet to group.
addPortalAction()  : string
POST add portal to group request([ 'method' => 'POST', 'url' => '/api/v3/group/addPortal' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'portalId', 'type' => 'absint', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
addUserAction()  : string
POST Action for adding user to group.
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
createAction()  : string
POST Action for create portal group request([ 'method' => 'POST', 'url' => '/api/v3/group/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ], [ 'name' => 'cmsAccess', 'type' => 'bool', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => GroupEntity, 'code' => 0 ])
deleteUserAction()  : string
POST Action for deleting user from group.
getAction()  : string
GET Action return user organization groups.
indexAction()  : mixed
initialize()  : void
removeAction()  : string
POST Action remove group request([ 'method' => 'POST', 'url' => '/api/v3/group/remove' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
removeDataSetAction()  : string
POST remove dataSet from group request([ 'method' => 'POST', 'url' => '/api/v3/group/removeDataSet' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
removePortalAction()  : string
POST remove portal from dataSet request([ 'method' => 'POST', 'url' => '/api/v3/group/removePortal' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'portalId', 'type' => 'absint', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
setDataSetAccessMaskAction()  : string
POST set dataSet access mask request([ 'method' => 'POST', 'url' => '/api/v3/group/setDataSetAccessMask' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'accessMask', 'type' => 'absint', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
setPermissionsAction()  : string
POST set permissions request([ 'method' => 'POST', 'url' => '/api/v3/group/setPermissions' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'issues', 'type' => 'absint', 'required' => false ], [ 'name' => 'milestones', 'type' => 'absint', 'required' => false ], [ 'name' => 'brigades', 'type' => 'absint', 'required' => false ], [ 'name' => 'push', 'type' => 'absint', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
updateAction()  : string
POST Action update group request([ 'method' => 'POST', 'url' => '/api/v3/group/update' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'cmsAccess', 'type' => 'bool', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : mixed
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed

Properties

Methods

addDataSetAction()

POST Action add DataSet to group.

public addDataSetAction() : string

request([ 'method' => 'POST', 'url' => '/api/v3/group/addDataSet' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'accessMask', 'type' => 'absint', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

Tags
throws
AirlayException|Exception
Return values
string —

addPortalAction()

POST add portal to group request([ 'method' => 'POST', 'url' => '/api/v3/group/addPortal' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'portalId', 'type' => 'absint', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

addUserAction()

POST Action for adding user to group.

public addUserAction() : string

request([ 'method' => 'POST', 'url' => '/api/v3/group/addUser' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'objectId', '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 Action for create portal group request([ 'method' => 'POST', 'url' => '/api/v3/group/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ], [ 'name' => 'cmsAccess', 'type' => 'bool', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => GroupEntity, 'code' => 0 ])

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

deleteUserAction()

POST Action for deleting user from group.

public deleteUserAction() : string

request([ 'method' => 'POST', 'url' => '/api/v3/group/delete_user' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'userId', 'type' => 'objectId', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

Tags
throws
AirlayException
Return values
string —

getAction()

GET Action return user organization groups.

public getAction() : string

request([ 'method' => 'GET', 'url' => '/api/v3/group/get' 'params' => [] ) response([ 'status' => 200, 'message' => GroupEntity[], 'code' => 0 ])

Return values
string —

removeAction()

POST Action remove group request([ 'method' => 'POST', 'url' => '/api/v3/group/remove' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

removeDataSetAction()

POST remove dataSet from group request([ 'method' => 'POST', 'url' => '/api/v3/group/removeDataSet' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

removePortalAction()

POST remove portal from dataSet request([ 'method' => 'POST', 'url' => '/api/v3/group/removePortal' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'portalId', 'type' => 'absint', 'required' => true ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

setDataSetAccessMaskAction()

POST set dataSet access mask request([ 'method' => 'POST', 'url' => '/api/v3/group/setDataSetAccessMask' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'accessMask', 'type' => 'absint', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

setPermissionsAction()

POST set permissions request([ 'method' => 'POST', 'url' => '/api/v3/group/setPermissions' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'issues', 'type' => 'absint', 'required' => false ], [ 'name' => 'milestones', 'type' => 'absint', 'required' => false ], [ 'name' => 'brigades', 'type' => 'absint', 'required' => false ], [ 'name' => 'push', 'type' => 'absint', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

updateAction()

POST Action update group request([ 'method' => 'POST', 'url' => '/api/v3/group/update' 'params' => [ [ 'name' => 'groupId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'cmsAccess', 'type' => 'bool', 'required' => false ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])

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

Search results