README

不再推荐使用此库

不再推荐使用此库，尤其是对于新项目。PHP 8.1 支持枚举原生。

见 https://github.com/Arslan/laravel-enum/issues/332.

关于 Laravel Enum

为 Laravel 提供简单、可扩展且强大的枚举实现。

枚举键值对作为类常量
完整功能的方法套件
枚举实例化
标记/位枚举
类型提示
属性铸造
枚举 artisan 生成器
验证规则，用于将枚举键或值作为输入参数传递
本地化支持
通过宏可扩展

由 Ben Sampson 创建

跳转到

指南
安装
迁移到原生 PHP 枚举
枚举库
基本用法
标记/位枚举
属性铸造
迁移
验证
本地化
自定义描述
- 自定义类描述
- 自定义值描述
扩展枚举基类
Laravel Nova 集成
PHPStan 集成
Artisan 命令列表
枚举类参考
存根

旧版本文档

您正在阅读 6.x 版本的文档。

如果您使用的是 Laravel 8，请参阅 4.x 版本的文档。
如果您使用的是 Laravel 7，请参阅 2.x 版本的文档。
如果您使用的是 Laravel 6 或更低版本，请参阅 1.x 版本的文档。

有关升级到最新版本的信息，请参阅升级指南。

指南

我写了一篇关于使用 laravel-enum 的博客文章：https://sampo.co.uk/blog/using-enums-in-laravel

安装

需要 PHP 8，以及 Laravel 9 或 10。

composer require Arslan/laravel-enum

迁移到原生 PHP 枚举

PHP 8.1 支持枚举原生。您可以使用以下步骤将 Arslan\Enum\Enum 的使用迁移到原生 PHP 枚举。

确保您满足以下要求

PHP 8.1 或更高版本
Laravel 10 或更高版本
Rector 0.17 或更高版本，您的 rector.php 包含所有相关文件
此库的最新版本

根据您项目的规模，您可以选择一次性迁移所有枚举，或者一次迁移几个或一个枚举。

一次性转换所有枚举： php artisan enum:to-native
传递枚举的完全限定类名以限制转换： php artisan enum:to-native "App\Enums\UserType"

如果有任何枚举在 Laravel 的引导阶段使用，转换其使用会影响 Larastan 并防止 Rector 进行第二次运行。

审查和验证代码更改，以检查遗漏的边缘情况

见未实现
Enum::coerce()：如果只传递了值，可以替换为tryFrom()。如果也可以传递键或实例，可能需要额外的逻辑来处理这种情况。
Enum::$description 和 Enum::getDescription()：实现一个替代方案。
处理 Arslan\Enum\Exceptions\InvalidEnumKeyException 或 Arslan\Enum\Exceptions\InvalidEnumMemberException 的 try/catch 块。可以捕获原生枚举抛出的 ValueError，或者切换到使用 tryFrom() 并处理 null。

一旦所有枚举都已转换，就可以移除对该库的依赖。

枚举库

从常用、社区贡献的枚举列表中浏览和下载。

枚举库 →

基本用法

枚举定义

可以使用以下 Artisan 命令来生成新的枚举类

php artisan make:enum UserType

现在，只需要添加枚举可以有的可能值作为常量。

<?php declare(strict_types=1);

namespace App\Enums;

use Arslan\Enum\Enum;

final class UserType extends Enum
{
    const Administrator = 0;
    const Moderator = 1;
    const Subscriber = 2;
    const SuperAdministrator = 3;
}

就是这样！请注意，因为枚举值被定义为普通常量，所以可以像访问任何其他类的常量一样访问它们。

UserType::Administrator // Has a value of 0

实例化

实例化枚举很有用，可以传递给函数，同时具有类型提示的好处。

此外，无法用无效值实例化枚举，因此可以确定传递的值始终有效。

为了方便，枚举可以以多种方式实例化

