README

laravel 简单的 key => value 全局/用户设置

安装

通过 Composer

$ composer require merodiro/settings

发布配置，可选：仅当您想编辑缓存配置时使用

$ php artisan vendor:publish --provider=Merodiro\Settings\SettingsServiceProvider

设置模型

use Merodiro\Settings\HasSettings;

class User extends Model
{
    use HasSettings;
    ...
}

用法

设置设置

如果键不存在则创建记录或存在则更新它

除了更新缓存外

// Global Settings
Settings::set('key', 'value');
Settings::set('key', 'another value');

// User Settings
$user->setSettings('key', 'value');
$user->setSettings('key', 'another value');

从设置中获取值

如果存在则返回其值或第二个参数

// Global Settings
$name = Settings::get('site-name');
$value = Settings::get('key', 'default');

// User Settings
$user->getSettings('site-name');
$user->getSettings('key', 'value');

从设置中删除键

除了从缓存中删除外，还删除具有给定键的设置

// Global Settings
Settings::forget('key');

// User Settings
$user->forgetSettings('key');

删除所有设置

除了从缓存中删除外，还删除所有设置

// Global Settings
Settings::flush();

// User Settings
$user->flushSettings();

获取所有设置

返回存储在键=>值数组中的所有设置

// Global Settings
$settings = Settings::all();

// User Settings
$settings = $user->allSettings();

Artisan 命令

缓存所有设置

根据 settings.php 配置文件中设置的持续时间缓存所有设置

您可以设置一个较高的持续时间或将命令安排为频繁运行以获得最佳值

# Global settings only
php artisan settings:cache

# Global and User Settings
php artisan settings:cache --model=App/User

清除所有设置的缓存

# Global settings only
$ php artisan settings:clear

# Global and User Settings
$ php artisan settings:clear --model=App/User

Blade 指令

从 blade 模板中获取值

<h1>@settings('site-name')</h1>
<h1>@settings('site-name', 'default name')</h1>

测试

$ composer test

贡献

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

安全性

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

鸣谢

• Amr A. Mohammed
• 所有贡献者

许可

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