akaunting / setting
Requires
- php: >=5.5.9
- laravel/framework: >=5.3
Requires (Dev)
- laravel/framework: >=5.3
- mockery/mockery: 0.9.*
- phpunit/phpunit: >=4.8
This package is auto-updated.
Last update: 2023-11-02 08:33:57 UTC
README
此包允许您以更持久的方式保存设置。您可以使用数据库和/或JSON文件来保存设置。您还可以覆盖Laravel配置。
- 驱动支持
- 辅助函数
- Blade指令
- 覆盖配置值
- 加密
- 自定义文件、表和列
- 自动保存
- 额外列
- 缓存支持
入门
1. 安装
运行以下命令
composer require akaunting/laravel-setting
2. 注册(对于Laravel < 5.5)
在config/app.php
中注册服务提供者
Akaunting\Setting\Provider::class,
如果您想使用外观,请添加别名。
'Setting' => Akaunting\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 Akaunting\Setting\Contracts\Driver { // ... } app('setting.manager')->extend('mydriver', function($app) { return $app->make('MyDriver'); });
更新日志
有关最近更改的更多信息,请参阅发布记录。
贡献
欢迎提交拉取请求。你必须遵循 PSR 编码标准。
安全
如果你发现任何与安全相关的问题,请通过电子邮件security@akaunting.com联系,而不是使用问题跟踪器。
鸣谢
许可协议
MIT 许可协议 (MIT)。有关更多信息,请参阅LICENSE。