Skip to content

add admin levels to geocoding results #15

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

Merged
jbelien merged 2 commits into from
Mar 16, 2026
Merged

add admin levels to geocoding results #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
694dfb6
add admin levels to geocoding results
wikub Mar 15, 2026
8bb9b61
clean up whitespace in Addok.php
wikub Mar 16, 2026
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
34 changes: 34 additions & 0 deletions Addok.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ public function geocodeQuery(GeocodeQuery $query): Collection
'streetName' => $streetName,
'locality' => $locality,
'postalCode' => $postalCode,
'adminLevels' => $this->getAdminLevels($feature->properties),
]);
}

Expand Down Expand Up @@ -165,6 +166,7 @@ public function reverseQuery(ReverseQuery $query): Collection
'streetName' => $streetName,
'locality' => $municipality,
'postalCode' => $postalCode,
'adminLevels' => $this->getAdminLevels($feature->properties),
]);
}

Expand Down Expand Up @@ -195,4 +197,36 @@ private function executeQuery(string $url): \stdClass

return $json;
}

/**
* @param \stdClass $properties
*
* @return array<int, array<string, mixed>>
*/
private function getAdminLevels(\stdClass $properties): array
{
$adminLevels = [];

$context = !empty($properties->context) ? $properties->context : null;
if ($context) {
$contextParts = explode(',', $context);
$departmentCode = trim($contextParts[0] ?? '');
$departementLabel = trim($contextParts[1] ?? '');
$regionLabel = trim($contextParts[2] ?? '');

$adminLevels[] = ['level' => 2, 'name' => $regionLabel];
$adminLevels[] = ['level' => 3, 'name' => $departementLabel, 'code' => $departmentCode];
}

$cityCode = !empty($properties->citycode) ? $properties->citycode : null;
$municipality = !empty($properties->city) ? $properties->city : null;
if ($cityCode && $municipality) {
$adminLevels[] = ['level' => 4, 'name' => $municipality, 'code' => $cityCode];
}

$district = !empty($properties->district) ? $properties->district : null;
$adminLevels[] = ['level' => 5, 'name' => $district];

return $adminLevels;
}
}
32 changes: 32 additions & 0 deletions Tests/AddokTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@ public function testReverseQuery()
$this->assertEquals('Quai de la Tourelle', $result->getStreetName());
$this->assertEquals('95000', $result->getPostalCode());
$this->assertEquals('Cergy', $result->getLocality());
$this->assertCount(3, $result->getAdminLevels());
$this->assertEquals('Île-de-France', $result->getAdminLevels()->get(2)->getName());
$this->assertEquals('Val-d\'Oise', $result->getAdminLevels()->get(3)->getName());
$this->assertEquals('95', $result->getAdminLevels()->get(3)->getCode());
$this->assertEquals('Cergy', $result->getAdminLevels()->get(4)->getName());
$this->assertEquals('95127', $result->getAdminLevels()->get(4)->getCode());
}

public function testGeocodeQuery()
Expand All @@ -84,6 +90,12 @@ public function testGeocodeQuery()
$this->assertEquals('Quai de la Tourelle', $result->getStreetName());
$this->assertEquals('95000', $result->getPostalCode());
$this->assertEquals('Cergy', $result->getLocality());
$this->assertCount(3, $result->getAdminLevels());
$this->assertEquals('Île-de-France', $result->getAdminLevels()->get(2)->getName());
$this->assertEquals('Val-d\'Oise', $result->getAdminLevels()->get(3)->getName());
$this->assertEquals('95', $result->getAdminLevels()->get(3)->getCode());
$this->assertEquals('Cergy', $result->getAdminLevels()->get(4)->getName());
$this->assertEquals('95127', $result->getAdminLevels()->get(4)->getCode());
}

public function testGeocodeOnlyCityQuery()
Expand All @@ -102,6 +114,12 @@ public function testGeocodeOnlyCityQuery()
$this->assertNull($result->getStreetName());
$this->assertEquals('38000', $result->getPostalCode());
$this->assertEquals('Grenoble', $result->getLocality());
$this->assertCount(3, $result->getAdminLevels());
$this->assertEquals('Auvergne-Rhône-Alpes', $result->getAdminLevels()->get(2)->getName());
$this->assertEquals('Isère', $result->getAdminLevels()->get(3)->getName());
$this->assertEquals('38', $result->getAdminLevels()->get(3)->getCode());
$this->assertEquals('Grenoble', $result->getAdminLevels()->get(4)->getName());
$this->assertEquals('38185', $result->getAdminLevels()->get(4)->getCode());
}

public function testGeocodeHouseNumberTypeQuery()
Expand All @@ -120,6 +138,13 @@ public function testGeocodeHouseNumberTypeQuery()
$this->assertEquals('Avenue Kléber', $result->getStreetName());
$this->assertEquals('75016', $result->getPostalCode());
$this->assertEquals('Paris', $result->getLocality());
$this->assertCount(4, $result->getAdminLevels());
$this->assertEquals('Île-de-France', $result->getAdminLevels()->get(2)->getName());
$this->assertEquals('Paris', $result->getAdminLevels()->get(3)->getName());
$this->assertEquals('75', $result->getAdminLevels()->get(3)->getCode());
$this->assertEquals('Paris', $result->getAdminLevels()->get(4)->getName());
$this->assertEquals('75116', $result->getAdminLevels()->get(4)->getCode());
$this->assertEquals('Paris 16e Arrondissement', $result->getAdminLevels()->get(5)->getName());
}

public function testGeocodeStreetTypeQuery()
Expand All @@ -138,6 +163,13 @@ public function testGeocodeStreetTypeQuery()
$this->assertEquals('Avenue Kléber', $result->getStreetName());
$this->assertEquals('75016', $result->getPostalCode());
$this->assertEquals('Paris', $result->getLocality());
$this->assertCount(4, $result->getAdminLevels());
$this->assertEquals('Île-de-France', $result->getAdminLevels()->get(2)->getName());
$this->assertEquals('Paris', $result->getAdminLevels()->get(3)->getName());
$this->assertEquals('75', $result->getAdminLevels()->get(3)->getCode());
$this->assertEquals('Paris', $result->getAdminLevels()->get(4)->getName());
$this->assertEquals('75116', $result->getAdminLevels()->get(4)->getCode());
$this->assertEquals('Paris 16e Arrondissement', $result->getAdminLevels()->get(5)->getName());
}

public function testGeocodeLocalityQuery()
Expand Down