class NominatimProvider extends AbstractProvider

Properties

protected Client $httpClient

The cache lifetime.

from  AbstractProvider
protected float|int $cacheLifetime

The cache lifetime.

from  AbstractProvider
protected $logs from  AbstractProvider
protected array $config

Methods

string
getName()

Returns the provider name.

Collection
geocodeQuery(GeoQueryInterface $query)

Handle the geocoder request.

Collection
reverseQuery(GeoQueryInterface $query)

Handle the reverse geocoding request.

Distance|null
distance(DistanceInterface $distance)

No description

Client
getHttpClient()

No description

$this
forgetCache()

Forget the repository cache.

getCacheKey()

No description

$this
setCacheLifetime(float|int $cacheLifetime)

Set the repository cache lifetime.

float|int
getCacheLifetime()

Get the repository cache lifetime.

cacheCallback($cacheKey, Closure $closure)

No description

Repository
getCacheDriver()

No description

log($message)

No description

getLogs()

No description

__construct(Client $client, array $config)

No description

requestUrl($url, GeoQueryInterface $query)

No description

hydrateResponse($response)

No description

parseResponse(ResponseInterface $response)

No description

parseCoordinates(Location $address, $location)

No description

parseAddress(Location $address, $location)

No description

requestDistanceUrl($url, DistanceInterface $distance)

No description

Details

at line 37
string getName()

Returns the provider name.

Return Value

string

at line 48
Collection geocodeQuery(GeoQueryInterface $query)

Handle the geocoder request.

Parameters

GeoQueryInterface $query

Return Value

Collection

at line 80
Collection reverseQuery(GeoQueryInterface $query)

Handle the reverse geocoding request.

Parameters

GeoQueryInterface $query

Return Value

Collection

at line 110
Distance|null distance(DistanceInterface $distance)

No description

Parameters

DistanceInterface $distance

Return Value

Distance|null

in AbstractProvider at line 56
protected Client getHttpClient()

No description

Return Value

Client

in AbstractProvider at line 70
$this forgetCache()

Forget the repository cache.

Return Value

$this

in AbstractProvider at line 80
getCacheKey()

No description

in AbstractProvider at line 92
$this setCacheLifetime(float|int $cacheLifetime)

Set the repository cache lifetime.

Parameters

float|int $cacheLifetime

Return Value

$this

in AbstractProvider at line 104
float|int getCacheLifetime()

Get the repository cache lifetime.

Return Value

float|int

in AbstractProvider at line 111
protected cacheCallback($cacheKey, Closure $closure)

No description

Parameters

$cacheKey
Closure $closure

in AbstractProvider at line 121
protected Repository getCacheDriver()

No description

Return Value

Repository

in AbstractProvider at line 130
log($message)

No description

Parameters

$message

in AbstractProvider at line 141
AbstractProvider resetLogs()

No description

Return Value

AbstractProvider $this

in AbstractProvider at line 148
getLogs()

No description

at line 26
__construct(Client $client, array $config)

No description

Parameters

Client $client
array $config

at line 140
protected requestUrl($url, GeoQueryInterface $query)

No description

Parameters

$url
GeoQueryInterface $query

at line 160
protected hydrateResponse($response)

No description

Parameters

$response

at line 190
protected parseResponse(ResponseInterface $response)

No description

Parameters

ResponseInterface $response

at line 221
protected parseCoordinates(Location $address, $location)

No description

Parameters

Location $address
$location

at line 231
protected parseAddress(Location $address, $location)

No description

Parameters

Location $address
$location

at line 258
protected requestDistanceUrl($url, DistanceInterface $distance)

No description

Parameters

$url
DistanceInterface $distance