postcodes io

郵便番号IO

PostcodesIO は、postcodes.io API 用の PHP ライブラリです。

インストール

Composer を使用してインストールします。

 $ composer require jabranr/postcodes-io

ドキュメント

次のすべてのメソッドは、postcodes.io API からのものと同じ完全な応答を JSON 形式で返します。

発達

前提条件

• ドッカー

• コンテナーの開始: docker-compose up

• テストを実行します: docker-compose exec postcodes_io bash -c "composer test"

デバッグXdebug はすでにインストールされており、Docker セットアップの一部として有効になっています。プロジェクトには、VSCode のlaunch.jsonデバッグ セットアップ ファイルが含まれています。

郵便番号情報の検索

 use Jabranr  PostcodesIO  PostcodesIO ;

$ postcodesIO = new PostcodesIO ();

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

特定のJabranrPostcodesIOExceptionPostcodeIOExceptionをキャッチしたり、一般的なExceptionキャッチして任意のタイプをキャッチしたりできます。

 use Jabranr  PostcodesIO  PostcodesIO ;

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

地理的位置に基づいて郵便番号情報を検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

ランダムな郵便番号情報を検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

または、エイリアス メソッドを使用します。

 use Jabranr  PostcodesIO  PostcodesIO ;

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

郵便番号を検証する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

最寄りの郵便番号を検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

または、エイリアス メソッドを使用します。

 use Jabranr  PostcodesIO  PostcodesIO ;

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

郵便番号/アウトコードのオートコンプリートリストを取得する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

郵便番号を検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

または、エイリアス メソッドを使用します。

 use Jabranr  PostcodesIO  PostcodesIO ;

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

アウトコードを見つける

 use Jabranr  PostcodesIO  PostcodesIO ;

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

最も近いアウトコードを検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

場所からアウトコードを検索する

 use Jabranr  PostcodesIO  PostcodesIO ;

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

郵便番号の一括検索

 use Jabranr  PostcodesIO  PostcodesIO ;

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

リクエストごとに最大 100 個の郵便番号。

一括リバースジオコーディング

 use Jabranr  PostcodesIO  PostcodesIO ;

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

または

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

リクエストごとに最大 100 の地理位置情報。

ライセンス

MIT ライセンス © 2016 – 現在 |ジャブラン・ラフィケ