OpenCageGeocoder
extends Base
in package
Address finder OpenCageGeocoder class.
Table of Contents
- $config : array<string|int, mixed>
- Config data.
- $customFields : array<string|int, mixed>
- Custom Fields.
- $docUrl : string
- Provider documentation url address.
- $name : string
- Provider name.
- $url : string
- API Address to retrieve data.
- __construct() : mixed
- Construct.
- find() : array<string|int, mixed>
- Find address.
- getCustomFields() : array<string|int, mixed>
- Get provider custom fields.
- getDataFromRequest() : array<string|int, mixed>
- Gets data from request.
- getDocUrl() : string
- Get provider documentation url address.
- getName() : string
- Get provider name.
- isActive() : bool
- Function checks if provider is active.
- isConfigured() : bool
- Function checks if provider been configured?
- validate() : bool
- Validate configuration.
- parseRow() : array<string|int, mixed>
- Main function to parse information about address.
Properties
$config
Config data.
public
array<string|int, mixed>
$config
$customFields
Custom Fields.
public
array<string|int, mixed>
$customFields
= ['country_codes' => ['uitype' => 1, 'label' => 'LBL_COUNTRY_CODES', 'purifyType' => \App\Purifier::TEXT, 'maximumlength' => '100', 'typeofdata' => 'V~O', 'tooltip' => 'LBL_COUNTRY_CODES_PLACEHOLDER', 'link' => ['title' => 'LBL_COUNTRY_CODES_INFO', 'url' => 'https://wikipedia.org/wiki/List_of_ISO_3166_country_codes']], 'key' => ['validator' => [['name' => 'AlphaNumeric']], 'uitype' => 1, 'label' => 'LBL_KEY', 'purifyType' => \App\Purifier::ALNUM, 'maximumlength' => '200', 'typeofdata' => 'V~M', 'tooltip' => 'LBL_KEY_PLACEHOLDER']]
$docUrl
Provider documentation url address.
public
string
$docUrl
= 'https://opencagedata.com/api/'
$name
Provider name.
public
string
$name
$url
API Address to retrieve data.
protected
static string
$url
= 'https://api.opencagedata.com/geocode/v1/'
Methods
__construct()
Construct.
public
__construct() : mixed
Return values
mixed —find()
Find address.
public
find(mixed $value) : array<string|int, mixed>
Parameters
- $value : mixed
-
string
Return values
array<string|int, mixed> —getCustomFields()
Get provider custom fields.
public
getCustomFields([array<string|int, mixed> $data = [] ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getDataFromRequest()
Gets data from request.
public
getDataFromRequest(Request $request) : array<string|int, mixed>
Parameters
- $request : Request
Return values
array<string|int, mixed> —getDocUrl()
Get provider documentation url address.
public
getDocUrl() : string
Return values
string —getName()
Get provider name.
public
getName() : string
Return values
string —isActive()
Function checks if provider is active.
public
isActive() : bool
Return values
bool —isConfigured()
Function checks if provider been configured?
public
isConfigured() : bool
Return values
bool —validate()
Validate configuration.
public
validate() : bool
Return values
bool —parseRow()
Main function to parse information about address.
private
parseRow(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>