Laradeck Address Generator

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Генерация реальных адресов для нужд разработки., _(*2)

В отличии от Faker адреса реальныe для каждого города и их можно выводить на карту. Теперь у тестировщика не будет вопросов - почему маркер на карте не совпадает с адресом и как это объяснить клиенту/заказчику., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require ngtfkx/laradeck-address-generator, _(*5)


Если необходимы консольные команды или подключение своих источников данных, то добавьте в файл `config/app.php` (для версий <=5.4.*) 
сервис-провайдер

``` php
Ngtfkx\Laradeck\AddressGenerator\LaradeckAddressGeneratorServiceProvider::class,

Usage

Получение случайного адреса для любого из городов, который есть в пакете, _(*6)

``` php $generator = new \Ngtfkx\Laradeck\AddressGenerator\Generator(); $address = $generator->getRandomAddress();, _(*7)


Получение случайного адреса для любого из указанных городов

``` php
$generator = new \Ngtfkx\Laradeck\AddressGenerator\Generator();
$generator->setCities('Tomsk', 'nsk', 'Омск'); // можно передавать массив
$generator->addCity('новосибирск'); // добавит город к ранее установленным
$address = $generator->getRandomAddress(); // адрес будет для какого-то из вышеуказанных 4-х горолдов

Documentation

Получение адреса

Для получения адреса существуют следующие методы, _(*8)

getRandomAddress($forCity = null): Address - получить один адрес
getRandomAddresses(int $count, $forCity = null): Collection - получить коллекцию с указанным кол-ом адресов

По умолчанию случайный адрес может быть сгенерирован для любого из поддерживаемых городов (если алиас города не указан параметром), _(*9)

Установка города

Если надо сгенерировать адрес для конкретного города(ов), то надо принудительно указать эти города. Для этого есть следующие методы, _(*10)

addCity(string $city): Generator - добавить город по его алиасу в список использованных
addCities(...$cities): Generator - добавить несколько городов (можно через запятую, можно массивом)
setCities(...$cities): Generator - добавить несколько городов, обнулись ранее добавленные

Объект типа Address

Содержить следующие методы, _(*11)

getFull(): string - получить полный адрес (с городом, улицей и номером дома)
getInsideLocality(): string - получить адрес нутри населенного пункта (только улица и номер дома)
getLocality(): string - получить наименование населенного пункта
getStreet(): string - получить наименование улицы
getBuilding(): string - получить номер дома

Структура хранения данных

Данные для генерации адресов по городам храняться в папке data/ru в файле {cityId}.php в виде массива, где {cityId} - id города в системе http://nominatim.openstreetmap.org/, _(*12)

``` php return [ "1 Восточный спуск" => ["100", "101", "102"], "1-й квартал" => ["13", "2a", "3/1", "4", "5", "6"], ];, _(*13)


Информация о списке поддерживаемых городов и их алиасах хранится в файле `data/ru/cities.php`  виде массива

``` php
return [
    '173343488' => [
        'Омск',
        'Omsk',
    ],
    '173436661' => [
        'Новосибирск',
        'Nsk',
        'Novo-sibirsk',
        'Нск',
    ],
];

Подключение пользовательских данных

Для подключения пользовательских данных положите файл аналогичной структуры (см. Структура хранения данных) в любое место и укажите абсолютный путь до него от корня диска. Далее подключаете данные следующим образом, _(*14)

php $generator = new Generator(); $generator->loadCustomData(111, 'Нефтебаза', storage_path('app/111.php'));, _(*15)

Теперь адреса населенного пункта Нефтебаза доступны для генерации., _(*16)

Статистика

Для получения информации о доступных городах и адресах есть консольная команда php artisan address:stat, _(*17)

Генерация своих файлов данных

Для генерации файла данных есть консольная команда php artisan address:city-address-ru {city} {url} {--limit=0}, _(*18)

{city} - id города в системе http://nominatim.openstreetmap.org/
{url} - первая страница города со списком улиц на сайте http://www.city-address.ru/, например вот такая
{--limit=0} - кол-во обрабатываемых страниц (0 - все)