laraverse/atlas

Laravel 包,为您的下一个项目提供全面的全局数据

v1.0.5 2024-05-31 07:02 UTC

This package is auto-updated.

Last update: 2024-10-01 00:25:58 UTC


README

Atlas

Atlas

Laravel 包,为您的下一个项目提供全面的全局数据

安装

要安装此包,请使用 Composer

composer require laraverse/atlas

可选:服务提供程序将自动注册。或者,您可以在 bootstrap/providers.php 文件中手动添加服务提供程序

return [
    // ...
    Laraverse\Atlas\AtlasServiceProvider::class
];

您应该使用以下命令发布模型、迁移、视图、资源和配置文件

php artisan vendor:publish --provider="Laraverse\Atlas\AtlasServiceProvider"

注意:在发布供应商文件后,在项目根目录中访问 atlas 配置文件。通过 config/atlas/facilities.php 启用或禁用功能。

return [
    'enabled' => [
        # Tables::CITIES, (By default, It's disabled due to its large data size)
        Tables::COUNTRIES,
        Tables::CURRENCIES,
        Tables::PAYMENT_METHODS,
        Tables::PAYMENT_PRODUCTS,
        Tables::STATES,
        Tables::TIMEZONES,
        Tables::CONTINENTS,
    ],
]

您应该使用以下命令安装 atlas

# It will setup the atlas to serve comprehensive global data.
php artisan atlas:install

注意:由于数据量大,加载数据将需要一些时间。

用法

在您的项目文件中包含 atlas 客户端,如下所示

use Illuminate\Support\Collection;
use Laraverse\Atlas\Client;

class YourClass
{
    public function call(Client $client) : Collection
    {
        // Start using Atlas client.
        $client->getCurrencies();
    }
}

文档和用法说明

设置 Atlas 后,您可以通过导航到 /atlas/docs 访问内置文档模块。

或者,查看文档以获取详细的使用说明。

致谢

许可证

MIT 许可证(MIT)。有关更多信息,请参阅许可证文件

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献以获取详细信息。