arthurydalgo/laravel-settings

将键值对存储在数据库中作为设置

1.1 2022-01-03 19:44 UTC

README

Latest Version on Packagist Software License Build Status StyleCI Total Downloads

使用qcod/laravel-settings在数据库中存储键值对设置。

所有保存到数据库中的设置都进行缓存,以提高性能,减少SQL查询到零。

安装

1 - 您可以通过composer安装此包

$ composer require qcod/laravel-settings

2 - 如果您正在安装Laravel 5.4或更低版本,您需要手动通过将服务提供者在config/app.php的providers数组中添加,并在aliases数组中添加外观来注册服务提供者。

'providers' => [
    //...
    QCod\Settings\SettingsServiceProvider::class
]

'aliases' => [
    //...
    "Settings" => QCod\Settings\Facade::class
]

在Laravel 5.5或更高版本中,服务提供者将自动注册,并且将有一个外观Setting::get('app_name')可用。

3 - 现在运行php artisan migrate来创建设置表。

可选地,您可以通过运行以下命令发布迁移:

php artisan vendor:publish --provider="QCod\Settings\SettingsServiceProvider" --tag="migrations"

入门

您可以使用辅助函数settings('app_name')Settings::get('app_name')来使用laravel设置。

可用方法

// Pass `true` to ignore cached settings
settings()->all($fresh = false);

// Get a single setting
settings()->get($key, $defautl = null);

// Set a single setting
settings()->set($key, $value);

// Set a multiple settings
settings()->set([
   'app_name' => 'QCode',
   'app_email' => 'info@email.com',
   'app_type' => 'SaaS'
]);

// check for setting key
settings()->has($key);

// remove a setting
settings()->remove($key);

v 1.0.6开始,您可以将设置组织到组中。如果您跳过组名,则将设置存储为具有default组名。

如果您是从先前版本进行更新,请务必运行迁移

您拥有上述所有方法,只需通过调用->group('group_name')方法设置您的工作组并继续链式操作即可。

settings()->group('team.1')->set('app_name', 'My Team App');
settings()->group('team.1')->get('app_name');
> My Team App

settings()->group('team.2')->set('app_name', 'My Team 2 App');
settings()->group('team.2')->get('app_name');
> My Team 2 App

// You can use facade
\Settings::group('team.1')->get('app_name')
> My Team App

变更日志

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

测试

此包包含一些与Orchestra一起设置的集成/冒烟测试,可以通过phpunit运行这些测试。

$ composer test

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件saquibweb@gmail.com而不是使用问题跟踪器。

鸣谢

关于QCode.in

QCode.in (https://www.qcode.in) 是由Saqueib编写的一个博客,涵盖了有关全栈Web开发的各个方面。

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。