// Standard new PHP class, passing the desired enum value as a parameter
$enumInstance = new UserType(UserType::Administrator);

// Same as the constructor, instantiate by value
$enumInstance = UserType::fromValue(UserType::Administrator);

// Use an enum key instead of its value
$enumInstance = UserType::fromKey('Administrator');

// Statically calling the key name as a method, utilizing __callStatic magic
$enumInstance = UserType::Administrator();

// Attempt to instantiate a new Enum using the given key or value. Returns null if the Enum cannot be instantiated.
$enumInstance = UserType::coerce($someValue);

如果您想让 IDE 自动完成静态实例化辅助函数，可以通过 artisan 命令生成 PHPDoc 注释。

默认情况下，所有位于 app/Enums 的 Enums 都将被注释（可以通过传递一个路径到 --folder 来更改文件夹）。

php artisan enum:annotate

可以通过指定类名来注释单个类。

php artisan enum:annotate "App\Enums\UserType"

实例属性

一旦有了枚举实例，就可以通过属性访问 key、value 和 description。

$userType = UserType::fromValue(UserType::SuperAdministrator);

$userType->key; // SuperAdministrator
$userType->value; // 3
$userType->description; // Super Administrator

这在将枚举实例传递到 blade 视图时特别有用。

实例铸造

枚举实例可以通过实现 __toString() 魔术方法转换为字符串。
这意味着它们可以在 blade 视图中输出，例如。

$userType = UserType::fromValue(UserType::SuperAdministrator);

(string) $userType // '3'

实例等价

可以通过传递给 is 方法来检查实例与任何值的相等性。为了方便起见，还有一个 isNot 方法，它是 is 方法的相反。

$admin = UserType::Administrator();

$admin->is(UserType::Administrator);   // true
$admin->is($admin);                    // true
$admin->is(UserType::Administrator()); // true

$admin->is(UserType::Moderator);       // false
$admin->is(UserType::Moderator());     // false
$admin->is('random-value');            // false

还可以使用 in 方法检查实例的值是否与可能的值数组匹配，并使用 notIn 检查实例值是否不在值数组中。也可以检查可迭代的值。

$admin = UserType::Administrator();

$admin->in([UserType::Moderator, UserType::Administrator]);     // true
$admin->in([UserType::Moderator(), UserType::Administrator()]); // true

$admin->in([UserType::Moderator, UserType::Subscriber]);        // false
$admin->in(['random-value']);                                   // false

$admin->notIn([UserType::Moderator, UserType::Administrator]);     // false
$admin->notIn([UserType::Moderator(), UserType::Administrator()]); // false

$admin->notIn([UserType::Moderator, UserType::Subscriber]);        // true
$admin->notIn(['random-value']);                                   // true

实例化的枚举不是单例，每次都会创建一个新的对象。因此，不同枚举实例的严格比较 === 总是返回 false，无论值如何。相比之下，松散比较 == 取决于值。

$admin = UserType::Administrator();

$admin === UserType::Administrator();                    // false
UserType::Administrator() === UserType::Administrator(); // false
$admin === UserType::Moderator();                        // false

$admin === $admin;                                       // true

$admin == UserType::Administrator(); // true
$admin == UserType::Administrator;   // true

$admin == UserType::Moderator();     // false
$admin == UserType::Moderator;       // false

类型提示

枚举实例的一个好处是它允许使用类型提示，如下所示。

function canPerformAction(UserType $userType)
{
    if ($userType->is(UserType::SuperAdministrator)) {
        return true;
    }

    return false;
}

$userType1 = UserType::fromValue(UserType::SuperAdministrator);
$userType2 = UserType::fromValue(UserType::Moderator);

canPerformAction($userType1); // Returns true
canPerformAction($userType2); // Returns false

标记/位枚举

标准枚举一次代表一个值，但标记或位枚举可以同时表示多个值。这使得它们非常适合在需要表达有限选项集的多个选择时使用。一个很好的例子是用户权限，其中可能存在有限数量的权限，但用户可以有零个、一些或所有这些权限。

