jaapgoorhuis / l4-metatags
Laravel 中的持久化元数据。
Requires
- php: >=5.3.0
- illuminate/support: >=4.1 <6.0
Requires (Dev)
- illuminate/database: >=4.1 <6.0
- illuminate/filesystem: >=4.1 <6.0
- mockery/mockery: 0.9.*
Suggests
- illuminate/database: Save settings to a database table.
- illuminate/filesystem: Save settings to a JSON file.
This package is not auto-updated.
Last update: 2024-09-18 19:09:08 UTC
README
为 Laravel 提供持久的、应用级设置。
尽管包名为 l4-metatags,但此包与 Laravel 5.x 兼容!
安装
composer require anlutro/l4-settings
- 将
anlutro\LaravelSettings\ServiceProvider
添加到config/app.php
中服务提供者的数组。 - 通过运行
php artisan config:publish anlutro/l4-settings
(Laravel 4.x) 或php artisan vendor:publish
(Laravel 5.x) 发布配置文件。配置文件将允许您控制使用哪个存储引擎以及一些存储特定的设置。 - 可选:将
'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()
来保存更改。
自动保存
在 Laravel 4.x 中,库确保每次应用程序关闭时,如果已更改任何内容,都会自动保存。
在 Laravel 5.x 中,如果您将中间件 anlutro\LaravelSettings\SaveMiddleware
添加到 app\Http\Kernel.php
中的 middleware
列表中,设置将在所有 HTTP 请求结束时自动保存,但您仍需要在控制台命令、队列工作者等地方显式调用 Setting::save()
。
JSON 存储
您可以使用 Setting::setPath($path)
在运行时修改使用的路径。
数据库存储
使用迁移文件
如果您使用数据库存储,您需要运行 php artisan migrate --package=anlutro/l4-settings
(Laravel 4.x) 或 php artisan migrate --path=vendor/anlutro/l4-settings/src/migrations
(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 打开一个问题。
许可证
此存储库的内容在 MIT 许可证 下发布。