README

Библиотека для приведения атрибутов, входящих в состав номеров домов, к человекопонятному виду.

Назначение

При работе с API Яндекс карт вместе с номером дома возвращаются аттрибуты номера дома. В них заключена информация о литере, корпусе и прочих параметрах, относящихся к номеру дома.

Примеры таких номеров: 55Б, 4к2, 2к2И, 16Ас312 и т.п.

Использование метода деатрибутирования позволит расшифровать их и превратить в текст понятный человеку. Так номер дома 16Ас312 превратится в дом 16, литера А, строение 312, а номер 2к2И в дом 2, корпус 2, литера И.

Установка

Библиотеку можно установить через composer:

composer require grachamite/house-deattr

Использование

Деатрибутирование адресов производится через статический метод deattribute.

Если деатртибутирование пройдет успешно, то результатом будет строка с декодированными атрибутами номера дома, в противном случае вернется null.

use Grachamite\HouseDeattr\Deattributer;

include 'vendor/autoload.php';


Deattributer::deattribute('12к7'); // 'дом 12, корпус 7'

Deattributer::deattribute('вл23Жк2сЕ'); // 'владение 23, литера Ж, корпус 2, строение Е'

Deattributer::deattribute('12УфлАуч6'); // 'дом 12, литера У, флигель А, участок 6'

Deattributer::deattribute('AFFsfe3'); // null

Лицензия

Zero-Clause BSD. Вы можете посмотреть текст лицензии для подробной информации.