README

Laraconfig

Laravel 的按用户设置仓库系统。

此包允许用户拥有可查询、更改甚至轻松快速更新的设置。

User::find(1)->settings->set('color', 'red');

要求

• Laravel 8.x
• PHP 8.0 或更高版本

工作原理

Laraconfig 通过扩展 Laravel 关系并包括迁移系统来轻松管理它们来工作。

每个设置只是一个值，它引用一个包含类型和名称等信息并链接到用户的父 "元数据"。

由于 Laraconfig 在幕后使用 Eloquent ORM，获取一个或所有设置对开发者来说是完全透明的。

快速入门

您可以通过 composer 安装此包。

composer require darkghosthunter/laraconfig

首先，发布并运行迁移。这些将添加两个名为 user_settings 和 user_settings_metadata 的表。一个存储每个用户的值，另一个存储设置的元数据。

php artisan vendor:publish --provider="DarkGhostHunter\Laraconfig\LaraconfigServiceProvider" --tag="migrations"
php artisan migrate

迁移使用形态列连接到用户。您可以在迁移之前更改它。

其次，将 HasConfig 特性添加到您想要设置设置的 User 模型。

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use DarkGhostHunter\Laraconfig\HasConfig;

class User extends Authenticatable
{
    use HasConfig;
    
    // ...
}

最后，使用 settings:publish artisan 命令。这将创建项目根目录中的 settings 文件夹和 users.php 文件。

php artisan settings:publish

现在，让我们创建一些设置。

设置清单

Laraconfig 使用一种类似 清单 的方式来管理用户设置，即 settings/users.php 文件。您将看到一个示例设置已经编写。

use DarkGhostHunter\Laraconfig\Facades\Setting;

Setting::name('color')->string();

创建设置

要创建设置，请使用 Setting 外观。您可以开始设置名称，它必须是唯一的，然后声明类型。

use DarkGhostHunter\Laraconfig\Facades\Setting;

Setting::name('dark_mode')->boolean();

Laraconfig 与 7 种类型的设置兼容，模仿它们的 PHP 原生类型，以及 Collection 和 Datetime (Carbon) 对象。

• array()
• boolean()
• collection()
• datetime()
• float()
• integer()
• string()

数组和集合以 JSON 格式在数据库中序列化。

默认值

所有设置都有默认值 null，但您可以使用 default() 方法设置不同的初始值。

use DarkGhostHunter\Laraconfig\Facades\Setting;

Setting::name('color')->string()->default('black');

您可以使用 setDefault() 将值恢复到默认值。

启用或禁用

默认情况下，所有设置都是默认启用的，但您可以使用disabled()来更改此设置。

Setting::name('color')->disabled();

启用或禁用是表现性的；禁用的设置仍然可以更新。您可以使用setIfEnabled()来程序化设置一个值。

组设置

您可以将设置分配给一个组名。当您希望在前端以有序的方式显示设置并按组进行分隔时，这可能很有用。

Setting::name('color')->group('theme');

包

当Laraconfig迁移新设置时，这些设置将创建到所有模型中。您可以通过“包”过滤特定的设置集。

默认情况下，所有设置都创建在users包下，但您可以使用bag()方法更改任何内容的默认包。

Setting::name('color')->group('theme')->bag('style');

Setting::name('notify_email')->boolean()->default(true)->bag('notifications');
Setting::name('notify_sms')->boolean()->default(false)->bag('notifications');

稍后，在您的模型中，您可以使用filterBags()来过滤您要处理的包。

迁移设置

完成创建设置后，您应使用settings:migrate来让Laraconfig将设置元数据添加到您的数据库中。

php artisan settings:migrate

在幕后，Laraconfig会查找使用HasConfig特性的模型，并使用清单上的信息相应地填充设置。

迁移只能向前运行。一旦完成，就无法回滚迁移。在生产环境中，删除设置需要确认。

添加新设置

只需创建一个新的设置并运行settings:migrate。现有的设置不会再次创建，因为Laraconfig会在执行之前检查它们的存在。

use DarkGhostHunter\Laraconfig\Facades\Setting;

Setting::name('color')->string()->default('black');

// This new setting will be created 
Setting::name('notifications')->boolean()->default(true);

删除旧设置

要删除旧设置，只需删除它们的声明并运行settings:migrate。Laraconfig将在迁移执行结束时比较声明的设置和数据库中创建的设置，并删除那些在清单中不再存在的设置。

use DarkGhostHunter\Laraconfig\Facades\Setting;

// Commenting this line will remove the "color" setting on migration.
// Setting::name('color')->string()->default('black');

// This new setting will be created 
Setting::name('notifications')->boolean()->default(true);

由于此程序可能很危险，生产环境中需要确认。

升级设置

您不需要直接进入数据库来更新设置。相反，只需直接在清单中更改设置属性。Laraconfig将相应地更新元数据。

假设我们有一个“颜色”设置，我们希望将其从字符串更新为数组的颜色，并带有默认值和组。

