Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GraphHopper] Add provider parameter #1251

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+42 −0
Open

[GraphHopper] Add provider parameter #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d66689
[GraphHopper] Add provider parameter
bisleadity Mar 18, 2025
320b5d7
[GraphHopper] Add GraphHopperProvider enum for provider options of Gr…
bisleadity Mar 27, 2025
676a401
Revert "[GraphHopper] Add GraphHopperProvider enum for provider optio…
bisleadity Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Provider/GraphHopper/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.

## 0.6.0

### Added

- Add provider support for graphhopper geocoding API

## 0.5.0

### Removed
Expand Down
5 changes: 5 additions & 0 deletions src/Provider/GraphHopper/GraphHopper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ public function geocodeQuery(GeocodeQuery $query): Collection
$url .= sprintf('&bbox=%f,%f,%f,%f', $bounds->getWest(), $bounds->getSouth(), $bounds->getEast(), $bounds->getNorth());
}

$provider = $query->getData('provider');
if (is_string($provider) && '' !== $provider) {
$url .= sprintf('&provider=%s', urlencode($provider));
}
Comment on lines +77 to +80
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth creating an enum with the list of available providers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does all providers return the necessary result?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum would be no problem, but when the list expands another PR has to be made.

What do you mean by 'Does all providers return the necessary result?'. We do need one specific provider that works best for our case

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by 'Does all providers return the necessary result?'. We do need one specific provider that works best for our case

Is the response from GraphHopper different if we select a provider other than 'default'? Just to know if we need to implement specific logic if we choose another provider than the default one.

Copy link
Author

@bisleadity bisleadity Mar 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested a little and the response seems to be quiety different depending on the address searched. Latitude and longitude are always present. But there are parameters , which are set depending on provider but as well the search string. So I'm not sure if its really useful to add them. However, the main address attributes such as city, country, street or postcode seem to be the same for all providers.

One question: I was already wondering why the classes are made final if not so a user could extend e.g. the GraphHopper provider and Address Model to add properties if needed.

Copy link
Author

@bisleadity bisleadity Apr 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the enum feature is supported since php 8.1 but code has to be valid for php 8.0 as well, I will remove it again. Do you have another suggestion?


return $this->executeQuery($url);
}

Expand Down
31 changes: 31 additions & 0 deletions src/Provider/GraphHopper/Tests/GraphHopperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@

namespace Geocoder\Provider\GraphHopper\Tests;

use Geocoder\Exception\InvalidServerResponse;
use Geocoder\IntegrationTest\BaseTestCase;
use Geocoder\Model\Bounds;
use Geocoder\Provider\GraphHopper\GraphHopper;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;
use Psr\Http\Message\RequestInterface;

/**
* @author Gary Gale <[email protected]>
Expand Down Expand Up @@ -119,6 +121,35 @@ public function testGeocodeOutsideBounds(): void
$this->assertCount(0, $results);
}

public function testCorrectlyAppendsProvider(): void
{
$uri = '';

$provider = new GraphHopper(
$this->getMockedHttpClientCallback(
function (RequestInterface $request) use (&$uri) {
$uri = (string) $request->getUri();
}
),
'api_key'
);

$query = GeocodeQuery::create('242 Acklam Road, London, United Kingdom')
->withLocale('fr')
->withData('provider', 'default');

try {
$provider->geocodeQuery($query);
} catch (InvalidServerResponse $e) {
}

$this->assertEquals('https://graphhopper.com/api/1/geocode'.
'?q=242+Acklam+Road%2C+London%2C+United+Kingdom'.
'&key=api_key&locale=fr&limit=5&provider=default',
$uri
);
}

public function testReverseWithRealCoordinates(): void
{
if (!isset($_SERVER['GRAPHHOPPER_API_KEY'])) {
Expand Down