anlutro/l4-settings

Laravel 的持久化设置。

v1.4.1 2024-06-14 10:45 UTC

README

Build Status Latest Stable Version License

Laravel 的持久化、全局设置。

尽管包名为 l4-settings,但此包应与 Laravel 4、5、6、7 和 8 兼容(尽管某些版本没有自动测试)。

常见问题

  • 类未找到错误: #38

Laravel >= 5.5 的安装

  1. composer require anlutro/l4-settings
  2. 通过运行 php artisan vendor:publish --provider="anlutro\LaravelSettings\ServiceProvider" --tag="config" 发布配置文件。配置文件将允许您控制使用哪个存储引擎以及一些特定于存储的设置。

Laravel < 5.5 的安装

  1. composer require anlutro/l4-settings
  2. anlutro\LaravelSettings\ServiceProvider 添加到 config/app.php 中的提供者数组。
  3. 通过运行 php artisan config:publish anlutro/l4-settings(Laravel 4.x)或 php artisan vendor:publish(Laravel 5.x)发布配置文件。配置文件将允许您控制使用哪个存储引擎以及一些特定于存储的设置。
  4. 可选:将 'Setting' => 'anlutro\LaravelSettings\Facade' 添加到 config/app.php 中的别名数组。

用法

您可以通过其外观或通过类型提示抽象类 anlutro\LaravelSettings\SettingStore 来访问设置存储。

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

显式调用 Setting::save() 以保存更改。

您还可以使用 setting() 辅助函数

// Get the store instance
setting();

// Get values
setting('foo');
setting('foo.bar');
setting('foo', 'default value');
setting()->get('foo');

// Set values
setting(['foo' => 'bar']);
setting(['foo.bar' => 'baz']);
setting()->set('foo', 'bar');

// Method chaining
setting(['foo' => 'bar'])->save();

自动保存

在 Laravel 4.x 中,该库确保在应用程序关闭时自动保存任何更改。

在 Laravel 5.x 中,如果您将中间件 anlutro\LaravelSettings\SaveMiddleware 添加到您的 app\Http\Kernel.php 中的 middleware 列表,设置将在所有 HTTP 请求结束时自动保存,但您仍然需要在控制台命令、队列工作进程等中显式调用 Setting::save()

存储缓存

在从存储读取时,您可以启用缓存。

您还可以配置在写入时刷新缓存并配置有效时间。

读取将来自存储,然后来自缓存,这可以减少对存储的负载。

// Cache usage configurations.
'enableCache' => false,
'forgetCacheByWrite' => true,
'cacheTtl' => 15,

JSON 存储

您可以使用 Setting::setPath($path) 修改运行时使用的路径。

数据库存储

使用迁移文件

如果您使用数据库存储,则需要运行 php artisan migrate --package=anlutro/l4-settings(Laravel 4.x)或 php artisan vendor:publish --provider="anlutro\LaravelSettings\ServiceProvider" --tag="migrations" && php artisan migrate(Laravel 5.x)来生成表。

示例

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

<?php
Setting::setExtraColumns(array(
	'user_id' => Auth::user()->id
));
?>

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

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

  • $query 是查询构建器实例
  • $insert 是一个布尔值,告诉您查询是否是插入。如果是插入,通常不需要对 $query 做任何事情。
<?php
Setting::setConstraint(function($query, $insert) {
	if ($insert) return;
	$query->where(/* ... */);
});
?>

自定义存储

此包在底层使用 Laravel 的 Manager 类,因此如果您想以其他方式存储,则很容易添加自己的自定义会话存储驱动程序。您需要做的就是扩展抽象类 SettingStore,实现抽象方法,并调用 Setting::extend

<?php
class MyStore extends anlutro\LaravelSettings\SettingStore {
	// ...
}
Setting::extend('mystore', function($app) {
	return $app->make('MyStore');
});
?>

联系方式

如果在GitHub上遇到任何问题或建议,请创建一个issue。

许可证

本仓库的内容遵循MIT许可证发布。