可以使用以下 artisan 命令创建标记枚举

php artisan make:enum UserPermissions --flagged

定义值

在定义值时，必须使用 2 的幂，最简单的方法是使用左移 << 运算符，如下所示

final class UserPermissions extends FlaggedEnum
{
    const ReadComments      = 1 << 0;
    const WriteComments     = 1 << 1;
    const EditComments      = 1 << 2;
    const DeleteComments    = 1 << 3;
    // The next one would be `1 << 4` and so on...
}

定义快捷方式

可以使用位或 | 来设置表示一组给定值的快捷方式。

final class UserPermissions extends FlaggedEnum
{
    const ReadComments      = 1 << 0;
    const WriteComments     = 1 << 1;
    const EditComments      = 1 << 2;
    const DeleteComments    = 1 << 3;

    // Shortcuts
    const Member = self::ReadComments | self::WriteComments; // Read and write.
    const Moderator = self::Member | self::EditComments; // All the permissions a Member has, plus Edit.
    const Admin = self::Moderator | self::DeleteComments; // All the permissions a Moderator has, plus Delete.
}

实例化标记枚举

有几种方法可以实例化标记枚举

// Standard new PHP class, passing the desired enum values as an array of values or array of enum instances
$permissions = new UserPermissions([UserPermissions::ReadComments, UserPermissions::EditComments]);
$permissions = new UserPermissions([UserPermissions::ReadComments(), UserPermissions::EditComments()]);

// Static flags method, again passing the desired enum values as an array of values or array of enum instances
$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::EditComments]);
$permissions = UserPermissions::flags([UserPermissions::ReadComments(), UserPermissions::EditComments()]);

属性转换与单值枚举的工作方式相同。

空标记枚举

标记枚举可以完全不包含值。每个标记枚举都有一个预定义的常量 None，它与 0 相当。

UserPermissions::flags([])->value === UserPermissions::None; // True

标记枚举方法

除了标准的枚举方法外，标记枚举还有一些实用的方法可用。

注意：在传递静态属性的地方，你也可以传递枚举实例。

setFlags(array $flags): Enum

将枚举的标志设置为给定的标志数组。

$permissions = UserPermissions::flags([UserPermissions::ReadComments]);
$permissions->flags([UserPermissions::EditComments, UserPermissions::DeleteComments]); // Flags are now: EditComments, DeleteComments.

addFlag($flag): Enum

将给定的标志添加到枚举中

$permissions = UserPermissions::flags([UserPermissions::ReadComments]);
$permissions->addFlag(UserPermissions::EditComments); // Flags are now: ReadComments, EditComments.

addFlags(array $flags): Enum

将给定的标志添加到枚举中

$permissions = UserPermissions::flags([UserPermissions::ReadComments]);
$permissions->addFlags([UserPermissions::EditComments, UserPermissions::WriteComments]); // Flags are now: ReadComments, EditComments, WriteComments.

addAllFlags(): Enum

将所有标志添加到枚举中

$permissions = UserPermissions::flags([UserPermissions::ReadComments]);
$permissions->addAllFlags(); // Enum now has all flags

removeFlag($flag): Enum

从枚举中移除给定的标志

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->removeFlag(UserPermissions::ReadComments); // Flags are now: WriteComments.

removeFlags(array $flags): Enum

从枚举中移除给定的标志

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments, UserPermissions::EditComments]);
$permissions->removeFlags([UserPermissions::ReadComments, UserPermissions::WriteComments]); // Flags are now: EditComments.

removeAllFlags(): Enum

从枚举中移除所有标志

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->removeAllFlags();

hasFlag($flag): bool

检查枚举是否有指定的标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->hasFlag(UserPermissions::ReadComments); // True
$permissions->hasFlag(UserPermissions::EditComments); // False

