danvaly/laravel-setting

Laravel 持久化设置包。

v9.0.0 2023-01-03 19:20 UTC

This package is auto-updated.

Last update: 2024-09-09 15:46:50 UTC


README

此包允许您以更持久的方式保存设置。您可以使用数据库和/或 JSON 文件来保存设置。您还可以覆盖 Laravel 配置。这是从 akaunting/laravel-setting 分支出来的。

  • 驱动支持
  • 辅助函数
  • Blade 指令
  • 覆盖配置值
  • 加密
  • 自定义文件、表和列
  • 自动保存
  • 额外列
  • 缓存支持

入门指南

1. 安装

运行以下命令

composer require danvaly/laravel-setting

2. 注册(对于 Laravel < 5.5)

config/app.php 中注册服务提供者

Danvaly\Setting\Provider::class,

如果您想使用外观,请添加别名。

'Setting' => Danvaly\Setting\Facade::class,

3. 发布

发布配置文件。

php artisan vendor:publish --tag=setting

4. 数据库

为数据库驱动创建表

php artisan migrate

5. 配置

您可以从 config/setting.php 文件更改应用程序的选项

用法

您可以使用辅助方法如 setting('foo') 或外观 Setting::get('foo')

外观

Setting::get('foo', 'default');
Setting::get('nested.element');
Setting::set('foo', 'bar');
Setting::forget('foo');
$settings = Setting::all();

辅助方法

setting('foo', 'default');
setting('nested.element');
setting(['foo' => 'bar']);
setting()->forget('foo');
$settings = setting()->all();

您可以通过调用 save() 方法来保存更改。

自动保存

如果您在配置文件中启用了 auto_save 选项,则在关闭应用程序时,如果已更改任何内容,设置将自动保存。

Blade 指令

您可以使用辅助方法或 Blade 指令(如 @setting('foo'))直接在 blade 模板中获取设置。

覆盖配置值

您可以通过将它们添加到 config/setting.php 中的 override 选项来轻松覆盖默认配置值,从而消除修改默认配置文件的需要,并允许您在生产期间更改这些值。例如

'override' => [
    "app.name" => "app_name",
    "app.env" => "app_env",
    "mail.driver" => "app_mail_driver",
    "mail.host" => "app_mail_host",
],

左侧的值对应于相应的配置值(例如:config('app.name')),而右侧的值是设置表/json 文件中的 key 名称。

加密

如果您想为某个密钥加密值,可以将密钥传递给 config/setting.php 中的 encrypted_keys 选项,其余的将由 Laravel 的内置加密功能自动处理。例如

'encrypted_keys' => [
    "payment.key",
],

JSON 存储

您可以使用 setting()->setPath($path) 在运行时修改使用的路径。

数据库存储

如果您想将数据库用作设置存储,则应运行 php artisan migrate。您可以从迁移目录中的 create_settings_table 文件中修改表字段。

额外列

如果您想在同一数据库中为多个用户/客户端存储设置,可以通过指定额外列来实现

setting()->setExtraColumns(['user_id' => Auth::user()->id]);

现在将在检索设置时添加到数据库查询的 user_id = x,并在保存新设置时填充 user_id

如果您需要更精确地控制哪些数据被查询,可以使用 setConstraint 方法,该方法接受一个闭包作为参数,该闭包有两个参数

  • $query 是查询构建器实例
  • $insert 是一个布尔值,告诉您查询是否为插入。如果是插入,通常不需要对 $query 进行任何操作。
setting()->setConstraint(function($query, $insert) {
	if ($insert) return;
	$query->where(/* ... */);
});

自定义驱动

本包底层使用 Laravel 的 Manager 类,因此添加自己的存储驱动非常简单。您只需要扩展抽象的 Driver 类,实现抽象方法,并调用 setting()->extend

class MyDriver extends Danvaly\Setting\Contracts\Driver
{
	// ...
}

app('setting.manager')->extend('mydriver', function($app) {
	return $app->make('MyDriver');
});