ElevationController
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
- getAction() : string
- Get elevation for Point, LineString or Polygon request( 'method' => 'GET', 'url' => '/api/v4/elevation/get', 'params' => [ [ 'name' => 'type', 'type' => 'Point' | 'LineString' | 'Polygon', 'required' => true, 'description' => 'GeoJSON type' ], [ 'name' => 'coordinates', 'type' => lonLat | lonLat[] | lonLat[][] 'required' => true, 'description' => 'GeoJSON coordinates' ], ] ) response( '200' => [ 'status' => 200, 'message' => number, number[], number[][], 'code' => 0 ] )
- indexAction() : mixed
- initialize() : void
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- calcElevation() : array<string|int, int>
- checkLineString() : void
- checkPoint() : void
- checkPolygon() : void
- getElevation() : int|array<string|int, int>
- getElevationByLineString() : array<string|int, int>
- getElevationByPoint() : int
- getElevationByPolygon() : array<string|int, 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 —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 elevation for Point, LineString or Polygon request( 'method' => 'GET', 'url' => '/api/v4/elevation/get', 'params' => [ [ 'name' => 'type', 'type' => 'Point' | 'LineString' | 'Polygon', 'required' => true, 'description' => 'GeoJSON type' ], [ 'name' => 'coordinates', 'type' => lonLat | lonLat[] | lonLat[][] 'required' => true, 'description' => 'GeoJSON coordinates' ], ] ) response( '200' => [ 'status' => 200, 'message' => number, number[], number[][], 'code' => 0 ] )
public
getAction() : string
Tags
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —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
Return values
mixed —calcElevation()
private
calcElevation(array<string|int, mixed> $points) : array<string|int, int>
Parameters
- $points : array<string|int, mixed>
Tags
Return values
array<string|int, int> —checkLineString()
private
checkLineString(array<string|int, mixed> $points) : void
Parameters
- $points : array<string|int, mixed>
Return values
void —checkPoint()
private
checkPoint(array<string|int, mixed> $point) : void
Parameters
- $point : array<string|int, mixed>
Return values
void —checkPolygon()
private
checkPolygon(array<string|int, mixed> $rings) : void
Parameters
- $rings : array<string|int, mixed>
Return values
void —getElevation()
private
getElevation(string $type, array<string|int, mixed> $coordinates) : int|array<string|int, int>
Parameters
- $type : string
- $coordinates : array<string|int, mixed>
Return values
int|array<string|int, int> —getElevationByLineString()
private
getElevationByLineString(array<string|int, mixed> $points) : array<string|int, int>
Parameters
- $points : array<string|int, mixed>
Return values
array<string|int, int> —getElevationByPoint()
private
getElevationByPoint(array<string|int, int>|array<string|int, float> $point) : int
Parameters
- $point : array<string|int, int>|array<string|int, float>
Return values
int —getElevationByPolygon()
private
getElevationByPolygon(array<string|int, mixed> $rings) : array<string|int, mixed>
Parameters
- $rings : array<string|int, mixed>