hanzoalpha / laravel-wilayah

Laravel 印尼 Wilayah 数据包

v1.0.2 2023-10-08 15:35 UTC

README

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

为印度尼西亚行政数据提供的 Laravel 数据包。

这是印度尼西亚 wilayah 的 Laravel 版本,只提供模型、迁移、seeder。

支持我们

我们投入了大量资源来创建 最佳开源包。您可以通过 购买我们的付费产品之一 来支持我们。

我们非常感谢您从您的家乡寄给我们一张明信片,注明您正在使用我们哪个包。您可以在 我们的联系页面 上找到我们的地址。我们将所有收到的明信片发布在我们的 虚拟明信片墙上

安装

您可以通过 composer 安装此包

composer require hanzoalpha/laravel-wilayah

您可以使用以下命令发布和运行迁移

php artisan vendor:publish --tag="laravel-wilayah-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="laravel-wilayah-config"

这是发布配置文件的内容

return [
    'table_prefix' => 'ind_',

    /**
     * API Configuration.
     */
    'api' => [
        /**
         * If enabled, this will load Indonesia API.
         * - https://:8000/api/wilayah/provinces
         * - https://:8000/api/wilayah/cities
         * - https://:8000/api/wilayah/districts
         * - https://:8000/api/wilayah/villages
         */
        'enabled' => true,

        /**
         * The middleware for Indonesia API.
         */
        'middleware' => ['api'],

        /**
         * The route name for Indonesia API.
         */
        'route_name' => 'api.wilayah',

        /**
         * The route prefix for Indonesia API.
         */
        'route_prefix' => 'api/wilayah',

        /**
         * Specify which column will be displayed in the response data.
         * Only support columns from database.
         */
        'response_columns' => [
            //.
            'province' => ['code', 'name'],

            'city' => ['city_code', 'province_code', 'name'],

            'district' => ['district_code', 'city_code', 'name'],

            'village' => ['village_code', 'district_code', 'name'],

            'island' => ['province_code', 'city_code', 'island_code', 'name'],
        ],
];

可选地,您可以使用以下命令发布视图

php artisan vendor:publish --tag="laravel-wilayah-views"

使用方法

$laravelWilayah = new HanzoAlpha\LaravelWilayah();
echo $laravelWilayah->echoPhrase('Hello, HanzoAlpha!');

测试

  ./vendor/bin/pest

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请查看 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。