- Notifications
You must be signed in to change notification settings - Fork0
PHP клиент для API почтовых индексов России
License
sanmai/pindx-client
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Клиент дляAPI почтовых индексов
Установка делается как обычно.
composer require sanmai/pindx-client
$client =new \RussianPostIndex\Client();$office =$client->getOffice(101000);
Возвращает или объект имплементирующий интерфейсRecord
, или, если такого отделения нет,null
. Нет необходимости как-то отдельно проверять корректность индекса. Если индекса в БД нет, то вернётсяnull
.
Конструктор класса\RussianPostIndex\Client
опционально берёт на вход стандартныйинтерфейс клиента Guzzle, что позволяет добавить подключение через прокси или поменять используемый сервер, поднять таймауты для соединения.
<?phprequire'vendor/autoload.php';$postalCode =130980;$client =new \RussianPostIndex\Client();if ($office =$client->getOffice($postalCode)) {var_dump($office->getIndex());// int(130980)var_dump($office->getName());// string(25) "Москва EMS ММПО"var_dump($office->getType());// string(8) "ММПО"var_dump($office->getSuperior());// int(104040)var_dump($office->getRegion());// string(12) "Москва"var_dump($office->getAutonomousRegion());// string(0) ""var_dump($office->getArea());// string(0) ""var_dump($office->getCity());// string(0) ""var_dump($office->getDistrict());// string(0) ""var_dump($office->getDate()->format('Y-m-d'));// string(10) "2017-04-28"}
Интерфейс объекта содержит следующие методы для получения данных об отделении:
/** * Почтовый индекс объекта почтовой связи в соответствии с действующей системой индексации. */$office->getIndex();/** * Наименование объекта почтовой связи. */$office->getName();/** * Тип объекта почтовой связи. */$office->getType();/** * Индекс вышестоящего по иерархии подчиненности объекта почтовой связи. */$office->getSuperior();/** * Наименование области, края, республики, в которой находится объект почтовой связи. */$office->getRegion();/** * Наименование автономной области, в которой находится объект почтовой связи. */$office->getAutonomousRegion();/** * Наименование района, в котором находится объект почтовой связи. */$office->getArea();/** * Наименование населенного пункта, в котором находится объект почтовой связи. */$office->getCity();/** * Наименование подчиненного населенного пункта, в котором находится объект почтовой связи. */$office->getDistrict();/** * Дата актуализации информации об объекте почтовой связи. * @return DateTimeInterface */$office->getDate();
Потому чтотак называются исходные файлы от почты. Конечно, они называются используя смешанный регистр, PIndx, но в именах пакетов в Composer не рекомендуется использовать такой формат. Потомуpindx
.
About
PHP клиент для API почтовых индексов России