delboy1978uk / bone-settings

一个通用的设置实体

v1.3.0 2024-03-21 17:28 UTC

This package is auto-updated.

Last update: 2024-09-21 18:34:24 UTC


README

build status Code Coverage Scrutinizer Code Quality

一个通用的设置领域实体

安装

composer require delboy1978uk/settings

配置

存在一个默认的 Bone\Settings\Entity\UserSettings 实体,你也可以创建自己的。如果你使用 bone 框架,只需将包类添加到 Bone 的包配置中,如果不使用 bone 框架,则将 vendor/delboy1978uk/bone-settings/src/Entity 添加为你的实体路径之一。

<?php

// other use statements here
use Bone\Settings\SettingsPackage;

return [
    'packages' => [
        // other packages here ...
        SettingsPackage::class,
    ],
    // ...
];

使用方法

抽象设置实体具有双主键:组 ID 和所有者 ID。将设置组视为设置的分组 ID,例如,“电子邮件首选项”可以是组 1,“存储首选项”可以是组 2。确定这些数字不是本包的关注点,但你不一定需要使用它们,默认值为 1。所有者字段用于拥有这些设置的任何人或事物,因此对于 UserSettings,所有者 ID 将是用户的 ID。

自定义类

简单地扩展 Bone\Settings\Entity\AbstractSettings 并添加 #[ORM\Entity] 注解。以 Bone\Settings\Entity\UserSettings 类为例。