README

关于 Laravel 服务仓库

这是一个通过服务和仓库提升Laravel开发效率的简单且可扩展的包。

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

由 Corine BOCOGA 创建

官方文档

ServiceRepository 的文档可以在 packages.tools/testbench 上找到。

跳转到

• 指南
• 安装
• 枚举库
• 基本用法
  • 枚举定义
  • 实例化
  • 实例属性
  • 实例相等
  • 类型提示
• 标记/位枚举
• 属性转换
• 迁移
• 验证
• 本地化
• 自定义描述
• 扩展枚举基类
• Laravel Nova 集成
• PHPStan 集成
• Artisan 命令列表
• 枚举类参考
• 模板

旧版本文档

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

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

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

指南

我写了一篇关于使用 laravel-enum 的博客文章： https://corine.b.github/blog/using-service-repository-in-laravel

安装

要求

• Laravel 10 或更高版本
• PHP 8.1 或更高版本

通过 Composer

composer require laravel-core-modules/laravel-service-repository

枚举库

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

枚举库 →

基本用法

枚举定义

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

php artisan make:enum UserType

现在，您只需将枚举可能具有的可能值作为常量添加即可。

<?php declare(strict_types=1);

namespace App\Enums;

use BenSampo\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 的枚举类型都将被注解（你可以通过传递路径到 --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; // 0
$userType->description; // Super Administrator

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

实例转换

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

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

(string) $userType // '0'

实例相等

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

$admin = UserType::fromValue(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::fromValue(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

类型提示

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

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 LaravelCoreModule\ServiceRepository\Tests\Repositories\RoleRepository;
use Illuminate\Database\Eloquent\Model;

class Role 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包自动为您生成属性文档块。

迁移

推荐

由于枚举在代码级别强制执行一致性，因此无需在数据库级别再次执行，因此推荐的数据库列类型为string或int，具体取决于您的枚举值。这意味着您可以在代码中添加/删除枚举值，而无需担心数据库层。

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->string('type')
                ->default(UserType::Moderator);
        });
    }
}

使用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 BenSampo\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 BenSampo\Enum\Rules\EnumKey;

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

枚举实例

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

use BenSampo\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,

本地化

验证消息

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

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

枚举描述

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

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

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

use App\Enums\UserType;

return [

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

];

// resources/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 BenSampo\Enum\Enum;
use BenSampo\Enum\Contracts\LocalizedEnum;

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

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

自定义枚举类描述

如果您想为枚举类返回自定义描述，请向您的 Enum 类添加一个 Description 属性

use BenSampo\Enum\Enum;
use BenSampo\Enum\Attributes\Description;

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

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

如果您希望对描述有更多控制，也可以在基 Enum 类上重写 getClassDescription 方法。

自定义值描述

如果您想为枚举值返回自定义描述，请向您的 Enum 常量添加一个 Description 属性

use BenSampo\Enum\Enum;
use BenSampo\Enum\Attributes\Description;

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

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

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

如果您希望对描述有更多控制，也可以在基 Enum 类上重写 getDescription 方法。

扩展枚举基类

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

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

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

现在，在 my 枚举的每个实例上，我都可以使用 UserType::asFlippedArray() 来调用它。

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

Laravel Nova 集成

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

PHPStan 集成

如果您正在使用 PHPStan 进行静态分析，您可以为正确识别魔术实例化方法启用扩展。

将以下内容添加到项目的 phpstan.neon 包含中

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

Artisan 命令列表

php artisan make:service-repository
创建一个新的枚举类。传递 --flagged 选项以创建标记枚举。
了解更多

php artisan enum:annotate
为枚举类生成 DocBlock 注释。
了解更多

枚举类参考

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 BenSampo\Enum\Tests\Enums\UserType#415 (3) {
    public $key =>
    string(13) "Administrator"
    public $value =>
    int(0)
    public $description =>
    string(13) "Administrator"
  }
  'Moderator' =>
  class BenSampo\Enum\Tests\Enums\UserType#396 (3) {
    public $key =>
    string(9) "Moderator"
    public $value =>
    int(1)
    public $description =>
    string(9) "Moderator"
  }
  'Subscriber' =>
  class BenSampo\Enum\Tests\Enums\UserType#393 (3) {
    public $key =>
    string(10) "Subscriber"
    public $value =>
    int(2)
    public $description =>
    string(10) "Subscriber"
  }
  'SuperAdministrator' =>
  class BenSampo\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

尝试使用给定的键或值实例化新的枚举。如果枚举不能实例化，则返回 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)

模块

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

php artisan vendor:publish --provider="LaravelCoreModule\\ServiceRepository\\RepositoryServiceProvider" --tag="modules"

忽略错误

可以通过PHP注释或配置文件来忽略特定的错误。

// @phpstan-ignore-next-line
$test->badMethod();

$test->badMethod(); // @phpstan-ignore-line

当在PHPStan的配置文件中忽略错误时，它们是通过根据错误消息编写正则表达式来忽略的。

parameters:
    ignoreErrors:
        - '#Call to an undefined method .*badMethod\(\)#'

基线文件

在较旧的代码库中，可能很难花费时间修复所有代码以通过高PHPStan级别。

为了解决这个问题，可以生成基线文件。基线文件将创建一个配置文件，其中包含所有当前错误，以便新代码可以按照比旧代码更高的标准编写。(PHPStan 文档)

./vendor/bin/phpstan analyse --generate-baseline

规则

可以在这里找到特定于Laravel的可配置规则列表。

功能

可以在这里找到Larastan功能列表。

自定义PHPDoc类型

可以在这里找到特定于Larastan的PHPDoc类型列表。

自定义PHPStan配置参数

可以在这里找到您可以在PHPStan配置文件中使用自定义配置参数的列表。

要忽略的错误

目前Laravel的一些部分对于Larastan/PHPStan来说过于神奇而难以理解。我们列出了常见的错误要忽略，根据需要添加。

👊🏻 贡献

感谢您考虑为Larastan做出贡献。所有贡献指南都可以在这里找到。

您可以在变更日志中查看最新的更新以及有关更改的详细信息。您还可以关注Twitter账户以获取最新的公告，或者只是来打个招呼：@enunomaduro，@can__vural。

行为准则

为了确保社区对所有成员友好，请阅读并遵守行为准则。

许可证

Testbench是开源软件，遵循MIT许可证。