README

LARAVOLT INDONESIA

包含印度尼西亚所有省份、县/市、区和村庄/乡村数据的Laravel包。区域数据来源于edwardsamuel/Wilayah-Administratif-Indonesia

安装

通过Composer安装包

composer require laravolt/indonesia

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

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

在config.app中添加Service Provider和Facade

'providers' => [

    Laravolt\Indonesia\ServiceProvider::class

]

'aliases' => [

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

]

为Lumen注册Service Provider和Facade

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

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

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

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


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

为了设置表前缀，创建文件config/laravolt.php，然后复制以下代码（将indonesia_替换为您想要的表前缀），

<?php

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

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

$app->configure('laravolt');

之后，可以通过config('laravolt.indonesia.table_prefix')的方式调用配置。

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

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

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

对于Lumen，必须手动从目录vendor/laravolt/indonesia/database/migrations或Migrations复制迁移文件

运行迁移

php artisan migrate

运行Seeder以填充区域数据

php artisan laravolt:indonesia:seed

要将Seeder添加到文件DatabaseSeeder.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,
        ]);
    }
}

用法

\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($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']

示例

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,
                ...
            }
        },
        ...
    }
}
*/

\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()

测试

运行

vendor/bin/phpunit tests