README

简介

为您的 Laravel 模型添加简单但灵活的多个设置。

要求

PHP >=7.0。除此之外，此库没有其他要求。

安装

$ composer require x-laravel/model-settings-bag:"~1.0"

集成

单个

1. 在模型迁移中添加 JSON 设置字段。

create_users_table.php

Schema::create('users', function (Blueprint $table) {
    $table->increments('id');
    $table->string('name');
    $table->string('email')->unique();
    $table->string('password');
    $table->json('settings')->nullable();
    $table->rememberToken();
    $table->timestamps();
});

2. 在您的模型中使用 traits XLaravel\ModelSettingsBag\HasSettingsBag。

User.php

use XLaravel\ModelSettingsBag\HasSettingsBag;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable 
{
    use HasSettingsBag;
     
    // truncated for brevity..
}

多个

1. 在模型迁移中添加 JSON 设置字段。

create_user_theme_settings_table.php

Schema::create('user_theme_settings', function (Blueprint $table) {
    $table->id();
    $table->unsignedInteger('user_id');
    $table->json('settings')->nullable();
    $table->rememberToken();
    $table->timestamps();
});

2. 在您的其他设置模型中使用 traits XLaravel\ModelSettingsBag\HasSettingsBag。

UserThemeSetting.php

use XLaravel\ModelSettingsBag\HasSettingsBag;
use Illuminate\Database\Eloquent\Model;

class UserThemeSetting extends Model 
{
    use HasSettingsBag;
}

3. 在您的模型中使用 traits XLaravel\ModelSettingsBag\HasSettingsBag。

User.php

class User extends Model 
{
    use HasSettingsBag;

    public function themeSettings()
    {
        return $this->hasOne(UserThemeSetting::class);
    }
}

使用

1.) 获取模型的所有设置。

$user = App\User::first();

$user->settings()->all();    // Returns an array of the user's settings.
$user->settings('theme')->get();    // Returns an array of a user's theme settings.

2.) 获取特定的设置。

$user = App\User::first();

$user->settings()->get('some.setting');
$user->settings()->get('some.setting', $defaultValue); // With a default value.

$user->settings('theme')->get('layout.boxed');
$user->settings('theme')->get('layout.boxed', $defaultValue); // With a default value.

3.) 添加或更新设置。

$user = App\User::first();

$user->settings()->update('some.setting', 'new value');
$user->settings('theme')->update('layout.boxed', 'new value');

4.) 确定模型是否有特定的设置。

$user = App\User::first();

$user->settings()->has('some.setting');
$user->settings('theme')->has('layout.boxed');

5.) 从模型中删除设置。

$user = App\User::first();

$user->settings()->delete('some.setting');
$user->settings('theme')->delete('layout.boxed');

6.) 为新模型设置默认设置。

如果您在模型上定义了 $defaultSettings 作为数组属性，我们将使用其值作为创建 无 设置的新模型的默认设置。

User.php

use XLaravel\ModelSettingsBag\HasSettingsBag;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable 
{
    use HasSettingsBag;

    /**
     * The model's default settings.
     * 
     * @var array
     */
    protected $defaultSettings = [
    	'homepage' => '/profile'
    ];

    // truncated for brevity..
}

7.) 指定允许的设置。

如果您将 $allowedSettings 定义为数组属性，那么只有与 $allowedSettings 数组中的值匹配的设置才会被保存在模型上。

User.php

use XLaravel\ModelSettingsBag\HasSettingsBag;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable 
{
    use HasSettingsBag;

    /**
     * The model's allowed settings.
     * 
     * @var array
     */
    protected $allowedSettings = ['homepage'];

    // truncated for brevity..
}

8.) 使用除 settings() 之外的方法名

如果您希望使用除 settings 之外的其他名称，可以通过定义 $mapSettingsTo 属性来实现。这简单地将对方法的调用（如 config()）映射到 settings() 方法。

User.php

use XLaravel\ModelSettingsBag\HasSettingsBag;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable 
{
    use HasSettingsBag;

    /**
     * The settings field name.
     * 
     * @var string
     */
    protected $mapSettingsTo = 'config';

    // truncated for brevity..
}

许可证

此包是开源软件，根据 MIT 许可证 许可。