postcodes io

PostleitzahlenIO

PostcodesIO ist eine PHP-Bibliothek für die postcodes.io-API.

Installieren

Mit Composer installieren:

 $ composer require jabranr/postcodes-io

Dokumentation

Alle folgenden Methoden geben dieselbe vollständige Antwort zurück, die von der postcodes.io-API im JSON-Format kommt.

Entwicklung

Voraussetzungen

• Docker

• Startcontainer: docker-compose up

• Führen Sie Tests aus: docker-compose exec postcodes_io bash -c "composer test"

Debugging Xdebug ist bereits als Teil des Docker-Setups installiert und aktiviert. Das Projekt enthält die Debug-Setup-Datei launch.json für VSCode.

Finden Sie Postleitzahlinformationen

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();

try {
  $ addresses = $ postcodesIO -> find ( ' NW1 5LD ' );
} catch (  Exception $ e ) {
  echo $ e -> getMessage ();
}

Sie können eine bestimmte JabranrPostcodesIOExceptionPostcodeIOException oder/und eine allgemeine Exception abfangen, um jeden Typ abzufangen.

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ( ' NW1 5LD ' );
$ addresses = $ postcodesIO -> getResult ();

Finden Sie Postleitzahlinformationen nach geografischem Standort

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> findByLocation ( 51.520331 , - 0.1396267 );

Finden Sie zufällige Postleitzahleninformationen

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> findRandom ();

ODER verwenden Sie die Alias-Methode:

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> random ();

Validieren Sie eine Postleitzahl

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> validate ( ' NW1 5LD ' );

Finden Sie nächstgelegene Postleitzahlen

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> findNearest ( ' NW1 5LD ' );

ODER verwenden Sie die Alias-Methode:

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> nearest ();

Erhalten Sie eine automatisch vervollständigte Liste einer Postleitzahl/Outcode

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> autocomplete ( ' NW1 ' );

Suchen Sie eine Postleitzahl

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> query ( ' NW1 5LD ' );

ODER verwenden Sie die Alias-Methode:

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> search ( ' NW1 5LD ' );

Finden Sie einen Outcode

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> findOutcode ( ' NW1 ' );

Finden Sie die nächstgelegenen Outcodes

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> nearestOutcode ( ' NW1 ' );

Finden Sie einen Outcode nach Standort

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> findOutcodeByLocation ( 51.520331 , - 0.1396267 );

Massensuche nach Postleitzahlen

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> bulkPostcodeSearch ( array ( ' NW1 5LD ' , ' W1T 7NY ' ));

Maximal 100 Postleitzahlen pro Anfrage.

Massen-Reverse-Geokodierung

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> bulkReverseGeocoding ( array (
    array ( 51.520331 , - 0.1396267 ),
    array ( 51.520331 , - 0.1396267 )
));

oder

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();
$ addresses = $ postcodesIO -> bulkReverseGeocoding ( array (
    array ( ' latitude ' => 51.520331 , ' longitude ' => - 0.1396267 ),
    array ( ' latitude ' => 51.520331 , ' longitude ' => - 0.1396267 )
));

Maximal 100 Geolokationen pro Anfrage.

Lizenz

MIT-Lizenz © 2016 – heute | Jabran Rafique