turkialawlqy/laravel-settings

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

1.0.2 2021-11-08 10:40 UTC

This package is auto-updated.

Last update: 2024-09-08 17:55:46 UTC


README

Latest Version on Packagist Software License StyleCI

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

所有保存在数据库中的设置都通过减少SQL查询至零来缓存以提高性能。

安装

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

$ composer require turkialawlqy/laravel-settings

2 - 如果您正在安装Laravel 5.4或更低版本,您需要手动注册Service Provider,将其添加到config/app.php的providers数组中,并将Facade添加到aliases数组中。

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

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

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

3 - 现在运行迁移php artisan migrate以创建设置表。

可选地,您可以通过运行来发布迁移

php artisan vendor:publish --provider="turkialawlqy\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' => 'turkialawlqy',
   'app_email' => 'turkialawlqy@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发送电子邮件,而不是使用问题跟踪器。

鸣谢

许可证

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