hasFlags(array $flags): bool

检查枚举是否有所有指定的标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->hasFlags([UserPermissions::ReadComments, UserPermissions::WriteComments]); // True
$permissions->hasFlags([UserPermissions::ReadComments, UserPermissions::EditComments]); // False

notHasFlag($flag): bool

检查枚举是否没有指定的标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->notHasFlag(UserPermissions::EditComments); // True
$permissions->notHasFlag(UserPermissions::ReadComments); // False

notHasFlags(array $flags): bool

检查枚举是否没有任何指定的标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->notHasFlags([UserPermissions::ReadComments, UserPermissions::EditComments]); // True
$permissions->notHasFlags([UserPermissions::ReadComments, UserPermissions::WriteComments]); // False

getFlags(): Enum[]

以实例数组的形式返回标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->getFlags(); // [UserPermissions::ReadComments(), UserPermissions::WriteComments()];

hasMultipleFlags(): bool

检查枚举上是否设置了多个标志。

$permissions = UserPermissions::flags([UserPermissions::ReadComments, UserPermissions::WriteComments]);
$permissions->hasMultipleFlags(); // True;
$permissions->removeFlag(UserPermissions::ReadComments)->hasMultipleFlags(); // False

getBitmask(): int

获取枚举的位掩码。

UserPermissions::Member()->getBitmask(); // 11;
UserPermissions::Moderator()->getBitmask(); // 111;
UserPermissions::Admin()->getBitmask(); // 1111;
UserPermissions::DeleteComments()->getBitmask(); // 1000;

Eloquent查询中的标记枚举

要在Eloquent查询中直接使用标记枚举，你可以在模型上使用 QueriesFlaggedEnums 特性，该特性提供了以下方法

hasFlag($column, $flag): Builder

User::hasFlag('permissions', UserPermissions::DeleteComments())->get();

notHasFlag($column, $flag): Builder

User::notHasFlag('permissions', UserPermissions::DeleteComments())->get();

hasAllFlags($column, $flags): Builder

User::hasAllFlags('permissions', [UserPermissions::EditComment(), UserPermissions::ReadComment()])->get();

hasAnyFlags($column, $flags): Builder

User::hasAnyFlags('permissions', [UserPermissions::DeleteComments(), UserPermissions::EditComments()])->get();

属性铸造

你可以使用Laravel内置的自定义转换将模型属性转换为枚举。这将在获取时将属性转换为枚举实例，并在设置时将枚举值转换回枚举。由于 Enum::class 实现了 Castable 合同，你只需指定枚举的类名。

use Arslan\Enum\Tests\Enums\UserType;
use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    protected $casts = [
        'random_flag' => 'boolean',     // Example standard laravel cast
        'user_type' => UserType::class, // Example enum cast
    ];
}

现在，当你访问 Example 模型的 user_type 属性时，底层值将作为 UserType 枚举返回。

$example = Example::first();
$example->user_type // Instance of UserType

查看枚举实例上的方法和属性，以充分利用属性转换。

你可以通过传递枚举值或另一个枚举实例来设置值。

$example = Example::first();

// Set using enum value
$example->user_type = UserType::Moderator;

// Set using enum instance
$example->user_type = UserType::Moderator();

自定义 `$model->toArray()` 行为

当你使用 toArray（或在控制器中返回模型/模型作为响应）时，Laravel 将在枚举实例上调用 toArray 方法。

默认情况下，这将仅返回其原生类型的值。你可能还想要访问其他属性（键、描述），例如返回到javascript应用。

要自定义此行为，你可以在枚举实例上覆盖 toArray 方法。

// Example Enum
final class UserType extends Enum
{
    const ADMINISTRATOR = 0;
    const MODERATOR = 1;
}

$instance = UserType::Moderator();

// Default
public function toArray()
{
    return $this->value;
}
// Returns int(1)

