AirLay backend

PortalController extends ApiController
in package

Application

Class ApiBaseController.

$config : AirlayConfig
$config : AirlayConfig
$request : Request
$user : UserEntity
$status : StatusPage|null
$tokenHandler : TokenHandler|null
__destruct() : mixed
afterExecuteRoute() : mixed
beforeExecuteRoute() : mixed
createAction() : string: Create portal.
createAdminModuleAction() : string|false: Action for create admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/createAdminModule', 'params' => [ [ 'name' => 'portalId ', 'type' => 'int', 'description' => 'portal id', 'required' => 'true' ], [ 'name' => 'type', 'type' => 'string', 'description' => 'admin module type(LayerList/Brigade)' 'required' => 'true' ], [ 'name' => 'name', 'type' => 'string', 'description' => 'admin module name', 'required' => 'true' ], [ 'name' => 'searchId', 'type' => 'ObjectId', 'description' => 'search id', 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' => PortalAdminModuleEntity, 'code' => 0 ]).
deleteAdminModuleAction() : string|false: Delete admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/deleteAdminModule', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'id', 'type' => 'objectId', 'description' => 'admin module id' 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' = Ok, 'code' => 0 ]).
getAction() : string: Get portal. One or all for user organization.
getAdminModulesAction() : string|false: Action for get admin modules request([ 'method' => 'GET', 'url' => 'api/v3/portal/getAdminModules', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'type', 'type' => 'string', 'description' => 'admin module type' 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = PortalAdminModuleEntity[], 'code' => 0 ]).
getAvailableAction() : string: Get available portals for user request([ 'method' => 'GET', 'url' => 'api/v3/portal/getAvailable', ]) response([ 'status' => 200, 'message' = Portal[], 'code' => 0 ]).
getDemoAction() : void: Action for get demo portal request([ 'method' => 'GET', 'url' => 'api/v3/portal/getDemo', 'params' => [] ]) response([ 'status' => 200, 'message' = Portal[], 'code' => 0 ]).
getHelpsAction() : string: Get portal helps.
getMenuAction() : string: Get menu request([ 'method' => 'GET', 'url' => 'api/v3/portal/getMenu', 'params' => [ [ 'name' => 'withSystemTiles', 'type' => 'bool' 'required' => 'false' ], [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'false' ], [ 'name' => 'removeUserOverlayLayers', 'type' => 'bool' 'default' => true 'required' => 'false' ], ] ]) response([ 'status' => 200, 'message' = json portal menu, 'code' => 0 ]).
getOpensByPortalIdAction() : string: Get open portals by portal id.
indexAction() : mixed
initialize() : void
removeAction() : string: Delete portal.
removeAllAction() : string: Delete all portals for usr organization.
updateAction() : string: Update portal.
updateAdminModuleAction() : string|false: Update admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/updateAdminModule', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'admin portal object id' 'required' => 'true' ], [ 'name' => 'name', 'type' => 'string', 'description' => 'admin module name', 'required' => 'false' ], [ 'name' => 'searchId', 'type' => 'ObjectId', 'description' => 'search id', 'required' => 'false' ], [ 'name' => 'displayedFields', 'type' => 'json', 'description' => 'displayed fields', 'required' => 'false' ], [ 'name' => 'isRefreshable', 'type' => 'bool', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'refreshableTime', 'type' => 'absint', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'displayColumnHasGeometry', 'type' => 'bool', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'functions', 'type' => 'json', 'description' => '(LayerList)', 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = Ok, 'code' => 0 ]).
attachTmpFile() : Response
firesAnRelationUpdateEvents() : void
getId() : mixed
getNormalizedUserId() : int|ObjectId
getTranslator() : NativeArray
getUserInfo() : UserEntity
removeUserOverlayLayers() : void
secureData() : mixed
sendEmail() : mixed
convertDescriptionToString() : array<string|int, mixed>

$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

__destruct()


    public
                __destruct() : mixed

