postcodes io

Почтовые индексыIO

PostcodesIO — это PHP-библиотека для API postcodes.io.

Установить

Установить с помощью композитора:

 $ composer require jabranr/postcodes-io

Документация

Все следующие методы возвращают тот же полный ответ, который поступает от API postcodes.io в формате JSON.

Разработка

Предварительные условия

• Докер

• Запустить контейнер: docker-compose up

• Запустите тесты: docker-compose exec postcodes_io bash -c "composer test"

Отладка Xdebug уже установлен и включен как часть настройки докера. Проект включает файл настройки отладки launch.json для VSCode.

Найти информацию о почтовом индексе

 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 – настоящее время | Джабран Рафик