AirLay backend

NodesController extends ApiController
in package

Class NodesController

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$request  : Request
$user  : UserEntity
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
findByRelationIdAction()  : 200
GET Get nodes
getAction()  : 200
GET Get nodes by filter Bbox [[lon, lat],[lon, lat]], first point is bottom left bound, second point top right bound
getRoutesAction()  : string
Get routes from start node to end node request([ 'method' => 'GET' 'url' => '/api/v4/nodes/getRoutes' 'parameters' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Data set id' 'required' => true, ], [ 'name' => 'start', 'type' => 'objectId', 'description' => 'start node id' 'required' => true, ], [ 'name' => 'end', 'type' => 'objectId', 'description' => 'end node id' 'required' => true, ] ]) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )
indexAction()  : mixed
initialize()  : void
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : mixed
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed
validateBbox()  : bool
Validate bbox

Properties

Methods

afterExecuteRoute()

public afterExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
$dispatcher : Dispatcher
Return values
mixed —

beforeExecuteRoute()

public beforeExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
$dispatcher : Dispatcher
Return values
mixed —

getAction()

GET Get nodes by filter Bbox [[lon, lat],[lon, lat]], first point is bottom left bound, second point top right bound

public getAction() : 200
Tags
throws
AirlayException
Return values
200 —

array Nodes collection

getRoutesAction()

Get routes from start node to end node request([ 'method' => 'GET' 'url' => '/api/v4/nodes/getRoutes' 'parameters' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'description' => 'Data set id' 'required' => true, ], [ 'name' => 'start', 'type' => 'objectId', 'description' => 'start node id' 'required' => true, ], [ 'name' => 'end', 'type' => 'objectId', 'description' => 'end node id' 'required' => true, ] ]) response( '200' => [ 'status' => 200, 'message' => array, 'code' => 0 ] )

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

validateBbox()

Validate bbox

private validateBbox( $bbox) : bool
Parameters
$bbox :
Return values
bool —

Search results