LayerController
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
- addAccessLogAction() : string
- Logging access to layers request( 'method' => 'POST', 'url' => '/api/v4/layer/addAccessLog', 'params' => [ [ 'name' => 'menuNodeId', 'type' => 'objectId', 'description' => 'menu node id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => MenuNodeEntity, 'code' => 0 ] )
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- downloadAction() : void
- Download layers|dirs|trees request( 'method' => 'POST', 'url' => '/api/v4/layer/download', 'params' => [ [ 'name' => 'id', 'type' => 'json', 'description' => 'layerId', 'require' => true ], [ 'name' => 'withData', 'type' => 'bool', 'description' => 'with data flag', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => File, 'code' => 0 ] )
- getObjsMultiAction() : string
- Return array of objects from multiple layers request( 'method' => 'POST', 'url' => '/api/v4/layer/getObjsMulti', 'params' => [ [ 'name' => 'query', 'type' => 'json', 'description' => 'Query to get objects', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
- getOptionsMultiAction() : string
- Return array of options from multiple layers request( 'method' => 'POST', 'url' => '/api/v4/layer/getOptionsMulti', 'params' => [ [ 'name' => 'ids', 'type' => 'json', 'description' => 'Array layer ids', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
- indexAction() : mixed
- initialize() : void
- uploadAction() : string
- Upload layers|dirs|trees request( 'method' => 'POST', 'url' => '/api/v4/layer/upload', 'params' => [ [ 'name' => 'file', 'type' => 'File', 'description' => 'json file with layers', 'require' => true ], [ 'name' => 'portalId', 'type' => 'int', 'description' => 'portal id', 'require' => true ], [ 'name' => 'treeId', 'type' => 'ObjectId', 'description' => 'tree id', 'require' => false | true if upload layer or dir ], [ 'name' => 'parentId', 'type' => 'ObjectId', 'description' => 'parent id', 'require' => false | true if upload layer or dir ] ] ) response( '200' => [ 'status' => 200, 'message' => MenuNodeEntity, 'code' => 0 ] )
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- 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 —addAccessLogAction()
Logging access to layers request( 'method' => 'POST', 'url' => '/api/v4/layer/addAccessLog', 'params' => [ [ 'name' => 'menuNodeId', 'type' => 'objectId', 'description' => 'menu node id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => MenuNodeEntity, 'code' => 0 ] )
public
addAccessLogAction() : string
Tags
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 —downloadAction()
Download layers|dirs|trees request( 'method' => 'POST', 'url' => '/api/v4/layer/download', 'params' => [ [ 'name' => 'id', 'type' => 'json', 'description' => 'layerId', 'require' => true ], [ 'name' => 'withData', 'type' => 'bool', 'description' => 'with data flag', 'require' => false ] ] ) response( '200' => [ 'status' => 200, 'message' => File, 'code' => 0 ] )
public
downloadAction() : void
Tags
Return values
void —getObjsMultiAction()
Return array of objects from multiple layers request( 'method' => 'POST', 'url' => '/api/v4/layer/getObjsMulti', 'params' => [ [ 'name' => 'query', 'type' => 'json', 'description' => 'Query to get objects', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
public
getObjsMultiAction() : string
Tags
Return values
string —getOptionsMultiAction()
Return array of options from multiple layers request( 'method' => 'POST', 'url' => '/api/v4/layer/getOptionsMulti', 'params' => [ [ 'name' => 'ids', 'type' => 'json', 'description' => 'Array layer ids', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
public
getOptionsMultiAction() : string
Tags
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —uploadAction()
Upload layers|dirs|trees request( 'method' => 'POST', 'url' => '/api/v4/layer/upload', 'params' => [ [ 'name' => 'file', 'type' => 'File', 'description' => 'json file with layers', 'require' => true ], [ 'name' => 'portalId', 'type' => 'int', 'description' => 'portal id', 'require' => true ], [ 'name' => 'treeId', 'type' => 'ObjectId', 'description' => 'tree id', 'require' => false | true if upload layer or dir ], [ 'name' => 'parentId', 'type' => 'ObjectId', 'description' => 'parent id', 'require' => false | true if upload layer or dir ] ] ) response( '200' => [ 'status' => 200, 'message' => MenuNodeEntity, 'code' => 0 ] )
public
uploadAction() : 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