php-extended/php-api-fr-gouv-api-geo-object

A library that implements the php-extended/php-api-fr-gouv-api-geo-interface library

7.0.7 2024-12-10 22:50 UTC

Requires

• php: >=8.0
• php-extended/php-api-fr-gouv-api-geo-interface: ^7
• php-extended/php-data-provider-array: ^7
• php-extended/php-data-provider-json: ^7
• php-extended/php-geojson-object: ^7
• php-extended/php-http-message-factory-psr17: ^7
• php-extended/php-reifier-object: ^7

Requires (Dev)

• php-extended/placeholder-phpunit: ^9

MIT

• Anastaszor

• php
• api
• object
• implementation
• api.geo.gouv.fr

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.phar from 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 ^7

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).