Return values

mixed —

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 portal.


    public
                createAction() : string

request([ 'method' => 'POST', 'url' => 'api/v3/portal/create', 'params' => [ [ 'name' => 'settings', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'open', 'type' => 'bool', 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = Portal, 'code' => 0 ]).

Return values

string —

createAdminModuleAction()

Action for create admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/createAdminModule', 'params' => [ [ 'name' => 'portalId ', 'type' => 'int', 'description' => 'portal id', 'required' => 'true' ], [ 'name' => 'type', 'type' => 'string', 'description' => 'admin module type(LayerList/Brigade)' 'required' => 'true' ], [ 'name' => 'name', 'type' => 'string', 'description' => 'admin module name', 'required' => 'true' ], [ 'name' => 'searchId', 'type' => 'ObjectId', 'description' => 'search id', 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' => PortalAdminModuleEntity, 'code' => 0 ]).


    public
                createAdminModuleAction() : string|false

Return values

string|false —

deleteAdminModuleAction()

Delete admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/deleteAdminModule', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'id', 'type' => 'objectId', 'description' => 'admin module id' 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' = Ok, 'code' => 0 ]).


    public
                deleteAdminModuleAction() : string|false

Return values

string|false —

getAction()

Get portal. One or all for user organization.


    public
                getAction() : string

