README

为Laravel 5提供的简单用户设置界面。设置以JSON格式存储在单个数据库列中，因此您可以轻松地将它添加到现有表（例如users）中。

仍在使用Laravel 4？请确保使用 1.x 版本（composer require grimthorr/laravel-user-settings ~1.0）。

安装

1. 运行 composer require grimthorr/laravel-user-settings 将其包含到您的项目中。

2. 将 'Grimthorr\LaravelUserSettings\ServiceProvider' 添加到 config/app.php 中的 providers。

   'providers' => array(
     // ...
     'Grimthorr\LaravelUserSettings\ServiceProvider',
   ),

3. 将 'Setting' => 'Grimthorr\LaravelUserSettings\Facade' 添加到 config/app.php 中的 aliases。

   'aliases' => array(
     // ...
     'Setting' => 'Grimthorr\LaravelUserSettings\Facade',
   ),

4. 运行 php artisan vendor:publish --provider="Grimthorr\LaravelUserSettings\ServiceProvider" --tag="config" 发布配置文件。

5. 修改位于 config/laravel-user-settings.php 的发布配置文件，以满足您的需求。
6. 在您的数据库表中创建一个 varchar（字符串）列以匹配步骤5中的配置文件。或者，使用此包中包含的Laravel迁移来自动在 users 表中创建 settings 列：php artisan vendor:publish --provider="Grimthorr\LaravelUserSettings\ServiceProvider" --tag="migrations" && php artisan migrate。

配置

打开 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 上提出问题。

基于 https://github.com/anlutro/laravel-settings 的设计。