README

Laravel 的简单用户设置外观。设置以 JSON 格式存储在单个数据库列中，因此您可以轻松将其添加到现有表（例如 users 表）中。

安装

运行 composer require ricardoboss/laravel-user-settings 以将其包含到您的项目中。
运行 php artisan vendor:publish --provider="Grimthorr\LaravelUserSettings\ServiceProvider" --tag="config" 以发布配置文件。
修改位于 config/laravel-user-settings.php 的发布配置文件，以符合您的需求。
在您的数据库表中创建一个列以匹配设置文件中的配置。或者，使用此包中包含的 Laravel 迁移来自动在 users 表中创建一个 settings 列： php artisan vendor:publish --provider="Grimthorr\LaravelUserSettings\ServiceProvider" --tag="migrations" && php artisan migrate。

注意：您列的数据类型应该足够大，以存储所有设置（以 JSON 格式）。对于 MySQL，TEXT 应该足够。

配置

打开 config/laravel-user-settings.php 以调整包配置。如果此文件不存在，运行 php artisan vendor:publish --provider="Grimthorr\LaravelUserSettings\ServiceProvider" --tag="config" 以创建默认配置文件。

return array(
  'table' => 'users',
  'column' => 'settings',
  'constraint_key' => 'id',
  'default_constraint_value' => null,
  'custom_constraint' => null,
);

表

指定您想使用的数据库表。

列

指定要存储设置 JSON 数据的上述表中的列。

约束键

指定用于约束的索引列 - 这用于区分不同的用户、对象或模型（通常是 id）。

默认约束值

指定默认约束值 - 默认情况下，这将使用当前用户的 ID，并且可以通过在函数调用中指定任何 $constraint_value 来替换。

自定义约束

指定每个查询的 where 子句 - 如果您不想访问不同的行（例如，如果您的应用程序仅限单用户使用），则设置此值。

用法

使用设置外观（Setting::）或辅助函数（setting()->）来访问此包中的方法。所有函数的 $constraint_value 参数都是可选的；如果没有传递，则将使用配置文件中的 default_constraint_value。

设置

Setting::set('key', 'value', $constraint_value);
setting()->set('key', 'value', $constraint_value);

使用 set 修改设置的值。如果设置不存在，则会自动创建。您可以通过将关联数组（key=>value）传递给第一个参数，一次设置多个键。

获取

Setting::get('key', 'default', $constraint_value);
setting()->get('key', 'default', $constraint_value);
setting('key', 'default', $constraint_value);

使用 get 获取设置的值。第二个参数是可选的，可以用来指定如果设置不存在时的默认值（默认的默认值是 null）。

忘记

Setting::forget('key', $constraint_value);
setting()->forget('key', $constraint_value);

通过调用 forget 来取消设置或删除设置。

存在

Setting::has('key', $constraint_value);
setting()->has('key', $constraint_value);

检查设置的是否存在，返回一个布尔值。

所有

Setting::all($constraint_value);
setting()->all($constraint_value);

以关联数组（key=>value）的形式检索所有设置。

保存

Setting::save($constraint_value);
setting()->save($constraint_value);

将所有更改保存回数据库。在做出更改后，需要调用此方法；这不是自动的。

加载

Setting::load($constraint_value);
setting()->load($constraint_value);

从数据库重新加载设置。如果在访问或修改设置之前尚未加载设置，则会自动调用。

示例

这些示例使用默认配置。

使用默认约束值

以下代码设置并返回当前登录用户的设置 "example"。

// Set 'example' setting to 'hello world'
Setting::set('example', 'hello world');

// Save to database
Setting::save();

// Get the same setting
return Setting::get('example');

指定约束值

以下代码为 ID 为 23 的用户设置并返回 "example" 设置。

// Set 'example' setting to 'hello world'
Setting::set('example', 'hello world', 23);

// Save to database
Setting::save(23);

// Get the same setting
return Setting::get('example', null, 23);

最后

贡献

如果您想贡献，请随意创建一个分叉并提交一个拉取请求。

错误报告

如果您发现有任何问题，请在 GitHub 上提出问题。

鸣谢

从 Grimthorr 的 https://github.com/Grimthorr/laravel-user-settings 分叉而来。
基于 https://github.com/anlutro/laravel-settings 进行修改。

ricardoboss / laravel-user-settings

维护者

详细信息