README

Пакет предоставляет удобный способ ипорта стран, регионов и городов используя api vk.com.

Пакет использует atehnix/vk-client для выполнения запросов. Используются синхронные запросы, если вы хотите постоянно обновлять данные, то используйте пакет atehnix/laravel-vk-requester

Содержание

Установка
Импорт данных
Использование

Установка

Вы можете установить данный пакет с помощью сomposer:

composer require sequelone/laravel-vk-geo

Далее необходимо зарегистровать новый сервис-провайдер в config/app.php:

...
'providers' => [
    ...
     Sequelone\VkGeo\VkGeoServiceProvider::class,
],
...

Конфигурация

Сначала необходимо создать необходимые таблицы в базе данных, для этого импортируйте файлы миграций из пакета используя artisan:

php artisan vendor:publish --provider=Sequelone\VkGeo\VkGeoServiceProvider

Также создастся файл конфигурации config/vk-geo.php. После чего необходимо применить миграции:

php artisan migrate

Добавьте роут в routes/web.php.

Route::get('/vkauth', [App\Http\Controllers\VkAccessTokenController::class, 'vkaccesstoken'])->name('vkaccesstoken');

В .env необходимо добавить, данные вашего vk приложения:

VKONTAKTE_KEY={введите здесь ID Standalone-приложения}
VKONTAKTE_SECRET={здесь защищённый ключ}
VKONTAKTE_REDIRECT_URI={здесь ссылку на страницу https://mysite.com/vkauth}

Также для выполнения импорта получить токен (Где взять api токен?) приложения и добавить в .env:

VKONTAKTE_TOKEN={после получения токена со страницы /vkauth скопируйте и вставьте его сюда}

Либо переопределить токен в config/vk-geo.php.

Импорт осуществляется через консоль.

Импорт всех стран

php artisan vk:import-countries

Импорт регионов

Импорт регионов для всех стран

php artisan vk:import-regions

Возможен также и импорт для отдельных стран по их id

php artisan vk:import-regions --countryId=1 --countryId=2

Импорт городов

Импорт городов для отдельных стран

php artisan vk:import-cities --countryId=1 --countryId=2

Импорт городов для отдельных регионов

php artisan vk:import-cities --regionId=1014032 --regionId=1048584

Если вам нужен импорт для всех стран и всех регионов, то можно запустить компанду без параметров, но данный способ не тестировался, и скорее всего будут ошибки связанные с ответом от серверов VK. Вы также можете переопределить любую из консольных команд, создав собсвтенные и отнаследовавшись от оригинальных.

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

Использовать пакет достаточно просто. В пакет входят eloquent модели города, региона и страны (City, Region, Country). Вы можете вызывать модели в контроллерах:

namespace App\Http\Controllers;

use Sequelone\VkGeo\Models\City;

class Controller
{
    protected function show($name){

        $city = City::where('title', $name)->first();

    }
}

У каждой модели есть title, id, у городов есть area (район), также настроенны связи между моделями. При необходимости можете также переопределить их.

sequelone / laravel-vk-geo

Maintainers

Details