
本文深入探讨了在php中如何根据字符串获取枚举(enum)案例的多种方法。我们将详细介绍针对支持值枚举(backedenums)的`tryfrom()`和`from()`原生方法,以及如何为不带值的枚举(simple enums)或需要通过案例名称获取时,实现自定义的静态辅助方法。文章旨在提供清晰的指导和代码示例,帮助开发者高效地处理枚举与字符串之间的转换。
在PHP 8.1及更高版本中引入的枚举(Enums)为我们提供了一种定义一组有限、命名值的方式,极大地提升了代码的可读性和类型安全性。根据其定义方式,枚举可分为两种类型:不带值的枚举(Simple Enums)和支持值枚举(BackedEnums)。理解这两种类型及其特性,是高效地从字符串获取枚举案例的基础。
1. 理解 PHP 枚举类型
1.1 不带值的枚举 (Simple Enums)
不带值的枚举,也称为纯枚举,其案例仅作为符号存在,不关联任何标量值。它们主要用于表示一组互斥的状态或选项。
1.2 支持值枚举 (BackedEnums)
支持值枚举允许每个案例关联一个明确的标量值(int 或 string)。这些值可以在外部系统(如数据库、API)中使用,从而实现枚举与外部数据源的无缝集成。
2. 访问枚举案例的属性
无论是哪种枚举,都可以通过->name属性获取其案例的字符串名称。对于支持值枚举,还可以通过->value属性获取其关联的标量值。
立即学习“PHP免费学习笔记(深入)”;
name; // 输出: "OK" echo Status::OK->value; // 输出: "OK" (对于string BackedEnum) enum SimpleStatus { case ACTIVE; case INACTIVE; } echo SimpleStatus::ACTIVE->name; // 输出: "ACTIVE" // SimpleStatus::ACTIVE->value; // 错误:Simple Enum 没有 value 属性3. 原生方法:通过值获取支持值枚举 (BackedEnums) 案例
PHP为支持值枚举提供了原生的静态方法tryFrom()和from(),允许开发者通过其关联的标量值来获取对应的枚举案例。
3.1 BackedEnum::tryFrom(string|int $value)
此方法尝试根据提供的标量值查找并返回匹配的枚举案例。如果找不到匹配的案例,它将返回null。
3.2 BackedEnum::from(string|int $value)
与tryFrom()类似,但如果找不到匹配的案例,from()方法会抛出一个ValueError异常。这适用于你确定输入值一定有效,或者希望显式捕获并处理错误的情况。
getMessage() . "\n"; }注意事项: tryFrom()和from()方法是针对支持值枚举的值进行匹配的,而不是案例名称。如果你的字符串是案例名称而不是值,这些方法将无法直接使用。
4. 自定义方法:通过名称获取枚举案例
对于不带值的枚举,或者当你想通过枚举案例的名称(而不是值)来获取案例时,PHP没有提供原生的静态方法。在这种情况下,你需要实现一个自定义的静态辅助方法。
一个常见的实现方式是遍历枚举的所有案例(通过Enum::cases()方法),然后比较每个案例的->name属性与输入的字符串。
name === $name) { return $statusCase; } } return null; } } $statusOk = Status::get("OK"); // 返回 Status::OK var_dump($statusOk); $statusPending = Status::get("pending "); // 返回 Status::PENDING (处理了大小写和空格) var_dump($statusPending); $statusNotFound = Status::get("UNKNOWN"); // 返回 null var_dump($statusNotFound); // 同样适用于 BackedEnum,如果你想通过名称而不是值获取 enum HttpMethod: string { case GET = "GET"; case POST = "POST"; public static function getByName(string $name): ?self { $name = strtoupper(trim($name)); if (empty($name)) { return null; } foreach (self::cases() as $methodCase) { if ($methodCase->name === $name) { return $methodCase; } } return null; } } $method = HttpMethod::getByName("post"); // 返回 HttpMethod::POST var_dump($method);这个自定义的get方法提供了强大的灵活性,可以根据你的需求添加额外的逻辑,例如处理大小写不敏感的匹配、去除空格等。
5. 选择合适的策略与最佳实践
- 使用支持值枚举 (BackedEnums) 和 tryFrom()/from(): 如果你的枚举案例与外部系统中的特定字符串或整数值直接关联,并且你希望通过这些值进行查找,那么使用支持值枚举是最佳选择。这提供了原生支持,代码简洁且性能高效。
- 使用自定义 get 方法: 如果你的枚举是不带值的,或者你需要通过枚举案例的名称(而非其值)进行查找,那么实现一个自定义的静态方法是必要的。这种方法提供了最大的灵活性,可以根据实际需求定制匹配逻辑。
- 错误处理: tryFrom()返回null,from()抛出ValueError。自定义方法通常返回null。选择哪种方式取决于你对未找到匹配情况的处理策略。
- 大小写敏感性: 在实现自定义get方法时,请考虑是否需要进行大小写不敏感的匹配。使用strtoupper()、strtolower()或strcasecmp()可以实现这一目标。
- 命名约定: 保持枚举案例名称与你期望通过字符串查找的名称之间的一致性,有助于减少混淆。
总结
从字符串获取PHP枚举案例的方法取决于枚举的类型以及你希望匹配的是案例的“值”还是“名称”。对于支持值枚举,tryFrom()和from()提供了高效的原生解决方案,通过匹配其关联的标量值来获取案例。然而,若要通过案例的字符串名称获取,尤其是不带值的枚举,则需要实现一个自定义的静态辅助方法,遍历所有案例并比较其->name属性。理解这些差异并选择合适的策略,将有助于你更有效地利用PHP枚举,编写出健壮且易于维护的代码。











