AirLay backend

DGis
in package
implements SearchEngine

Interfaces, Classes, Traits and Enums

SearchEngine

Table of Contents

URI_API  = 'https://catalog.api.2gis.com/3.0/'
URI_GEOCODE  = 'items/geocode'
URI_SUGGESTS  = 'suggests'
$cache  : DGisCacheAdapter
$httpClient  : Client
$key  : string
__construct()  : mixed
findByAddress()  : array<string|int, mixed>
geocode()  : null|array<string|int, float>
normalizeValue()  : string
reverseGeocode()  : string|null
suggestAddress()  : array<string|int, Address>
addressFilter()  : bool
executeQuery()  : array<string|int, mixed>
getAddressFromResponse()  : Address
postIndexFilter()  : string

Constants

URI_API

public mixed URI_API = 'https://catalog.api.2gis.com/3.0/'

URI_GEOCODE

public mixed URI_GEOCODE = 'items/geocode'

URI_SUGGESTS

public mixed URI_SUGGESTS = 'suggests'

Properties

$httpClient

private Client $httpClient

$key read-only

private string $key

Methods

findByAddress()

public findByAddress(string $value[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$value : string
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

geocode()

public geocode(string $value) : null|array<string|int, float>
Parameters
$value : string
Return values
null|array<string|int, float> —

normalizeValue()

public normalizeValue(string $value) : string
Parameters
$value : string
Return values
string —

reverseGeocode()

public reverseGeocode(int|float $lat, int|float $lon) : string|null
Parameters
$lat : int|float
$lon : int|float
Return values
string|null —

suggestAddress()

public suggestAddress(string $query) : array<string|int, Address>
Parameters
$query : string
Return values
array<string|int, Address> —

addressFilter()

private addressFilter(string $street, string $suggestText) : bool
Parameters
$street : string
$suggestText : string
Return values
bool —

executeQuery()

private executeQuery(string $uri, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$uri : string
$params : array<string|int, mixed>
Return values
array<string|int, mixed> —

getAddressFromResponse()

private getAddressFromResponse(array<string|int, mixed> $content[, string $region = '' ]) : Address
Parameters
$content : array<string|int, mixed>
$region : string = ''
Return values
Address —

postIndexFilter()

private postIndexFilter(string $query) : string
Parameters
$query : string
Return values
string —

Search results