README

包含印尼所有省份、县/市和区和村庄/乡村数据的Laravel包。是从laravolt/indonesia分叉而来，已修改用于API。区域数据来自edwardsamuel/Wilayah-Administratif-Indonesia。

安装

通过Composer安装包

composer require badak/indonesia

注册Service Provider和Facade（适用于Laravel < 5.5）

从5.5版本开始，Laravel已经支持自动发现功能，因此不再需要手动注册Service Provider和Facade。

在config.app中添加Service Provider和Facade

'providers' => [

    Badak\Indonesia\ServiceProvider::class

]

'aliases' => [

    'Indonesia' => Badak\Indonesia\Facade::class

]

为Lumen注册Service Provider和Facade

在文件bootstrap/app.php中，取消以下行的注释

$app->withFacades();
$app->withEloquent();

在文件bootstrap/app.php中，通过添加以下代码来注册service provider和alias/facade

$app->register(Badak\Indonesia\ServiceProvider::class);


// class aliases
class_alias(Badak\Indonesia\Facade::class, 'Indonesia');

要设置表前缀，创建文件config/wilayah-indonesia.php，然后复制以下代码（将indonesia_替换为所需的表前缀），

<?php

return [
    'indonesia' => [
        'table_prefix' => 'indonesia_',
    ],
];

然后通过添加以下代码在bootstrap/app.php中注册配置。

$app->configure('wilayah-indonesia');

之后，可以通过config('wilayah-indonesia.table_prefix')来调用配置。

发布迁移（仅适用于Laravel/Lumen 5.2）

如果您使用的是Laravel/Lumen 5.3及以上版本，请忽略以下步骤。对于Laravel

php artisan vendor:publish --provider="Badak\Indonesia\ServiceProvider"

对于Lumen，需要手动将迁移文件从vendor/badak/indonesia/database/migrations目录或Migrations复制到文件中

运行迁移

php artisan migrate

运行Seeder以填充区域数据

php artisan badak:indonesia:seed

要将Seeder添加到文件DatabaseSeeder.php中，请参考以下示例

namespace Database\Seeders;

use Illuminate\Database\Seeder;
use Badak\Indonesia\Models\Desa;
use Badak\Indonesia\Models\Kecamatan;
use Badak\Indonesia\Models\Kokab;
use Badak\Indonesia\Models\Provinsi;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database.
     *
     * @return void
     */
    public function run()
    {
        $this->call([
            $this->call(ProvinsiSeeder::class);
            $this->call(KokabSeeder::class);
            $this->call(KecamatanSeeder::class);
            $this->call(DesaSeeder::class);
        ]);
    }
}

使用示例

\Indonesia::allProvinces()
\Indonesia::paginateProvinces($numRows = 15)
\Indonesia::allCities()
\Indonesia::paginateCities($numRows = 15)
\Indonesia::allDistricts()
\Indonesia::paginateDistricts($numRows = 15)
\Indonesia::allVillages()
\Indonesia::paginateVillages($numRows = 15)

\Indonesia::findProvince($kode, $with = null)
// array $with : ['kokab', 'kecamatan', 'desa', 'kokab.kecamatan', 'kokab.kecamatan.desa', 'kecamatan.desa']

\Indonesia::findCity($kode, $with = null)
// array $with : ['provinsi', 'kecamatan', 'desa', 'kecamatan.desa']

Indonesia::findDistrict($kode, $with = null)
// array $with : ['provinsi', 'kokab', 'kokab.provinsi', 'desa']

\Indonesia::findVillage($kode, $with = null)
// array $with : ['provinsi', 'kokab', 'kecamatan', 'kecamatan.kokab', 'kecamatan.kokab.provinsi']

示例

Indonesia::findProvince(11, ['kokab']);

/*
Will return
Provinsi Object {
    'kode' => 11,
    'nama' => 'ACEH',
    'kokab' => Kokab Collections {
        Kokab Object,
        Kokab Object,
        Kokab Object,
        ...
    }
}
*/

Indonesia::findProvince(11, ['kokab', 'kecamatan.desa']);

/*
Will return
Provinsi Object {
    'kode' => 11,
    'nama' => 'ACEH',
    'kokab' => Kokab Collections {
        Kokab Object,
        Kokab Object,
        Kokab Object,
        ...
    },
    'kecamatan' => Kecamatan Collections {
        Kecamatan Object {
            'kode' => 1101010
            'kode_kokab' => '1101'
            'nama' => 'TEUPAH SELATAN'
            'kode_provinsi' => '11'
            'desa' => Desa Colletions {
                Desa Object,
                Desa Object,
                Desa Object,
                ...
            }
        },
        ...
    }
}
*/

\Indonesia::search('yogyakarta')->all()
\Indonesia::search('yogyakarta')->allProvinces()
\Indonesia::search('yogyakarta')->paginateProvinces()
\Indonesia::search('yogyakarta')->allCities()
\Indonesia::search('yogyakarta')->paginateCities()
\Indonesia::search('yogyakarta')->allDistricts()
\Indonesia::search('yogyakarta')->paginateDistricts()
\Indonesia::search('yogyakarta')->allVillages()
\Indonesia::search('yogyakarta')->paginateVillages()

测试

运行

vendor/bin/phpunit tests