// Return all properties
public function toArray()
{
    return $this;
}
// Returns an array of all the properties
// array(3) {
//  ["value"]=>
//  int(1)"
//  ["key"]=>
//  string(9) "MODERATOR"
//  ["description"]=>
//  string(9) "Moderator"
// }

转换底层原生类型

许多数据库将所有内容都返回为字符串（例如，整数可能以字符串 '1' 返回）。为了减少库用户的摩擦，我们使用类型强制转换来确定预期的值。如果你希望控制这一点，你可以覆盖你的枚举类上的 parseDatabase 静态方法

final class UserType extends Enum
{
    const Administrator = 0;
    const Moderator = 1;

    public static function parseDatabase($value)
    {
        return (int) $value;
    }
}

从 parseDatabase 方法返回 null 将导致模型上的属性也变为 null。这可以用于如果你的数据库存储不一致的空白值，例如空字符串而不是 NULL。

模型注解

如果你正在将模型属性转换为枚举，可以使用 laravel-ide-helper 包来自动为你生成属性docblocks。

迁移

使用 `enum` 列类型

或者，您可以在迁移中使用 Enum 类来定义枚举列。枚举值必须定义为字符串。

use App\Enums\UserType;
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up(): void
    {
        Schema::table('users', function (Blueprint $table): void {
            $table->bigIncrements('id');
            $table->timestamps();
            $table->enum('type', UserType::getValues())
                ->default(UserType::Moderator);
        });
    }
}

验证

数组验证

枚举值

您可以使用 EnumValue 规则验证传递给控制器的枚举值是否为给定枚举的有效值。

use Arslan\Enum\Rules\EnumValue;

public function store(Request $request)
{
    $this->validate($request, [
        'user_type' => ['required', new EnumValue(UserType::class)],
    ]);
}

默认情况下，类型检查设置为严格，但您可以通过将 false 传递给 EnumValue 类的可选第二个参数来绕过此设置。

new EnumValue(UserType::class, false) // Turn off strict type checking.

枚举键

您还可以使用 EnumKey 规则进行键验证。如果您将枚举键作为 URL 参数进行排序或过滤等，这非常有用。

use Arslan\Enum\Rules\EnumKey;

public function store(Request $request)
{
    $this->validate($request, [
        'user_type' => ['required', new EnumKey(UserType::class)],
    ]);
}

枚举实例

此外，您还可以验证参数是否为给定枚举的实例。

use Arslan\Enum\Rules\Enum;

public function store(Request $request)
{
    $this->validate($request, [
        'user_type' => ['required', new Enum(UserType::class)],
    ]);
}

管道验证

您还可以使用 'pipe' 语法来定义规则。

enum_value:enum_class,[strict]
enum_key:enum_class
enum:enum_class

'user_type' => 'required|enum_value:' . UserType::class,
'user_type' => 'required|enum_key:' . UserType::class,
'user_type' => 'required|enum:' . UserType::class,

本地化

验证消息

运行以下命令以将语言文件发布到您的 lang 文件夹。

php artisan vendor:publish --provider="Arslan\Enum\EnumServiceProvider" --tag="translations"

枚举描述

您可以使用 Laravel 内置的本地化功能来翻译 getDescription 方法返回的字符串。

为您的每种支持的语言添加一个新的 enums.php 键文件。在这个例子中有一个英文和一个西班牙语。

// lang/en/enums.php
<?php declare(strict_types=1);

use App\Enums\UserType;

return [

    UserType::class => [
        UserType::Administrator => 'Administrator',
        UserType::SuperAdministrator => 'Super administrator',
    ],

];

// lang/es/enums.php
<?php declare(strict_types=1);

use App\Enums\UserType;

return [

    UserType::class => [
        UserType::Administrator => 'Administrador',
        UserType::SuperAdministrator => 'Súper administrador',
    ],

];

现在，您只需确保您的枚举实现了如下所示的 LocalizedEnum 接口

