phelium/geoapifr

GeoApi France

1.0 2017-08-16 07:19 UTC

Requires

• php: >=5.3.0

GNU GPL 3.0

• ShevAbam

• geo
• api
• france

README

Wrapper PHP de l'API Geo fournie par le gouvernement français.

Installation

Avec Composer, ajoutez cette ligne dans votre fichier composer.json :

"phelium/geoapifr": "dev-master"

Lancez ensuite composer update.

Ou, exécutez simplement cette commande dans votre terminal :

composer require phelium/geoapifr

Utilisation

require 'vendor/autoload.php';

use Phelium\Component\GeoApiFr;

Communes

Pour avoir les détails d'une commune, utilisez la méthode communes().

Les champs disponibles en retour sont :

Les champs autorisés pour la recherche sont :

Exemple de recherche de la commune dont le nom est "Versailles" :

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->communes()
    ->fields(array('code', 'codeDepartement', 'codeRegion', 'nom'))
    ->search('nom', 'Versailles');

Retour :

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/communes?nom=Versailles&fields=code,codeDepartement,codeRegion,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 78646
                    [codeDepartement] => 78
                    [codeRegion] => 11
                    [nom] => Versailles
                    [_score] => 1
                )

        )
)

Départements

Pour avoir les détails d'un département, utilisez la méthode departements().

Les champs disponibles en retour sont :

Les champs autorisés pour la recherche sont :

Exemple de recherche du département dont le code est "2A" :

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->departements()
    ->fields(array('code', 'codeRegion', 'nom'))
    ->search('code', '2A');

Retour :

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/departements?code=2A&fields=code,codeRegion,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 2A
                    [codeRegion] => 94
                    [nom] => Corse-du-Sud
                )

        )
)

Régions

Pour avoir les détails d'une région, utilisez la méthode regions().

Les champs disponibles en retour sont :

Les champs autorisés pour la recherche sont :

Exemple de recherche de la région dont le code est "94" :

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->regions()
    ->fields(array('code', 'nom'))
    ->search('code', '94');

Retour :

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/regions?code=94&fields=code,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 94
                    [nom] => Corse
                )

        )
)