php-extended / php-api-fr-gouv-api-geo-object
A library that implements the php-extended/php-api-fr-gouv-api-geo-interface library
Package info
gitlab.com/php-extended/php-api-fr-gouv-api-geo-object
pkg:composer/php-extended/php-api-fr-gouv-api-geo-object
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2026-05-20 17:25:34 UTC
README
A library that implements the php-extended/php-api-fr-gouv-api-geo-interface library.
Installation
The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.
- Download
composer.pharfrom their website. - Then run the following command to install this library as dependency :
php composer.phar php-extended/php-api-fr-gouv-api-geo-object ^9
Basic Usage
This library may be used the following way :
use PhpExtended\GeoApiGouvFr\GeoApiGouvFrEndpoint;
/** @var $client \Psr\Http\Client\ClientInterface */
$endpoint = new GeoApiGouvFrEndpoint($client);
foreach($endpoint->getRegions() as $region)
{
// do something with regions
}
foreach($endpoint->getDepartements() as $departement)
{
// do something with departements
}
foreach($endpoint->getCommunes() as $commune)
{
// do something with communes
}
Note that the $endpoint->getCommunes() method does not recover
the polygons about the communes. To have them, you have to get communes
from each departement like so :
foreach($endpoint->getDepartements() as $departement)
{
foreach($endpoint->getCommunesFromDepartement($departement->getCode()) as $commune)
{
$commune->getGeometry(); // polygon or multi polygon
}
}
License
MIT (See license file).