SW-X的 枚举类 常用操作,依赖继承\design\Enum
组件。
从v2.5.8
版本起支持。
枚举类的创建,必须继承\design\Enum
基类,官方建议统一存放在(但不强制)/box/enum/
目录下。
下面,用一个名为
<?php
namespace box\enum;
// 必须继承枚举基类
use \design\Enum;
class ShopEnum extends Enum {
/*
* 错误异常
*/
const ERROR = 500;
/**
* 正常请求
*/
const SUCCESS = 200;
}
开发者可以使用 ShopEnum::get(ShopEnum::ERROR)
来获取注解中对应的错误Tips信息。
get()
方法成功返回结果集,失败返回false
,支持以下参数传递:
string|int $code
array $param
以上面的ShopEnum
枚举类为例:
<?php
// 返回ERROR常量对应的注解内容
ShopEnum::get(ShopEnum::ERROR);
结果集:
错误异常
// 使用返回值组装支持
ShopEnum::get(ShopEnum::ERROR, [
'data' => [
'user_id' => 1
]
]);
结果集:
array(3) {
["code"]=>
int(500)
["msg"]=>
string(12) "错误异常"
["data"]=>
array(1) {
["user_id"]=>
int(1)
}
}
注意:使用组装支持的情况下,code
和msg
字段名称是框架固定的,如果您需要完全自定义返回值结构,可以单纯使用get
返回后自行组装。