README

这是对当前存档的 DarkGhostHunter/Laraconfig 的更新，未来将继续维护。

我们将调查在不久的将来为我们的项目添加新功能，但应该基本相同。

多配置

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

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

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

要求

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

工作原理

Multiconfig 通过扩展 Laravel 关系工作，并包含一个迁移系统来轻松管理它们。

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

由于 Multiconfig 在幕后使用 Eloquent ORM，因此获取单个或所有设置对开发人员来说是完全透明的。

快速入门

您可以通过 composer 安装此软件包。

composer require synergitech/multiconfig

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

php artisan vendor:publish --provider="SynergiTech\Multiconfig\MulticonfigServiceProvider" --tag="migrations"
php artisan migrate

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

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

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use SynergiTech\Multiconfig\HasConfig;

class User extends Authenticatable
{
    use HasConfig;

    // ...
}

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

php artisan settings:publish

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

设置清单

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

use SynergiTech\Multiconfig\Facades\Setting;

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

创建设置

要创建设置，请使用 Setting 门面。您可以设置名称，该名称必须是唯一的，然后声明类型。

use SynergiTech\Multiconfig\Facades\Setting;

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

Multiconfig 与 7 种类型的设置兼容，它们与 PHP 原生类型相匹配，以及 Collection 和 Datetime (Carbon) 对象。

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

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

默认值

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

use SynergiTech\Multiconfig\Facades\Setting;

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

您可以使用 setDefault() 将值还原到默认值。

启用或禁用

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

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

启用或禁用是表示性的；禁用的设置仍然可以更新。您可以使用 setIfEnabled() 编程式设置值。

分组设置

您可以将组名设置为一个配置项。当您想在前端按顺序显示配置项时，这会很有用，方法是按照将它们分组进行分离。

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

包

当 Multiconfig 迁移新的配置项时，这些配置项会被创建到所有模型中。您可以通过“包”来筛选一组配置项。

默认情况下，所有配置项都创建在 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 来让 Multiconfig 将配置项元数据添加到您的数据库中。

php artisan settings:migrate

在幕后，Multiconfig 会查找使用了 HasConfig 特性的模型，并根据清单上的信息相应地填充配置项。

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

添加新配置项

只需创建一个新的配置项并运行 settings:migrate。由于 Multiconfig 会在执行之前检查其存在性，因此现有配置项不会再次创建。

use SynergiTech\Multiconfig\Facades\Setting;

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

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

删除旧配置项

要删除旧配置项，只需删除其声明并运行 settings:migrate。Multiconfig 会比较声明的配置项与数据库中创建的配置项，并在迁移执行结束时删除清单中不再存在的配置项。

use SynergiTech\Multiconfig\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);

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

升级配置项

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

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

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

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

Multiconfig 将检测新的更改，并更新元数据，同时保留用户的值。

// 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() 方法才会运行。

在幕后，Multiconfig 会查找“颜色”配置项，更新元数据，然后使用 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 只在迁移时旧设置存在时执行。

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

管理配置项

Multiconfig 处理配置项的方式类似于任何 Eloquent Morph-Many 关系，但功能更强大。

只需简单地使用模型上的 settings 属性。这个属性就像您的普通 Eloquent Collection，因此您可以访问所有其工具。

$user = User::find(1);

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

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

初始化

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

如果您想手动处理初始化，可以使用 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->settings()->initialize();

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

检查设置初始化

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

if ($user->settings()->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 是一个 collection，您有权访问所有的好处，比如迭代。

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。

检查空值

使用 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');

设置包

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

// app/Models/User.php
i

上述代码在从数据库中检索设置时会对查询应用过滤器。这使得在用户具有不同的角色或属性时或以编程方式交换包变得容易。

所有设置都是为所有具有HasConfig特质的模型创建的，无论模型使用的包是什么。

禁用包过滤器作用域

多配置应用查询过滤器以排除模型包之外的设置。虽然这简化了开发，但有时您可能希望使用所有可用的设置集。

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

use SynergiTech\Multiconfig\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;
}

缓存

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

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

启用缓存

您可以通过将MULTICONFIG_CACHE环境变量设置为true轻松启用缓存，并使用非默认缓存存储（如Redis）与MULTICONFIG_STORE一起使用。

MULTICONFIG_CACHE=true
MULTICONFIG_STORE=redis

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

管理缓存

您可以使用regenerate()强制重新生成单个用户的缓存。这基本上是将当前设置的值保存并放入缓存中。

$user->settings->regenerate();

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

$user->settings->invalidate();

最后，您可以将regeneratesOnExit设置为true，这样当设置被PHP进程垃圾回收时，将重新生成缓存，这可以稍微让您放心。

$user->settings->regeneratesOnExit = true;

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

在迁移时重新生成缓存

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

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

php artisan settings:migrate --flush-cache

由于这将删除缓存的所有数据，建议为Multiconfig使用一个专用的缓存存储，如单独的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）。有关更多信息，请参阅许可证文件。