use Arslan\Enum\Enum;
use Arslan\Enum\Contracts\LocalizedEnum;

final class UserType extends Enum implements LocalizedEnum
{
    // ...
}

现在，getDescription 方法将查找您本地化文件中的值。如果给定键不存在值，则返回默认描述。

自定义描述

自定义类描述

如果您想为枚举类返回自定义描述，请在枚举类中添加 Description 属性

use Arslan\Enum\Enum;
use Arslan\Enum\Attributes\Description;

#[Description('List of available User types')]
final class UserType extends Enum
{
    ...
}

现在调用 UserType::getClassDescription() 返回 可用的用户类型列表 而不是 用户类型。

如果您希望对描述有更多控制，也可以在基枚举类上覆盖 getClassDescription 方法。

自定义值描述

如果您想为枚举值返回自定义描述，请在枚举常量中添加 Description 属性

use Arslan\Enum\Enum;
use Arslan\Enum\Attributes\Description;

final class UserType extends Enum
{
    const Administrator = 'Administrator';

    #[Description('Super admin')]
    const SuperAdministrator = 'SuperAdministrator';
}

现在调用 UserType::SuperAdministrator()->description 返回 超级管理员 而不是 超级管理员。

如果您希望对描述有更多控制，也可以在基枚举类上覆盖 getDescription 方法。

扩展枚举基类

Enum 基类实现了 Laravel Macroable 特性，这意味着它可以很容易地通过您自己的函数进行扩展。如果您有一个经常添加到每个枚举中的函数，您可以使用宏。

假设我们想能够获取枚举 asArray 方法的翻转版本，我们可以这样做

Enum::macro('asFlippedArray', function() {
    return array_flip(self::asArray());
});

现在，我可以在每个枚举上调用它，使用 UserType::asFlippedArray()。

最好在服务提供者的 boot 方法中注册宏。

Laravel Nova 集成

使用 Simple Squid 的 nova-enum-field 包来轻松地为 Nova 中的枚举创建字段。请参阅他们的自述文件以了解用法。

PHPStan 集成

如果您使用 PHPStan 进行静态分析，请启用扩展以

正确识别魔法实例化方法
检测重复的枚举值

使用 PHPStan 扩展安装程序或将以下内容添加到您的项目的 phpstan.neon 包含文件中：

includes:
- vendor/Arslan/laravel-enum/extension.neon

Artisan 命令列表

`php artisan make:enum`

创建一个新的枚举类。使用 --flagged 选项创建标记枚举。
了解更多信息

`php artisan enum:annotate`

为枚举类生成 DocBlock 注释。
了解更多信息

`php artisan enum:to-native`

查看迁移到原生 PHP 枚举。

枚举类参考

static getKeys(mixed $values = null): array

返回枚举的所有或自定义键的数组。

UserType::getKeys(); // Returns ['Administrator', 'Moderator', 'Subscriber', 'SuperAdministrator']
UserType::getKeys(UserType::Administrator); // Returns ['Administrator']
UserType::getKeys(UserType::Administrator, UserType::Moderator); // Returns ['Administrator', 'Moderator']
UserType::getKeys([UserType::Administrator, UserType::Moderator]); // Returns ['Administrator', 'Moderator']

static getValues(mixed $keys = null): array

返回枚举的所有或自定义值的数组。

UserType::getValues(); // Returns [0, 1, 2, 3]
UserType::getValues('Administrator'); // Returns [0]
UserType::getValues('Administrator', 'Moderator'); // Returns [0, 1]
UserType::getValues(['Administrator', 'Moderator']); // Returns [0, 1]

static getKey(mixed $value): string

返回给定枚举值的键。

UserType::getKey(1); // Returns 'Moderator'
UserType::getKey(UserType::Moderator); // Returns 'Moderator'

static getValue(string $key): mixed

返回给定枚举键的值。

UserType::getValue('Moderator'); // Returns 1