request([ 'method' => 'GET', 'url' => 'api/v3/portal/get', 'params' => [ [ 'name' => 'id', 'type' => 'absint', 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = Portal|Portal[], 'code' => 0 ]).

Return values

string —

getAdminModulesAction()

Action for get admin modules request([ 'method' => 'GET', 'url' => 'api/v3/portal/getAdminModules', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'type', 'type' => 'string', 'description' => 'admin module type' 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = PortalAdminModuleEntity[], 'code' => 0 ]).


    public
                getAdminModulesAction() : string|false

Return values

string|false —

getAvailableAction()

Get available portals for user request([ 'method' => 'GET', 'url' => 'api/v3/portal/getAvailable', ]) response([ 'status' => 200, 'message' = Portal[], 'code' => 0 ]).


    public
                getAvailableAction() : string

Return values

string —

getDemoAction()

Action for get demo portal request([ 'method' => 'GET', 'url' => 'api/v3/portal/getDemo', 'params' => [] ]) response([ 'status' => 200, 'message' = Portal[], 'code' => 0 ]).


    public
                getDemoAction() : void

Return values

void —

getHelpsAction()

Get portal helps.


    public
                getHelpsAction() : string

request([ 'method' => 'GET', 'url' => 'api/v3/portal/getHelps', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint', 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' = HelpEntity[], 'code' => 0 ]).

Return values

string —

getMenuAction()

Get menu request([ 'method' => 'GET', 'url' => 'api/v3/portal/getMenu', 'params' => [ [ 'name' => 'withSystemTiles', 'type' => 'bool' 'required' => 'false' ], [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'false' ], [ 'name' => 'removeUserOverlayLayers', 'type' => 'bool' 'default' => true 'required' => 'false' ], ] ]) response([ 'status' => 200, 'message' = json portal menu, 'code' => 0 ]).


    public
                getMenuAction() : string

Return values

string —

getOpensByPortalIdAction()

Get open portals by portal id.


    public
                getOpensByPortalIdAction() : string

request([ 'method' => 'GET', 'url' => 'api/v3/portal/getOpensByPortalId', 'params' => [ [ 'name' => 'id', 'type' => 'absint', 'required' => 'true' ] ] ]) response([ 'status' => 200, 'message' = Portal[], 'code' => 0 ]).

Return values

string —

indexAction()


    public
                indexAction() : mixed

Return values

mixed —

initialize()


    public
                initialize() : void

Return values

void —

removeAction()

Delete portal.


    public
                removeAction() : string

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

Return values

string —

removeAllAction()

Delete all portals for usr organization.


    public
                removeAllAction() : string

request([ 'method' => 'POST', 'url' => 'api/v3/portal/removeAll', 'params' => [] ]) response([ 'status' => 200, 'message' = OK, 'code' => 0 ]).

Return values

string —

updateAction()

Update portal.


    public
                updateAction() : string

request([ 'method' => 'POST', 'url' => 'api/v3/portal/update', 'params' => [ [ 'name' => 'id', 'type' => 'absint', 'required' => 'true' ], [ 'name' => 'settings', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'open', 'type' => 'bool', 'required' => 'false' ], [ 'name' => 'searches', 'type' => 'ObjectId[]', 'required' => 'false' ], [ 'name' => 'helps', 'type' => 'ObjectId[]', 'required' => 'false' ], [ 'name' => 'privateRegistration', 'type' => 'bool', 'required' => 'false' ], [ 'name' => 'visualization', 'type' => 'json', 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = 'OK', 'code' => 0 ]).

Return values

string —

updateAdminModuleAction()

Update admin module request([ 'method' => 'POST', 'url' => 'api/v3/portal/updateAdminModule', 'params' => [ [ 'name' => 'portalId', 'type' => 'absint' 'required' => 'true' ], [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'admin portal object id' 'required' => 'true' ], [ 'name' => 'name', 'type' => 'string', 'description' => 'admin module name', 'required' => 'false' ], [ 'name' => 'searchId', 'type' => 'ObjectId', 'description' => 'search id', 'required' => 'false' ], [ 'name' => 'displayedFields', 'type' => 'json', 'description' => 'displayed fields', 'required' => 'false' ], [ 'name' => 'isRefreshable', 'type' => 'bool', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'refreshableTime', 'type' => 'absint', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'displayColumnHasGeometry', 'type' => 'bool', 'description' => '(LayerList)', 'required' => 'false' ], [ 'name' => 'functions', 'type' => 'json', 'description' => '(LayerList)', 'required' => 'false' ] ] ]) response([ 'status' => 200, 'message' = Ok, 'code' => 0 ]).


    public
                updateAdminModuleAction() : string|false

Return values

string|false —

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

Return values

int|ObjectId —

getTranslator()


    protected
                getTranslator([string|null $language = null ]) : NativeArray

Parameters

$language : string|null = null

Return values

NativeArray —

getUserInfo()


    protected
                getUserInfo() : UserEntity

Return values

UserEntity —

removeUserOverlayLayers()


    protected
                removeUserOverlayLayers(mixed &$node) : void

Parameters

$node : mixed

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

Return values

mixed —

convertDescriptionToString()


    private
                convertDescriptionToString(array<string|int, mixed> $menu) : array<string|int, mixed>

Parameters

$menu : array<string|int, mixed>

Return values

array<string|int, mixed> —

PortalController extends ApiController in package Application

Table of Contents

Properties

$config

$config

$request

$user

$status

$tokenHandler

Methods

__destruct()

Return values

afterExecuteRoute()

Parameters

Return values

beforeExecuteRoute()

Parameters

Return values

createAction()

Tags

Return values

createAdminModuleAction()

Tags

Return values

deleteAdminModuleAction()

Tags

Return values

getAction()

Tags

Return values

getAdminModulesAction()

Tags

Return values

getAvailableAction()

Return values

getDemoAction()

Tags

Return values

getHelpsAction()

Tags

Return values

getMenuAction()

Tags

Return values

getOpensByPortalIdAction()

Tags

Return values

indexAction()

Return values

initialize()

Return values

removeAction()

Tags

Return values

removeAllAction()

Tags

Return values

updateAction()

Tags

Return values

updateAdminModuleAction()

Tags

Return values

attachTmpFile()

Parameters

Return values

firesAnRelationUpdateEvents()

Parameters

Return values

getId()

Return values

getNormalizedUserId()

Tags

Return values

getTranslator()

Parameters

Tags

Return values

getUserInfo()

Tags

PortalController extends ApiController
in package

Application