AirLay backend

RoutesDataSetController 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
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
buildRasterRoutesAction()  : string|false
Generate raster route.
createAction()  : string
Create route in routes data set.
deleteAction()  : string
Delete route in routes data set.
generateRouteAction()  : string|false
Generate route.
getAction()  : string
Get routes.
getByLayerAction()  : string
Get routes by layerId.
getRouteParamsAction()  : string|false
Get params for route.
indexAction()  : mixed
initialize()  : void
updateAction()  : string
Update route in routes data set.
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : mixed
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed
getDataSetFromRequest()  : DataSetEntity

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 —

buildRasterRoutesAction()

Generate raster route.

public buildRasterRoutesAction() : string|false

request([ 'method' => 'POST', 'url' => '/api/v4/routes_data_set/buildRasterRoutes' 'rawBody' => { 'startPoints' => [ [ 'point' => (point coordinates array) ], ... ], 'endPoints' => [ [ 'point' => (point coordinates array), 'id' => (string id) ], ... ], 'simplify' => 0.04 } ]) response([ 'status' => 200, 'message' => response, 'code' => 0 ])

Tags
throws
AirlayException
Return values
string|false —

createAction()

Create route in routes data set.

public createAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/routes_data_set/create' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'route', 'type' => 'json', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => RouteEntity, 'code' => 0 ])

Tags
throws
AirlayException
Return values
string —

deleteAction()

Delete route in routes data set.

public deleteAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/routes_data_set/delete' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'ids', 'type' => 'json', 'required' => 'true', 'description' => Routes ids in json array ] ] ]) response([ 'status' => 200, 'message' => 'OК', 'code' => 0 ])

Tags
throws
AirlayException
Return values
string —

generateRouteAction()

Generate route.

public generateRouteAction() : string|false

request([ 'method' => 'POST', 'url' => '/api/v4/routes_data_set/generateRoute' 'params' => [ [ 'name' => 'waypoints', 'type' => 'array', 'required' => true, 'description' => [ ... { "id": ObjectId of feature, "dataSetId": ObjectId of dataSet, "coordinates": { "0": 49.64367628097535 , "1": 58.59076460869765 } } ... ] ], [ 'name' => 'source', 'type' => 'string', 'required' => 'false', 'description' => first point is first point in array? 'values' => first|any, 'default' => first ], [ 'name' => 'destination', 'type' => 'string', 'required' => 'false', 'description' => last point is last point in array? 'values' => last|any, 'default' => last ], [ 'name' => 'roundtrip', 'type' => 'string', 'required' => 'false', 'description' => need to return at first point? 'values' => true|false 'default' => false ], [ 'name' => 'info', 'type' => 'json', 'required' => 'true', 'description' => { "processTime" => "Time of waypoint process in seconds", "transport" => 'car', "maxSpeed" => "Max speed of transport in km/h", "gasConsumption" => "Gas consumption", "workTime" => "Work day time in seconds" } ] ] ]) response([ 'status' => 200, 'message' => RouteEntity, 'code' => 0 ])

Tags
throws
AirlayException
Return values
string|false —

getAction()

Get routes.

public getAction() : string

request([ 'method' => 'GET', 'url' => '/api/v4/routes_data_set/get' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ])

response([ 'status' => 200, 'message' => RouteEntity[], 'code' => 0 ])

Tags
throws
AirlayException
Return values
string —

getByLayerAction()

Get routes by layerId.

public getByLayerAction() : string

request([ 'method' => 'GET', 'url' => '/api/v4/routes_data_set/get_by_layer' 'params' => [ [ 'name' => 'layerId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'routeId', 'type' => 'objectId', 'required' => false ], [ 'name' => 'bbox', 'type' => 'json', 'required' => false ], [ 'name' => 'skip', 'type' => 'int', 'required' => false ], [ 'name' => 'limit', 'type' => 'int', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => RouteEntity[], 'code' => 0 ])

Tags
throws
AirlayException
Return values
string —

getRouteParamsAction()

Get params for route.

public getRouteParamsAction() : string|false

request([ 'method' => 'Get', 'url' => '/api/v4/routes_data_set/getRouteParams response([ 'status' => 200, 'message' => 'array', 'code' => 0 ])

Return values
string|false —

updateAction()

Update route in routes data set.

public updateAction() : string

request([ 'method' => 'POST', 'url' => '/api/v4/routes_data_set/update' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'routeId', 'type' => 'objectId', 'required' => true ], [ 'name' => 'route', 'type' => 'json', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => RouteEntity, 'code' => 0 ])

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