从字符串获取 PHP 枚举（Enum）Case：非支持枚举的实现方法

本文旨在探讨如何在 php 中通过字符串获取枚举（enum）的case。我们将首先介绍支持枚举（backed enums）的 `tryfrom()` 方法及其便捷性，随后重点讲解对于纯枚举（pure enums），由于缺乏内置的 `tryfrom()` 功能，需要如何通过自定义静态方法来实现从字符串名称到枚举case的映射，并提供详细代码示例和注意事项，以帮助开发者高效管理枚举逻辑。

在 PHP 8.1 引入枚举（Enums）后，开发者在处理一组预定义常量时有了更强大的工具。在实际应用中，我们经常需要根据一个字符串值来动态地获取对应的枚举Case。PHP 为不同类型的枚举提供了不同的处理机制。

1. 支持枚举（Backed Enums）的处理

PHP 中的支持枚举（Backed Enums）是指那些为每个Case显式关联了标量值（字符串或整数）的枚举。对于这类枚举，PHP 提供了一个非常便捷的内置方法 tryFrom()（或 from()）来根据其关联值获取对应的Case。

示例：使用 tryFrom() 获取支持枚举Case

<?php
enum Status: string
{
    case OK = "OK";
    case FAILED = "FAILED";
    case PENDING = "PENDING";
}

// 使用 tryFrom() 根据字符串值获取 Case
$statusOk = Status::tryFrom("OK"); // 返回 Status::OK
$statusFailed = Status::tryFrom("FAILED"); // 返回 Status::FAILED
$statusNotFound = Status::tryFrom("NON_EXISTENT"); // 返回 null

var_dump($statusOk);
var_dump($statusNotFound);

// 如果确定值存在，可以使用 from()，但如果值不存在会抛出 ValueError
// $statusError = Status::from("NON_EXISTENT"); // 抛出 ValueError
?>

此外，支持枚举的每个Case都具有 name 和 value 属性：

立即学习“PHP免费学习笔记（深入）”；

• $case->name：返回该Case的名称（字符串，例如 "OK"）。
• $case->value：返回该Case关联的标量值（例如 "OK"）。

2. 纯枚举（Pure Enums）的处理

与支持枚举不同，纯枚举（Pure Enums）的Case没有显式关联的标量值。它们仅作为一组命名常量存在。因此，纯枚举不具备 tryFrom() 或 from() 方法来通过值进行查找。

<?php
enum Status
{
    case OK;
    case FAILED;
    case PENDING;
}

// 对于纯枚举，以下操作是无效的：
// $status = Status::tryFrom("OK"); // 错误：Call to undefined method Status::tryFrom()
?>

当需要从字符串名称（例如 "OK"）获取纯枚举 Status::OK 时，我们需要实现自定义的逻辑。

腾讯混元文生视频

腾讯发布的AI视频生成大模型技术

266

查看详情

3. 为纯枚举实现自定义 get() 方法

为了解决纯枚举无法通过字符串获取Case的问题，我们可以为其定义一个静态辅助方法，该方法遍历所有可用的枚举Case，并根据其名称进行匹配。

自定义 get() 方法实现

<?php
enum Status
{
    case OK;
    case FAILED;
    case PENDING;

    /**
     * 根据字符串名称获取对应的枚举Case。
     *
     * @param string $name 要查找的枚举Case名称。
     * @return null|Status 匹配到的枚举Case，如果未找到则返回 null。
     */
    public static function get(string $name): ?Status
    {
        // 对输入名称进行预处理，去除空白并转换为大写，以实现更健壮的匹配
        $normalizedName = strtoupper(trim($name));

        // 如果处理后的名称为空，则直接返回null
        if (empty($normalizedName)) {
            return null;
        }

        // 遍历所有枚举Case
        foreach (self::cases() as $statusCase) {
            // 比较当前Case的名称与标准化后的输入名称
            if ($statusCase->name === $normalizedName) {
                return $statusCase;
            }
        }

        // 如果遍历完成后仍未找到匹配的Case，则返回null
        return null;
    }
}

// 示例用法
$statusOk = Status::get("OK"); // 返回 Status::OK
$statusFailed = Status::get("failed "); // 返回 Status::FAILED (经过处理)
$statusPending = Status::get("pending"); // 返回 Status::PENDING (经过处理)
$statusNotFound = Status::get("NON_EXISTENT"); // 返回 null
$statusEmpty = Status::get(""); // 返回 null

var_dump($statusOk);
var_dump($statusFailed);
var_dump($statusNotFound);
var_dump($statusEmpty);
?>

代码解析与注意事项：

1. public static function get(string $name): ?Status:
   • 定义了一个公共的静态方法 get，使其可以直接通过 Status::get() 调用。
   • 参数 $name 期望一个字符串，表示要查找的枚举Case名称。
   • 返回类型 ?Status 表示该方法可能返回 Status 枚举的一个Case实例，也可能返回 null（如果未找到）。
2. $normalizedName = strtoupper(trim($name));:
   • 这是一个重要的预处理步骤。trim() 用于移除字符串两端的空白字符，strtoupper() 将字符串转换为大写。
   • 这样做可以提高匹配的健壮性，例如，用户输入 "ok"、" OK " 或 " ok " 都能正确匹配到 Status::OK。
3. if (empty($normalizedName)) { return null; }:
   • 处理空字符串输入的情况，避免后续不必要的循环。
4. foreach (self::cases() as $statusCase):
   • self::cases() 是 PHP 枚举提供的一个静态方法，它返回一个包含所有枚举Case实例的数组。
   • 我们遍历这个数组，逐一检查每个Case。
5. if ($statusCase->name === $normalizedName):
   • 每个枚举Case实例都有一个只读的 name 属性，它返回该Case的声明名称（例如，Status::OK->name 将返回字符串 "OK"）。
   • 我们将当前Case的 name 属性与预处理过的输入名称进行严格比较（===）。
6. 错误处理:
   • 如果循环结束后仍未找到匹配的Case，方法将返回 null，这使得调用者可以优雅地处理未找到的情况，而不会抛出错误。

总结

在 PHP 中，从字符串获取枚举Case的方法取决于枚举的类型：

• 支持枚举（Backed Enums）: 优先使用内置的 tryFrom() 或 from() 方法，它们提供了简洁且高效的解决方案。
• 纯枚举（Pure Enums）: 需要自定义一个静态辅助方法（如 get()），通过遍历 cases() 并比较 ->name 属性来实现查找功能。在实现自定义方法时，应考虑输入字符串的标准化（如去除空白、统一大小写）以增强鲁棒性。

选择合适的实现方式能够确保代码的清晰性、可维护性以及处理各种输入情况的健壮性。

以上就是从字符串获取 PHP 枚举（Enum）Case：非支持枚举的实现方法的详细内容，更多请关注php中文网其它相关文章！