Setting::name('color')->string()->bag('theme');

// This is the new declaration.
// Setting::name('color')
//    ->array()
//    ->default(['black'])
//    ->group('theme');

Laraconfig将检测新的更改，并更新元数据，同时保持用户值不变。

// This is the old declaration.
// Setting::name('color')->string()->bag('theme');

Setting::name('color')
    ->array()
    ->default(['black'])
    ->group('theme');

只有在迁移时间设置与之前不同的情况下才会更新。

完成后，我们可以使用settings:migrate将旧设置迁移到新设置。用户将保留他们之前相同的设置值，但...如果我们想为每个用户更改值怎么办？我们可以使用using()方法将每个用户设置传递给一个回调，该回调将返回新值。

Setting::name('color')
    ->array()
    ->default('black')
    ->group('theme')
    ->using(fn ($old) => $old->value ?? 'black'); // If the value is null, set it as "black".

只有在设置在迁移时间与之前不同的情况下，using()方法才会运行。

在幕后，Laraconfig将查找“颜色”设置，更新元数据，然后使用lazy()查询使用回调更新值。

如果您有数十万条记录，请考虑直接迁移到数据库，因为此方法比直接SQL语句更安全但速度较慢。

迁移到新设置

在其他情况下，您可能希望将设置迁移到全新的设置。在这两种情况下，您可以使用 from() 获取要迁移的旧设置值，如果您还想更新每个用户的值，可以使用 using()。

以上面的相同示例，我们将“颜色”设置迁移到简单的“暗色主题”设置。

// This old declaration will be deleted after the migration ends.
// Setting::name('color')->string()->bag('theme');

// This is a new setting.
Setting::name('dark')
    ->boolean()
    ->default(false)
    ->group('theme')
    ->from('color')
    ->using(static fn ($old) => $old->value === 'black'); // If it's black, then it's dark.

from 和 using 只在迁移时间旧设置存在时执行。

在幕后，Laraconfig首先创建新的“主题”设置，然后查找数据库中的旧“颜色”设置以将旧值转换为新值。由于旧设置不在清单中，它将从数据库中删除。

管理设置

Laraconfig像任何Eloquent Morph-Many 关系一样处理设置，但功能更强大。

只需在您的模型上使用 settings 属性。此属性类似于您的正常 Eloquent 集合，因此您可以访问其所有工具。

$user = User::find(1);

echo "Your color is: {$user->settings->get('color')}.";

使用 settings 更好，因为它只会加载一次设置。

初始化

默认情况下，HasConfig 特性将在通过 Eloquent ORM成功创建用户后在数据库中创建一个新的设置包，因此您不需要创建任何设置。

如果您想手动处理初始化，可以使用 shouldInitializeConfig() 方法并返回 false，这在程序化初始化设置时非常有用。

// app/Models/User.php

/**
 * Check if the user should initialize settings automatically after creation.
 * 
 * @return bool
 */
protected function shouldInitializeConfig(): bool
{
    // Don't initialize the settings if the user is not verified from the start.
    // We will initialize them only once the email is properly verified.
    return null !== $this->email_verified_at;
}

由于上面的示例用户不会进行初始化，我们必须手动使用 initialize() 来进行初始化。

// Initialize if not initialized before.
$user->config()->initialize();

// Forcefully initialize, even if already initialized.
$user->config()->initialize(true);

检查设置初始化

您可以使用 isInitialized() 检查用户配置是否已初始化。

if ($user->config()->isInitialized()) {
    return 'You have a config!';
}

检索设置

您可以使用名称轻松获取设置的值，这使得所有内容都变成一个美丽的 单行代码。

return "Your favorite color is {$user->settings->color}";

由于这仅支持字母数字和下划线字符，您可以使用 value()。

return "Your favorite color is {$user->settings->value('color')}";

您还可以使用 get() 获取底层的 Setting 模型。如果设置不存在，它将返回 null。

$setting = $user->settings->get('theme');

echo "You're using the [$setting->value] theme.";

由于 settings 是一个 集合，您可以访问所有的好处，例如迭代。

foreach ($user->settings as $setting) {
    echo "The [$setting->name] has the [$setting->value] value.";
}

您还可以使用 only() 方法通过名称返回设置集合，或使用 except() 检索除指定的设置之外的所有设置。

$user->settings->only('colors', 'is_dark');

$user->settings->except('dark_mode');

分组设置

由于设置列表是一个集合，您可以使用 groups() 方法按所属组的名称对它们进行分组。

$user->settings->groups(); // or ->groupBy('group')

请注意，设置默认分组到 default 组（不是字面意思）。

设置值

设置值可以通过指定设置名称和值轻松完成。

$user->settings->color = 'red';

由于此功能仅支持由字母数字和下划线组成的设置名称，您还可以使用set()方法通过指定设置名称来设置值。

$user->settings->set('color-default', 'red');

或者，您可以直接在模型本身中进入纯主义者模式。

$setting = $user->settings->get('color');

$setting->value = 'red';
$setting->save();