static hasKey(string $key): bool

检查枚举是否包含指定的键。

UserType::hasKey('Moderator'); // Returns 'True'

static hasValue(mixed $value, bool $strict = true): bool

检查枚举是否包含指定的值。

UserType::hasValue(1); // Returns 'True'

// It's possible to disable the strict type checking:
UserType::hasValue('1'); // Returns 'False'
UserType::hasValue('1', false); // Returns 'True'

static getClassDescription(): string

返回枚举类的句子格式类名。如果猜测的描述不合适，可以自定义描述。

UserType::getClassDescription(); // Returns 'User type'

static getDescription(mixed $value): string

返回枚举值的句子格式键。如果猜测的描述不合适，可以自定义描述。

UserType::getDescription(3); // Returns 'Super administrator'
UserType::getDescription(UserType::SuperAdministrator); // Returns 'Super administrator'

static getRandomKey(): string

返回枚举的随机键。对工厂类很有用。

UserType::getRandomKey(); // Returns 'Administrator', 'Moderator', 'Subscriber' or 'SuperAdministrator'

static getRandomValue(): mixed

返回枚举的随机值。对工厂类很有用。

UserType::getRandomValue(); // Returns 0, 1, 2 or 3

static getRandomInstance(): mixed

返回枚举的随机实例。对工厂类很有用。

UserType::getRandomInstance(); // Returns an instance of UserType with a random value

static asArray(): array

以关联数组的形式返回枚举键值对。

UserType::asArray(); // Returns ['Administrator' => 0, 'Moderator' => 1, 'Subscriber' => 2, 'SuperAdministrator' => 3]

static asSelectArray(): array

返回用于选择中的枚举，格式为 value => description。

UserType::asSelectArray(); // Returns [0 => 'Administrator', 1 => 'Moderator', 2 => 'Subscriber', 3 => 'Super administrator']

static fromValue(mixed $enumValue): Enum

返回调用枚举的实例。有关实例化的更多信息。

UserType::fromValue(UserType::Administrator); // Returns instance of Enum with the value set to UserType::Administrator

static getInstances(): array

返回所有可能的调用枚举实例的数组，键为常量名称。

var_dump(UserType::getInstances());

array(4) {
  'Administrator' =>
  class Arslan\Enum\Tests\Enums\UserType#415 (3) {
    public $key =>
    string(13) "Administrator"
    public $value =>
    int(0)
    public $description =>
    string(13) "Administrator"
  }
  'Moderator' =>
  class Arslan\Enum\Tests\Enums\UserType#396 (3) {
    public $key =>
    string(9) "Moderator"
    public $value =>
    int(1)
    public $description =>
    string(9) "Moderator"
  }
  'Subscriber' =>
  class Arslan\Enum\Tests\Enums\UserType#393 (3) {
    public $key =>
    string(10) "Subscriber"
    public $value =>
    int(2)
    public $description =>
    string(10) "Subscriber"
  }
  'SuperAdministrator' =>
  class Arslan\Enum\Tests\Enums\UserType#102 (3) {
    public $key =>
    string(18) "SuperAdministrator"
    public $value =>
    int(3)
    public $description =>
    string(19) "Super administrator"
  }
}

static coerce(mixed $enumKeyOrValue): ?Enum

尝试使用给定的键或值创建新的 Enum 实例。如果 Enum 无法实例化，则返回 null。

UserType::coerce(0); // Returns instance of UserType with the value set to UserType::Administrator
UserType::coerce('Administrator'); // Returns instance of UserType with the value set to UserType::Administrator
UserType::coerce(99); // Returns null (not a valid enum value)

存根

运行以下命令以将存根文件发布到应用程序根目录下的 stubs 文件夹：

php artisan vendor:publish --provider="Arslan\Enum\EnumServiceProvider" --tag="stubs"

beingarslan / laravel-enum

维护者

详细信息