如何在 PHP 中获取枚举的所有值？

Question

PHP 8.1 即将发布，包括对枚举的支持。我正在测试一些枚举功能，但找不到太多有关它的文档。因此我的问题是：如何获取枚举的所有值？

Answer 1

对于基本枚举：

$suits = array_column(Suit::cases(), 'name');

对于您想要值的支持枚举：

$suits = array_column(Suit::cases(), 'value');

然后你可以做这样的事情：

trait EnumToArray
{

  public static function names(): array
  {
    return array_column(self::cases(), 'name');
  }

  public static function values(): array
  {
    return array_column(self::cases(), 'value');
  }

  public static function array(): array
  {
    return array_combine(self::values(), self::names());
  }

}

enum Suit: string
{

  use EnumToArray;

  case Hearts = 'H';
  case Diamonds = 'D';
  case Clubs = 'C';
  case Spades = 'S';

}

Suit::array()将返回：

Array
(
    [H] => Hearts
    [D] => Diamonds
    [C] => Clubs
    [S] => Spades
)

Answer 2

经过一番研究我找到了答案。您可以使用静态方法：cases()。

enum Status
{
    case PAID;
    case Cancelled;
}

Status::cases();

case 方法将返回一个数组，其中UnitEnum每个值都有一个枚举（接口）。

Answer 3

需要值而不是 Enum 实例？

我为此编写了一个 Composer 包othyn/php-enum-enhancements，因为该UnitEnum::cases()方法不是我想要的，因为它返回MySuperCoolEnum实例数组而不是底层值作为其原始类型，这正是我想要的。

它是一个可以轻松添加到执行以下操作的任何枚举的特征：

• 添加一个新的静态UnitEnum::valueArray(): array方法，该方法将 Enum 中的所有值作为同等类型的 Enum 值数组返回

• 添加一个新的静态UnitEnum::valueList(string $separator = ', '): string方法，该方法将枚举中的所有值作为逗号分隔的列表字符串返回

其中为普通枚举生成以下内容：

<?php

namespace App\Enums;

use Othyn\PhpEnumEnhancements\Traits\EnumEnhancements;

enum TestEnum
{
    use EnumEnhancements;

    case Alpha;
    case Bravo;
    case Charlie;
    case Delta;
    case Echo;
}

var_dump(TestEnum::valueArray());

// Results in the following being printed:
// array(5) {
//   [0]=>
//   string(5) "Alpha"
//   [1]=>
//   string(5) "Bravo"
//   [2]=>
//   string(7) "Charlie"
//   [3]=>
//   string(5) "Delta"
//   [4]=>
//   string(4) "Echo"
// }

var_dump(TestEnum::valueList());

// Results in the following being printed:
// string(34) "Alpha, Bravo, Charlie, Delta, Echo"

var_dump(TestEnum::valueList(separator: ':'));

// Results in the following being printed:
// string(30) "Alpha:Bravo:Charlie:Delta:Echo"

...以及以下支持枚举，以下是示例string：

<?php

namespace App\Enums;

use Othyn\PhpEnumEnhancements\Traits\EnumEnhancements;

enum TestStringBackedEnum: string
{
    use EnumEnhancements;

    case Alpha   = 'alpha';
    case Bravo   = 'bravo';
    case Charlie = 'charlie';
    case Delta   = 'delta';
    case Echo    = 'echo';
}

var_dump(TestStringBackedEnum::valueArray());

// Results in the following being printed:
// array(5) {
//   [0]=>
//   string(5) "alpha"
//   [1]=>
//   string(5) "bravo"
//   [2]=>
//   string(7) "charlie"
//   [3]=>
//   string(5) "delta"
//   [4]=>
//   string(4) "echo"
// }

var_dump(TestStringBackedEnum::valueList());

// Results in the following being printed:
// string(34) "alpha, bravo, charlie, delta, echo"

var_dump(TestStringBackedEnum::valueList(separator: ':'));

// Results in the following being printed:
// string(30) "alpha:bravo:charlie:delta:echo"

...是的，它int也适用于 's！

包的 README 的用法部分中有更多示例。

Answer 4

除了UnitEnum::cases()你可以使用ReflectionEnum这个

$reflection = new ReflectionEnum(Status::class);

$reflection->getCases();

请注意，在这两种情况下您将无法获取枚举方法。但只要ReflectionEnum扩展了，ReflectionClass你就可以使用 ReflectionClass 的其余方法，例如getMethods