novicms / 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-23 13:07:01 UTC
README
Laravel 的持久化、应用级设置。
尽管包名为此,但此包与 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 许可协议 发布的。