RelationsController
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 relation to relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/addMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'childId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- getParentsAction() : bool|string
- Get relation parents request([ 'method' => 'GET', 'url' => '/api/v3/relations/getParents' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'relationId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => [ [ 'parent' => RelationEntity, 'children' => RelationEntity[] ], ... ], 'code' => 0 ])
- indexAction() : mixed
- initialize() : void
- removeMemberAction() : bool|string
- Remove member from relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/removeMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'childId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
- replaceMemberAction() : bool|string
- Replace members to relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/replaceMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'replacerId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'replaceableId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
- addLog() : DataSetLogEntity
- attachTmpFile() : Response
- extractDataSetFromRequest() : DataSetEntity
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- rebuildGeometry() : void
- secureData() : mixed
- sendEmail() : 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 relation to relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/addMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'childId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', '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 —getParentsAction()
Get relation parents request([ 'method' => 'GET', 'url' => '/api/v3/relations/getParents' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'relationId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => [ [ 'parent' => RelationEntity, 'children' => RelationEntity[] ], ... ], 'code' => 0 ])
public
getParentsAction() : bool|string
Tags
Return values
bool|string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —removeMemberAction()
Remove member from relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/removeMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'childId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
public
removeMemberAction() : bool|string
Tags
Return values
bool|string —replaceMemberAction()
Replace members to relation request([ 'method' => 'POST', 'url' => '/api/v3/relations/replaceMember' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'parentId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'replacerId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'replaceableId', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 'OK', 'message' => 'Ok', 'code' => 0 ])
public
replaceMemberAction() : bool|string
Tags
Return values
bool|string —addLog()
protected
addLog(DataSetEntity $dataSet, array<string|int, RelationEntity> $relations, string $operation) : DataSetLogEntity
Parameters
- $dataSet : DataSetEntity
- $relations : array<string|int, RelationEntity>
- $operation : string
Return values
DataSetLogEntity —attachTmpFile()
protected
attachTmpFile(TmpFile $tmpFile) : Response
Parameters
- $tmpFile : TmpFile
Return values
Response —extractDataSetFromRequest()
protected
extractDataSetFromRequest() : DataSetEntity
Tags
Return values
DataSetEntity —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 —rebuildGeometry()
protected
rebuildGeometry(RelatedDataSet $relatedDataSet, array<string|int, RelationEntity> $relations) : void
Parameters
- $relatedDataSet : RelatedDataSet
- $relations : array<string|int, RelationEntity>
Return values
void —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