本篇文章给大家带来的内容是关于如何使用php来实现枚举?有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助。
枚举
在数学和计算机科学理论中,一个集的枚举是列出某些有穷序列集的所有成员的程序,或者是一种特定类型对象的计数。这两种类型经常(但不总是)重叠。枚举是一个被命名的整型常数的集合,枚举在日常生活中很常见,例如表示星期的sunday、monday、tuesday、wednesday、thursday、friday、saturday就是一个枚举。—— 维基百科
业务场景
在实际开发过程中我们非常容易接触到枚举类型,但是又因为 php 原生对枚举的支持不是太好,所以很多时候 开发人员并没有重视枚举的使用,而是使用全局常量或者类常量代替,而这两个数据原则上还是 字符串 并不能用来做类型判断。
业务订单状态 待支付/待发货/待收货/待评价会员状态 激活/未激活....等等 ,很多时候我们都会用简单的 1/2/3/4 或者0/1 这样的方式去代表,然后在文档或者注释中规定这些东西。
更高级一点儿的就是定义成常量,然后方便统一存取,但是常量的值还是是字符串,无法进行类型判断。
这里就要看一下 php 对枚举的支持,虽然 php 对枚举没有完美的支持,但是在 spl 中还是有一个基础的枚举类
spl 枚举splenum extends spltype {/ constants /const null __default = null ;/ 方法 /public getconstlist ([ bool $include_default = false ] ) : array/ 继承的方法 /spltype::__construct ( [mixed $initial_value [, bool $strict ]] )}
但是!这个需要额外的安装 pecl 用 pecl 安装 spl_types,无意间增加了使用成本,那有没有其他解决方案?答案是肯定的。
直接手写一个。
开始准备首先定一个枚举
class enum{ // 默认值 const __default = self::wait_payment; // 待付款 const wait_payment = 0; // 待发货 const wait_ship = 1; // 待收货 const wait_receipt = 2; // 待评价 const wait_comment = 3;}
这样似乎就完成了,我们直接使用 enum::wait_payment 就可以拿到里面的值了,但是传参的地方我们并没法校验他。
function setstatus(enum $status){ // todo}setstatus(enum::wait_payment);// error 显然这是不行的 因为上面常量的值时一个 int 并不是 enum 类型。
这里我们就需要用到 php 面向对象中的一个魔术方法 __tostring()
public __tostring ( void ) : string__tostring() 方法用于一个类被当成字符串时应怎样回应。例如 echo $obj; 应该显示些什么。此方法必须返回一个字符串,否则将发出一条 e_recoverable_error 级别的致命错误。现在我们来完善一下这个方法。
class orderstatus extends enum{ // 默认值 const __default = self::wait_payment; // 待付款 const wait_payment = 0; // 待发货 const wait_ship = 1; // 待收货 const wait_receipt = 2; // 待评价 const wait_comment = 3; public function __tostring() { return '233'; }}// objectecho gettype($orderstatus) . php_eol;// boolean truevar_dump($orderstatus instanceof enum);// 233echo $orderstatus;
初具模型
这里似乎实现了一部分,那我们应该怎么样让他做的更好?再来改造一下。
class orderstatus extends enum{ // 默认值 const __default = self::wait_payment; // 待付款 const wait_payment = 0; // 待发货 const wait_ship = 1; // 待收货 const wait_receipt = 2; // 待评价 const wait_comment = 3; /** * @var string */ protected $value; public function __construct($value = null) { $this->value = is_null($value) ? self::__default : $value; } public function __tostring() { return (string)$this->value; }}// 1️⃣$orderstatus = new orderstatus(orderstatus::wait_ship);// objectecho gettype($orderstatus) . php_eol;// boolean truevar_dump($orderstatus instanceof enum);// 1echo $orderstatus . php_eol;// 2️⃣$orderstatus = new orderstatus();// objectecho gettype($orderstatus) . php_eol;// boolean truevar_dump($orderstatus instanceof enum);// 0echo $orderstatus;// 3️⃣$orderstatus = new orderstatus('意外的参数');// objectecho gettype($orderstatus) . php_eol;// boolean truevar_dump($orderstatus instanceof enum);// 意外的参数echo $orderstatus;
在这一次,我们加入了 构造函数 并且允许他传入一个可选的值,然后来作为 __tostring 方法的输出值,这次看起来不错,功能都已经实现了,如果传入的参数否和我们的预期的话。但是 万一不符合呢?看看,第 3️⃣ 个那里,就已经成了意外了,哪还有没有办法补救?答案当然是 有的 ,在这里我们会用到 php 另一个好东西 反射类 ,当然这个不是 php 特有的,其他语言也有。
当然,除了反射,我们还会用到另外一个东西 方法重载 里面的 __callstatic 方法。
更进一步
public static __callstatic ( string $name , array $arguments ) : mixed在静态上下文中调用一个不可访问方法时,__callstatic() 会被调用。$name 参数是要调用的方法名称。$arguments 参数是一个枚举数组,包含着要传递给方法 $name 的参数。
继续改造。
class enum{ const __default = null; /** * @var string */ protected static $value; // 注意这里 将构造函数的 修饰符改成了 受保护的 即 外部无法直接 new protected function __construct($value = null) { // 很常规 self::$value = is_null($value) ? static::__default : $value; } /** * @param $name * @param $arguments * @return mixed * @throws reflectionexception */ public static function __callstatic($name, $arguments) { // 实例化一个反射类 static::class 表示调用者 $reflectionclass = new reflectionclass(static::class); // 这里我们要有一个约定, 就是类常量成员的名字必须的大写。 // 这里就是取出来调用的静态方法名对应的常量值 虽然这里有个 getvalue 方法 // 但是因为其返回值不可靠 我们就依赖于他原本的隐式的 __tostring 方法来帮我们输出字符串即可。 $constant = $reflectionclass->getconstant(strtoupper($name)); // 获取调用者的 构造方法 $construct = $reflectionclass->getconstructor(); // 设置成可访问 因为我们把修饰符设置成了受保护的 这里需要访问到,所以就需要设置成可访问的。 $construct->setaccessible(true); // 因为现在类已经是可以访问的了所以我们直接实例化即可,实例化之后 php 会自动调用 __tostring 方法 使得返回预期的值。 $static = new static($constant); return $static; } public function __tostring() { return (string)self::$value; }}class orderstatus extends enum{ // 默认值 const __default = self::wait_payment; // 待付款 const wait_payment = 0; // 待发货 const wait_ship = 1; // 待收货 const wait_receipt = 2; // 待评价 const wait_comment = 3;}$wait_ship = orderstatus::wait_ship();var_dump($wait_ship . '');var_dump($wait_ship instanceof enum);
到这里 一个简单的枚举类就完成了。
完结
那如果我们还有其他需求、比如 判断一个值是不是在枚举范围内?获取所有的枚举值?获取所有的枚举键,判断枚举键是否有效?自动格式化「因为 __tostring 方法只允许返回字符串 ,但是有的时候我们强制需要整形、bool 等类型」
class enum{ const __default = null; /** * @var string */ protected static $value; /** * @var reflectionclass */ protected static $reflectionclass; // 注意这里 将构造函数的 修饰符改成了 受保护的 即 外部无法直接 new protected function __construct($value = null) { // 很常规 self::$value = is_null($value) ? static::__default : $value; } /** * @param $name * @param $arguments * @return mixed */ public static function __callstatic($name, $arguments) { // 实例化一个反射类 static::class 表示调用者 $reflectionclass = self::getreflectionclass(); // 这里我们要有一个约定, 就是类常量成员的名字必须的大写。 // 这里就是取出来调用的静态方法名对应的常量值 虽然这里有个 getvalue 方法 // 但是因为其返回值不可靠 我们就依赖于他原本的隐式的 __tostring 方法来帮我们输出字符串即可。 $constant = $reflectionclass->getconstant(strtoupper($name)); // 获取调用者的 构造方法 $construct = $reflectionclass->getconstructor(); // 设置成可访问 因为我们把修饰符设置成了受保护的 这里需要访问到,所以就需要设置成可访问的。 $construct->setaccessible(true); // 因为现在类已经是可以访问的了所以我们直接实例化即可,实例化之后 php 会自动调用 __tostring 方法 使得返回预期的值。 $static = new static($constant); return $static; } /** * 实例化一个反射类 * @return reflectionclass * @throws reflectionexception */ protected static function getreflectionclass() { if (!self::$reflectionclass instanceof reflectionclass) { self::$reflectionclass = new reflectionclass(static::class); } return self::$reflectionclass; } /** * @return string */ public function __tostring() { return (string)self::$value; } /** * 判断一个值是否有效 即是否为枚举成员的值 * @param $val * @return bool * @throws reflectionexception */ public static function isvalid($val) { return in_array($val, self::toarray()); } /** * 转换枚举成员为键值对输出 * @return array * @throws reflectionexception */ public static function toarray() { return self::getenummembers(); } /** * 获取枚举的常量成员数组 * @return array * @throws reflectionexception */ public static function getenummembers() { return self::getreflectionclass() ->getconstants(); } /** * 获取枚举成员值数组 * @return array * @throws reflectionexception */ public static function values() { return array_values(self::toarray()); } /** * 获取枚举成员键数组 * @return array * @throws reflectionexception */ public static function keys() { return array_keys(self::getenummembers()); } /** * 判断 key 是否有效 即存在 * @param $key * @return bool * @throws reflectionexception */ public static function iskey($key) { return in_array($key, array_keys(self::getenummembers())); } /** * 根据 key 去获取枚举成员值 * @param $key * @return static */ public static function getkey($key) { return self::$key(); } /** * 格式枚举结果类型 * @param null|bool|int $type 当此处的值时什么类时 格式化输出的即为此类型 * @return bool|int|string|null */ public function format($type = null) { switch (true) { // 当为纯数字 或者类型处传入的为 int 值时 转为 int case ctype_digit(self::$value) || is_int($type): return (int)self::$value; break; // 当 type 传入 true 时 返回 bool 类型 case $type === true: return (bool)filter_var(self::$value, filter_validate_boolean); break; default: return self::$value; break; } }}class orderstatus extends enum{ // 默认值 const __default = self::wait_payment; // 待付款 const wait_payment = 0; // 待发货 const wait_ship = 1; // 待收货 const wait_receipt = 2; // 待评价 const wait_comment = 3;}$wait_ship = orderstatus::wait_ship();// 直接输出是字符串echo $wait_ship;// 判断类型是否存在var_dump($wait_ship instanceof orderstatus);// 格式化输出一下 是要 字符串 、还是 bool 还是整形// 自动var_dump($wait_ship->format());// 整形var_dump($wait_ship->format(1));// boolvar_dump($wait_ship->format(true));// 判断这个值是否有效的枚举值var_dump(orderstatus::isvalid(2));// 判断这个值是否有效的枚举值var_dump(orderstatus::isvalid(8));// 获取所有枚举成员的 keyvar_dump(orderstatus::keys());// 获取所有枚举成员的值var_dump(orderstatus::values());// 获取枚举成员的键值对var_dump(orderstatus::toarray());// 判断枚举 key 是否有效var_dump(orderstatus::iskey('wait_payment'));// 判断枚举 key 是否有效var_dump(orderstatus::iskey('wait_payment_tmp'));// 根据 key 取去 值 注意 这里取出来的已经不带有类型了// 更加建议直接使用 取类常量的方式去取 或者在高版本的 直接使用类常量修饰符 // 将类常量不可见最佳,但是需要额外处理了var_dump(orderstatus::getkey('wait_payment') ->format(1));
截至目前 一个完整的枚举就完成了~
以上就是如何使用php来实现枚举?的详细内容。