Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravolt/indonesia
Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di seluruh Indonesia.
https://github.com/laravolt/indonesia
Last synced: about 2 months ago
JSON representation
Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di seluruh Indonesia.
- Host: GitHub
- URL: https://github.com/laravolt/indonesia
- Owner: laravolt
- License: mit
- Created: 2016-07-15T09:39:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T13:56:28.000Z (3 months ago)
- Last Synced: 2024-07-18T22:38:38.124Z (2 months ago)
- Language: PHP
- Size: 9.05 MB
- Stars: 554
- Watchers: 25
- Forks: 198
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-indo-projects - Laravolt Indonesia - Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di Indonesia. (Laravel)
- awesome-made-by-indonesian - LARAVOLT INDONESIA - `Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di seluruh Indonesia.` *by [Laravolt](https://github.com/laravolt)* (L)
- made-in-indonesia - LARAVOLT INDONESIA - `Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di seluruh Indonesia.` *by [Laravolt](https://github.com/laravolt)* (L)
- awesome-indonesia-repo - Laravolt Indonesia - Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di Indonesia. (Laravel)
README
[](https://github.styleci.io/repos/63410706)
[](https://travis-ci.org/laravolt/indonesia)
[](https://coveralls.io/github/laravolt/indonesia?branch=master)
# LARAVOLT INDONESIA
Package Laravel yang berisi data Provinsi, Kabupaten/Kota, dan Kecamatan/Desa di seluruh Indonesia.
Data wilayah diambil dari [edwardsamuel/Wilayah-Administratif-Indonesia](https://github.com/edwardsamuel/Wilayah-Administratif-Indonesia)
## Instalasi
### Install Package Via Composer
```
composer require laravolt/indonesia
```
### Daftarkan Service Provider dan Facade (Untuk Laravel < 5.5)
Mulai versi 5.5 ke atas, Laravel sudah support fitur auto discover sehingga tidak perlu lagi mendaftarkan Service Provider dan Facade secara manual.
Tambahkan Service Provider dan Facade pada `config.app`
```php
'providers' => [
Laravolt\Indonesia\ServiceProvider::class
]
```
```php
'aliases' => [
'Indonesia' => Laravolt\Indonesia\Facade::class
]
```
### Daftarkan Service Provider dan Facade untuk Lumen
Dalam file `bootstrap/app.php`, uncomment baris berikut
```php
$app->withFacades();
$app->withEloquent();
```
Dalam file `bootstrap/app.php`, daftarkan service provider dan alias/facade dengan menambahkan kode berikut.
```php
$app->register(Laravolt\Indonesia\ServiceProvider::class);
// class aliases
class_alias(Laravolt\Indonesia\Facade::class, 'Indonesia');
```
Untuk mengatur prefix tabel, buat file `config/laravolt.php`, lalu copy kode berikut (ganti `indonesia_` dengan nilai prefix tabel yang diinginkan),
```php
[
'table_prefix' => 'id_',
],
];
```
Lalu daftarkan konfigurasi dalam `bootstrap/app.php` dengan menambahkan kode berikut.
```php
$app->configure('laravolt');
```
Untuk selanjutnya, konfigurasi bisa dipanggil dengan cara `config('laravolt.indonesia.table_prefix')`.
### Publish Migration (Hanya Untuk Laravel/Lumen 5.2)
Jika Anda menggunakan Laravel/Lumen versi 5.3 ke atas, abaikan langkah di bawah ini.
Untuk Laravel:
```php
php artisan vendor:publish --provider="Laravolt\Indonesia\ServiceProvider"
```
Untuk Lumen, file migrations harus di-copy manual dari direktori `vendor/laravolt/indonesia/database/migrations` atau [Migrations](database/migrations/)
### Jalankan Migration
```php
php artisan migrate
```
### Jalankan Seeder Untuk Mengisi Data Wilayah
```php
php artisan laravolt:indonesia:seed
```
### Untuk menambahkan seedernya ke file `DatabaseSeeder.php` ikuti contoh berikut:
```php
namespace Database\Seeders;
use Illuminate\Database\Seeder;
use Laravolt\Indonesia\Seeds\CitiesSeeder;
use Laravolt\Indonesia\Seeds\VillagesSeeder;
use Laravolt\Indonesia\Seeds\DistrictsSeeder;
use Laravolt\Indonesia\Seeds\ProvincesSeeder;
class DatabaseSeeder extends Seeder
{
/**
* Seed the application's database.
*
* @return void
*/
public function run()
{
$this->call([
ProvincesSeeder::class,
CitiesSeeder::class,
DistrictsSeeder::class,
VillagesSeeder::class,
]);
}
}
```
## Penggunaan
```php
\Indonesia::allProvinces()
\Indonesia::paginateProvinces($numRows = 15)
\Indonesia::allCities()
\Indonesia::paginateCities($numRows = 15)
\Indonesia::allDistricts()
\Indonesia::paginateDistricts($numRows = 15)
\Indonesia::allVillages()
\Indonesia::paginateVillages($numRows = 15)
```
---
```php
\Indonesia::findProvince($provinceId, $with = null)
// array $with : ['cities', 'districts', 'villages', 'cities.districts', 'cities.districts.villages', 'districts.villages']
\Indonesia::findCity($cityId, $with = null)
// array $with : ['province', 'districts', 'villages', 'districts.villages']
Indonesia::findDistrict($districtId, $with = null)
// array $with : ['province', 'city', 'city.province', 'villages']
\Indonesia::findVillage($villageId, $with = null)
// array $with : ['province', 'city', 'district', 'district.city', 'district.city.province']
```
#### Examples
```php
Indonesia::findProvince(11, ['cities']);
/*
Will return
Province Object {
'id' => 11,
'name' => 'ACEH',
'cities' => City Collections {
City Object,
City Object,
City Object,
...
}
}
*/
Indonesia::findProvince(11, ['cities', 'districts.villages']);
/*
Will return
Province Object {
'id' => 11,
'name' => 'ACEH',
'cities' => City Collections {
City Object,
City Object,
City Object,
...
},
'districts' => District Collections {
District Object {
'id' => 1101010
'city_id' => '1101'
'name' => 'TEUPAH SELATAN'
'province_id' => '11'
'villages' => Village Colletions {
Village Object,
Village Object,
Village Object,
...
}
},
...
}
}
*/
```
---
```php
\Indonesia::search('jakarta')->all()
\Indonesia::search('jakarta')->allProvinces()
\Indonesia::search('jakarta')->paginateProvinces()
\Indonesia::search('jakarta')->allCities()
\Indonesia::search('jakarta')->paginateCities()
\Indonesia::search('jakarta')->allDistricts()
\Indonesia::search('jakarta')->paginateDistricts()
\Indonesia::search('jakarta')->allVillages()
\Indonesia::search('jakarta')->paginateVillages()
```
---
# Testing
Run
```
vendor/bin/phpunit tests
```