在PHP 8.1版本的枚举中可以使用属性扩展示例

php  /  管理员 发布于 2年前   462

随着PHP 8.1的发布，该语言获得了对枚举的本地支持。枚举是一种类型安全、可读和高效的方式，用于封装数据模型中一个字段可能采取的一小部分值。使用类而不是数据库枚举提供了更多的灵活性，如果你需要在未来添加到列表中。

举个例子，你有一个用户数据模型，该用户可能有一个特定的角色列表，

你可以从中选择：

namespace App\Enums;
 
enum UserRole: string
{
    case Admin = 'admin';
    case TeamAdmin = 'team_admin';
    case Support = 'support';
    case Basic = 'basic';
}

在你的数据模型中, Laravel也有对枚举的支持, 如果你在你的casts数组中定义了它, 就可以把它铸造为值.

/**
 * The attributes that should be cast.
 *
 * @var array<string,string|class-string>
 */
protected $casts = [
    'role' => UserRole::class,
];

添加枚举铸造将确保如果我们试图保存一个不在枚举中定义的角色到我们的用户模型中，将会抛出一个异常。

枚举的一个非常实际的用途是为你的HTML中的下拉菜单生成值：

<select name=”roles”>
    @foreach(UserRole::cases() as $role)
        <option value="{{ $role->value }}">{{ $role->name }}</option>
    @endforeach
</select>

从表面上看，上面的例子似乎没有什么问题，直到你看了下拉菜单中每个选项的可见名称。

Admin和TeamAdmin是很好的变量名称，但Administrator和Team Administrator最好在用户界面中呈现，这样对于管理用户角色的人来说就很清楚角色是什么。

虽然枚举对于简单的名称/值对来说是很好的，但在这种情况下，你需要添加第三个属性，你必须要有创造性。

输入PHP属性。它借用了其他语言中注释的概念，是一种将元数据与属性、方法和类联系起来的方法，这听起来正是我们需要的。

首先，我们需要建立一个描述属性：

namespace App\Enums\Attributes;
 
use Attribute;
 
#[Attribute]
class Description
{
    public function __construct(
            public string $description,
    ) {
    }
}

我们现在有了一个描述属性，我们可以在我们的枚举中利用它，

这样我们就可以定义我们想要的用户友好的角色名称：

namespace App\Enums;
 
enum UserRole: string
{
    #[Description('Administrator')]
    case Admin = 'admin';
 
    #[Description('Team Administrator')]
    case TeamAdmin = 'team_admin';
 
    case Support = 'support';
    case basic = 'basic';
}

现在我们需要检索这些属性，这只能通过反射来完成。

由于我们可能想在其他枚举中重复使用这个属性，我们将想做一个特质来使之更容易。

namespace App\Enums\Concerns;
 
use Illuminate\Support\Str;
use ReflectionClassConstant;
use App\Enums\Attributes\Description;
 
trait GetsAttributes
{
    /**
     * @param self $enum
     */
    private static function getDescription(self $enum): string
    {
        $ref = new ReflectionClassConstant(self::class, $enum->name);
        $classAttributes = $ref->getAttributes(Description::class);
 
        if (count($classAttributes) === 0) {
                return Str::headline($enum->value);
        }
 
        return $classAttributes[0]->newInstance()->description;
    }
}

如果我们把这个方法拆开，前两行是使用反射来获取枚举的属性。

由于不是每个枚举都可能有一个描述属性，我们设置了一个回退，将该枚举的值（或名称）转换为我们的描述。

最后，我们从枚举的属性中提取描述的值。

我们可以给我们的trait添加另一个方法来处理这个问题：

/**
 * @return array<string,string>
 */
public static function asSelectArray(): array
{
    /** @var array<string,string> $values */
    $values = collect(self::cases())
        ->map(function ($enum) {
            return [
                'name' => self::getDescription($enum),
                'value' => $enum->value,
            ];
        })->toArray();
 
    return $values;
}

现在，在我们的HTML中，我们可以简单地改变我们对枚举类的调用方法：

<select name=”roles”>
       @foreach(UserRoles::asSelectArray() as $role)
            <option value=”{{ $role->value }}”>{{ $role->name }}</option>
       @endforeach
</select>

虽然它们是PHP的新成员，但枚举和属性是语言的重要补充，

并为许多常见的用例提供了本地支持。