snairbef/regional

This is my package regional

v1.2.1 2025-03-18 06:24 UTC

This package is auto-updated.

Last update: 2025-05-18 22:28:36 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Indonesian Regional Dependency adalah package Laravel yang dirancang untuk mempermudah pengelolaan data wilayah Indonesia, seperti provinsi, kabupaten/kota, kecamatan, hingga kelurahan. Package ini menyediakan model siap pakai, relasi bawaan, serta fungsi untuk mengimpor data wilayah ke dalam database Anda menggunakan file CSV yang disertakan (provinces.csv, regencies.csv, districts.csv, sub_districts.csv).

Penggunaannya sederhana dan intuitif, menyerupai penggunaan model bawaan Laravel. Anda cukup memanggil model seperti Snairbef\Regional\Models\Province atau Snairbef\Regional\Models\Regency, lengkap dengan dukungan untuk Repository Pattern melalui interface yang dapat langsung diinject ke dalam controller Anda.

Installation

You can install the package via composer:

composer require snairbef/regional

Now you can install the package to Laravel Project:

php artisan regional:install

You can run the migrations with:

php artisan migrate

You can import data from the csv that we have provided:

php artisan regional:import

Usage (Model)

use Snairbef\Regional\Models\Province;

$province = Province::with(['regencies']);
dd($province->get());

or

$province = Province::search('Jawa');
dd($province);

Usage (Repository)

use Illuminate\Routing\Controller;
use Snairbef\Regional\Contracts\Repositories\ProvinceRepository;

class YourController extends Controller
{
    public function __construct(
        protected ProvinceRepository $province
    ) {}

    public function index()
    {
        $province = $this->province->with(['regencies']);
        dd($province->get());

        or

        $province = $this->province->search('Jawa');
        dd($province);
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.