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);
    }
}

これにより、ユーザーが不正な列挙型を使用することを回避できます。 value

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

またはパラメータ型修飾として

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

PHP は型付けが弱い言語であるため、パラメータ修飾が不十分な場合は多くの予期しないエラーが発生します。列挙型クラスを使用することで、パラメータ制限の機能がさらに強化されます。強化されると同時に、列挙型の管理がより便利になり、統合されます。

以上がPHP 列挙型の管理と設計の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。