avantar/luft

PHP Airly Client

v1.0.1 2019-12-16 13:54 UTC

Requires

• php: >=7.3.0
• ext-json: *
• guzzlehttp/guzzle: 6.4.1
• phpdocumentor/reflection-docblock: ^4.3
• symfony/property-access: ^4.3
• symfony/property-info: ^4.3
• symfony/serializer: ^4.3

Requires (Dev)

• phpunit/phpunit: ^8.4

MIT

• Krzysztof Szala

README

Airly PHP API client.

How to use

Create new instance of Luft library:

To use Luft library You need to create new instance of Client class and pass API key in its constructor.

$luft = new Client($apiKey);

$apiKey variable is your private api key provided by Airly (https://developer.airly.eu/api).

Changing language

You can change default language of API responses. Airly API currently supports only two languages – English (en - and it's default option) and Polish (pl). To change language use setLanguage() method.

$luft->setLanguage('pl');

Coordinates

All coordinates used in Airly API MUST be accorded to WGS 84 standard.

Available methods

getInstallationsNearest – gets installations available in given range from selected point.

Required params:

• float $latitude
• float $longitude

Optional params

• float $maxDistanceKM
• int $maxResults

getInstallationsNearest(float $latitude, float $longitude [,float $maxDistanceKM, int $maxResults]): array

It should return array of Installation objects.

Available objects

Installation

Available methods:

• getId(): int
• getLocation(): Coordinates
• getAddress(): Address
• getElevation(): float
• getAirly(): boolean
• getSponsor(): Sponsor