README

此包已归档。

抱歉各位，我承担了太多，目前没有使用此包来证明其支持。

我可能在不久的将来重新考虑。

Laraconfig

Laravel 的用户设置仓库系统。

此包允许用户轻松快速地查询、更改和更新设置。

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

要求

• Laravel 11.x
• PHP 8.2 或更高版本

如何工作

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

每个设置只是一个值，并引用一个包含类型和名称等信息以及与用户关联的父 "元数据"。

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

快速入门

您可以通过 composer 安装此包。

composer require doncamillo11/laraconfig

首先，发布并运行迁移。这些迁移将添加两个表，分别称为 user_settings 和 user_settings_metadata。前者存储每个用户的值，后者存储设置的元数据。

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

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

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

namespace App\Models;

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

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

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

php artisan settings:publish

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

设置清单

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

use DonCamillo11\Laraconfig\Facades\Setting;

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

创建设置

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

use DonCamillo11\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 DonCamillo11\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 DonCamillo11\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 DonCamillo11\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 Collection，因此您可以访问所有其工具。

$user = User::find(1);

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

使用 settings 是首选的，因为它只会加载一次设置。

初始化

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

如果您想手动处理初始化，可以使用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()获取底层的设置模型。如果设置不存在，它将返回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

上述方法在从数据库获取设置时会对查询应用过滤器。这使得当用户具有不同的角色或属性或以编程方式时，可以轻松地交换包。

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

禁用包过滤器作用域

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

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

use DonCamillo11\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([
        // ...
    ]);
        
    // ...
}

安全性

如果您发现任何安全相关的问题，请通过电子邮件doncamillo1@web.de联系，而不是使用问题跟踪器。

许可证

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