iseed838/photon-api

Project Photon-api wrapper

0.1.4 2021-06-08 06:15 UTC

Requires

• php: >=7.2
• guzzlehttp/guzzle: ~5.3.1|~6.0
• rakit/validation: ^1.2

Requires (Dev)

• phpunit/phpunit: ~7.0

MIT

• Andrey Boyarchuk

• api
• photon

README

Project Photon-api wrapper

Project wrapper of api requests for photon project https://photon.komoot.de/

Allows you to perform a fully contextual search by text template and reverse search by coordinates

• To install with composer try:

composer require iseed838/photon-api "~0.1"

• Make query request

$client   = new \Photon\Models\PhotonClient(new \GuzzleHttp\Client());

$request  = new \Photon\Models\PhotonQueryRequest([
    'query'  => "Moscow Valilova 6",
]);
$response = $client->query($request);

• Make reverse request

$client   = new \Photon\Models\PhotonClient(new \GuzzleHttp\Client());

$request  = new \Photon\Models\PhotonReverseRequest( [
    'latitude'  => 55.630358,
    'longitude' => 37.516776,
]);
$response = $client->reverse($request);

The result returns an array containing the limit of response objects

    [0] => Photon\Models\PhotonResponse Object
        (
            [osm_id] => 537247988
            [osm_type] => W
            [extent] => Array
                (
                    [0] => 37.516021
                    [1] => 55.6309387
                    [2] => 37.5177537
                    [3] => 55.6299123
                )

            [osm_key] => building
            [osm_value] => retail
            [postcode] => 117632
            [countrycode] =>
            [country] => Russia
            [state] => Moscow
            [city] => Konkovo District
            [street] => Profsous street
            [housenumber] => 126 c3
            [latitude] => 55.63039825
            [longitude] => 37.516796697274
            [type] => Point
        )

Query request properties

• query (string|required) Text query
• longitude (int|float|null) Additional box coordinate;
• latitude (int|float|null) Additional box coordinate;
• language (required|string) Response language. Default is en. May accept en,de,ft,it
• limit (required|int) Response count/ Default is 5
• osm_tag (string|null) Additional filter to osm_tag

Reverse request properties

• longitude (required|int|float) Address coordinate;
• latitude (required|int|float) Address coordinate;
• language (required|string) Response language. Default is en. May accept en,de,ft,it
• limit (required|int) Response count/ Default is 5