PHP 枚舉類型的管理與設計

本文的實作主要是基於 myclabs/php-enum 擴充包。

今天來分享下如何管理 PHP 的列舉型別。

一種常見的方式是，使用常數來代表枚舉類型

const YES = '是';
const NO = '否';

可以在這個基礎上更進一步，將其封裝成類，以便於管理

class BoolEnum {
    const YES = '是';
    const NO = '否';
}

現在，我們希望能透過方法來動態呼叫對應的枚舉類型

BoolEnum::YES(); // 是
BoolEnum::NO(); // 否

也可以批次取得枚舉類型

BoolEnum::toArray(); // ['Yes' => '是', 'No' => '否']

下面來實現上面列舉的功能。

定義基本的枚舉基底類，讓所有的枚舉類別都繼承該抽象基底類別。

abstract class Enum
{   
    // 获取所有枚举类型
    public static function toArray(){
        // 通过反射获取常量
        $reflection = new \ReflectionClass(static::class);
        $contants = $reflection->getConstants();
        // 返回对应的常量
        return $contants;
    }
    //  动态调用属性
    public static function __callStatic($name, $arguments)
    {
        $arr = static::toArray();
        if(isset($arr[$name])){
            return $arr[$name];
        }
        throw new \BadMethodCallException("找不到对应的枚举值 {$name}");
    }
}
class BoolEnum extends Enum
{
    const YES = '是';
    const NO = '否';
}

利用反射，可以取得到所有的枚舉類型。同時，利用魔術方法則可以實現對屬性的動態呼叫。這裡要注意的是，反射會消耗較多的資源，因此，對 toArray 方法進行重構，增加一個快取變數來快取所獲得的枚舉類型，避免重複使用反射。

abstract class Enum
{   
    protected static $cache = [];
    public static function toArray(){
        $class = static::class;
        // 第一次获取，就通过反射来获取
        if(! isset(static::$cache[$class])){
            $reflection = new \ReflectionClass(static::class);
            static::$cache[$class] = $reflection->getConstants();
        }
        return static::$cache[$class];
    }
}

現在考慮更多的使用場景，例如用實例來代表特定枚舉類型

$yes = new BoolEnum("是");
echo $yes; // "是"

實現如下

abstract Enum 
{
    protected $value;
    public function __construct($value)
    {   
        if ($value instanceof static) {
            $value = $value->getValue();
        }
        if(! $this->isValid($value)){
            throw new \UnexpectedValueException("$value 不属于该枚举值" . static::class);
        }
        $this->value = $value;
    }
    // 获取实例对应的键
    public function getKey(){
        return array_search($this->value, static::toArray(), true);
    }
    // 获取实例对应的值
    public function getValue()
    {
        return $this->value;
    }
    // 允许字符串形式输出
    public function __toString()
    {
        return $this->value;
    }
    // 验证值是否合法
    public function isValid($value)
    {
      $arr = static::toArray();
      return in_array($value, $arr, true);
    }
    // 验证键是否合法
    public function isValidKey($key)
    {
      $arr = static::toArray();
      return array_key_exists($key, $arr);
    }
}

這樣做可避免使用者使用非法的枚舉類型的值

$user->banned = '非法值';  // 可能不会报错
$yes = new BoolEnum("非法值"); // 将会抛出异常
$user->banned = $yes;

或作為參數類型限定

function setUserStatus(BoolEnum $boolEnum){
    $user->banned = $boolEnum;
}

PHP 作為一門弱型別語言，參數限定的不足會導致很多不可預期的錯誤發生，透過使用枚舉類，我們進一步加強了參數限定的功能，同時，管理枚舉型別也更加的方便統一。

以上是PHP 枚舉類型的管理與設計的詳細內容。更多資訊請關注PHP中文網其他相關文章！