Documentation

Yours extends Base
in package

Connector for service YOURS to get routing.

Table of Contents

$description  : string
$distance  : float
$end  : array<string|int, float>
$geoJson  : array<string|int, mixed>
$indirectPoints  : array<string|int, mixed>
$params  : array<string|int, mixed>
$start  : array<string|int, float>
$travelTime  : float
$url  : string
__construct()  : mixed
Construct.
addIndirectPoint()  : void
Add indirect point.
calculate()  : mixed
Function to calculate routing.
getDescription()  : string
Get description.
getDistance()  : float
Get distance of routing.
getGeoJson()  : array<string|int, mixed>
Get geojson - RFC 7946.
getTravelTime()  : float
Get time of travel.
parsePoints()  : array<string|int, mixed>
Function to parse points.
setEnd()  : void
Set end of routing.
setStart()  : void
Set start of routing.

Properties

$description

protected string $description = ''

Rout description

$distance

protected float $distance = 0

$end

protected array<string|int, float> $end

$geoJson

protected array<string|int, mixed> $geoJson

GeoJSON, route geometry format

$indirectPoints

protected array<string|int, mixed> $indirectPoints

$params

protected array<string|int, mixed> $params

Custom routing parameters.

$start

protected array<string|int, float> $start

$travelTime

protected float $travelTime = 0

Travel time

$url

protected string $url

API server URL.

Methods

__construct()

Construct.

public __construct(array<string|int, mixed> $provider) : mixed
Parameters
$provider : array<string|int, mixed>
Return values
mixed

addIndirectPoint()

Add indirect point.

public addIndirectPoint(float $lat, float $lon) : void
Parameters
$lat : float
$lon : float
Return values
void

calculate()

Function to calculate routing.

public calculate() : mixed
Return values
mixed

getDescription()

Get description.

public getDescription() : string
Return values
string

getDistance()

Get distance of routing.

public getDistance() : float
Return values
float

getGeoJson()

Get geojson - RFC 7946.

public getGeoJson() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTravelTime()

Get time of travel.

public getTravelTime() : float
Return values
float

parsePoints()

Function to parse points.

public parsePoints() : array<string|int, mixed>
Return values
array<string|int, mixed>

setEnd()

Set end of routing.

public setEnd(float $lat, float $lon) : void
Parameters
$lat : float

.

$lon : float
Return values
void

setStart()

Set start of routing.

public setStart(float $lat, float $lon) : void
Parameters
$lat : float
$lon : float
Return values
void

        

Search results