当使用set()一次性设置多个设置时，可以使用数组，这在处理验证返回的数组时非常有用。

$user->settings->set([
    'color' => 'red',
    'dark_mode' => false,
]);

当使用缓存时，任何更改都会立即使缓存失效，并在垃圾收集之前对集合进行再生。

话虽如此，直接将设置更新到数据库中不会再生缓存。

将设置重置为默认值

您可以通过设置实例上的setDefault()或使用settings属性来将设置重置为默认值。

$setting = $user->settings->get('color');

$setting->setDefault();

$user->settings->setDefault('color');

如果设置没有默认值，则使用null。

检查是否为null

使用isNull()和设置名称检查是否设置了null值。

if ($user->settings->isNull('color')) {
    return 'The color setting is not set.';
}

禁用/启用设置

为了展示目的，默认情况下所有设置都启用。您可以使用enable()和disable()分别启用或禁用设置。要检查设置是否启用，请使用isEnabled()方法。

$user->settings->enable('color');

$user->settings->disable('color');

即使禁用了设置，仍然可以对其进行设置。如果只想在启用时设置值，请使用setIfEnabled()。

$user->settings->setIfEnabled('color', 'red');

设置包

Laraconfig使用一个名为default的单个包。如果您在清单中声明了不同的包集合，您可以使用filterBags()方法创建一个模型，只使用特定集合的包，该方法的返回值应该是包名称（或名称）。

// app/Models/User.php
i

禁用包过滤器作用域

Laraconfig会对查询应用过滤器以排除不在模型包中的设置。虽然这简化了开发，但有时您将想要与所有可用的设置一起工作。

有两种禁用包过滤器的方法。第一种相对简单：只需在查询时使用withoutGlobalScope()，这将允许查询用户可用的所有设置。

use DarkGhostHunter\Laraconfig\Eloquent\Scopes\FilterBags;

$allSettings = $user->settings()->withoutGlobalScope(FilterBags::class)->get();

如果您想要一个更永久的解决方案，只需在模型中使用filterBags()方法时返回空数组或null，这将完全禁用作用域。

/**
 * Returns the bags this model uses for settings.
 *
 * @return array|string
 */
public function filterBags(): array|string|null
{
    return null;
}

缓存

如果预期在每次请求中都会发生，则每次请求都击中数据库以检索用户设置可能会产生负面影响。为了避免这种情况，您可以激活一个缓存，该缓存将在每次更改设置时进行再生。

缓存实现避免了数据竞争。它只针对最后修改的数据重新生成缓存，因此如果有两个或更多进程尝试将某些内容保存到缓存中，只有最新的数据会被持久化。

启用缓存

您可以通过将环境变量LARACONFIG_CACHE设置为true轻松启用缓存，并使用非默认的缓存存储（如Redis）和LARACONFIG_STORE。

LARACONFIG_CACHE=true
LARACONFIG_STORE=redis

或者，检查laraconfig.php文件来自定义缓存TTL和前缀。

管理缓存

您可以使用regenerate()强制重新生成单个用户的缓存。这基本上是将现有的设置保存并存储到缓存中。

$user->settings->regenerate();

您还可以使用invalidate()无效化缓存的设置，这将从缓存中删除条目。

$user->settings->invalidate();

最后，您可以将regeneratesOnExit设置为true以获得一些安心，这将使PHP进程在垃圾回收设置时重新生成缓存。

$user->settings->regeneratesOnExit = true;

您可以在配置文件中禁用自动重新生成。

在迁移时重新生成缓存

如果缓存已激活，迁移将在完成后使每个用户的设置缓存失效。

根据缓存系统，忘记每个缓存键可能是有害的。相反，您可以使用--flush-cache命令来清除Laraconfig使用的缓存存储，而不是逐个删除每个键。

php artisan settings:migrate --flush-cache

由于这将删除缓存的所有数据，建议为Laraconfig使用一个独立的缓存存储，如单独的Redis数据库。

验证

设置值会被转换，但不会被验证。您应该在应用中验证您计划存储在设置中的每个值。

use App\Models\User;
use Illuminate\Http\Request;

public function store(Request $request, User $user)
{
    $settings = $request->validate([
        'age' => 'required|numeric|min:14|max:100',
        'color' => 'required|string|in:red,green,blue'
    ]);
    
    $user->settings->setIfEnabled($settings);
    
    // ...
}

测试

最终您会面临为每个创建的用户创建设置和元数据的问题。您可以在创建用户之前直接在数据库中创建元数据，除非您已禁用初始化。

public function test_user_has_settings(): void
{
    Metadata::forceCreate([
        'name'    => 'foo',
        'type'    => 'string',
        'default' => 'bar',
        'bag'     => 'users',
        'group'   => 'default',
    ]);
    
    $user = User::create([
        // ...
    ]);
        
    // ...
}

安全

如果您发现任何安全问题，请通过电子邮件darkghosthunter@gmail.com联系，而不是使用问题跟踪器。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。