安裝
composer require fangx/php-enum
創(chuàng)建
使用 ./vendor/bin/enum
命令創(chuàng)建一個枚舉類.
./vendor/bin/enum FooEnum --enum="1=foo" --enum="b=bar" --path=Enums
該命令默認(rèn)在 當(dāng)前目錄的 Enums 目錄下創(chuàng)建一個 FooEnum.php 文件. 文件內(nèi)容如下:
<?phpnamespace Enums;use FangxEnumAbstractEnum;class FooEnum extends AbstractEnum{ const FOO = "f", __FOO = "foo"; const BAR = "b", __BAR = "bar";}
使用
枚舉類默認(rèn)繼承 FangxEnumAbstractEnum
. 可以靜態(tài)調(diào)用以下方法:
toArray(Format $format = null, Filter $filter = null)
toJson(Format $format = null, Filter $filter = null)
desc($key, $default = 'Undefined')
獲取所有的枚舉值
<?phpclass FooEnum extends FangxEnumAbstractEnum{ const FOO = 'f', __FOO = 'foo'; const BAR = 'b', __BAR = 'bar';}/** * ['f' => 'foo', 'b' => 'bar'] */FooEnum::toArray();
獲取枚舉值的描述信息
<?phpclass FooEnum extends FangxEnumAbstractEnum{ const FOO = 'f', __FOO = 'foo'; const BAR = 'b', __BAR = 'bar';}/** * "foo" */FooEnum::desc('f');/** * "bar" */FooEnum::desc(FooEnum::BAR);
使用格式來約束返回值
<?phpclass FooFormat implements FangxEnumContractsFormat{ public function parse(FangxEnumContractsDefinition $definition): array { return [['key' => $definition->getKey() , 'value' => $definition->getValue()]]; }}class FooEnum extends FangxEnumAbstractEnum{ const FOO = 'f', __FOO = 'foo'; const BAR = 'b', __BAR = 'bar';}/** * [['key' => 'f', 'value' => 'foo'], ['key' => 'b', 'value' => 'bar'],] */$format = new FooFormat();FooEnum::toArray($format);
通過規(guī)則來過來過濾枚舉值.
class FooFilter implements FangxEnumContractsFilter{ public function __invoke(FangxEnumContractsDefinition $definition) { return $definition->getKey() === 'f'; }}/** * ['f' => 'foo'] */$filter = new FooFilter();FooEnum::toArray(null, $filter);
使用自定義的集合來作為所有的枚舉類型, 其他使用方法與 FooEnum
一致.
<?phpclass BarEnum extends FangxEnumAbstractEnum{ public function all() { return [ new FangxEnumDefinition('f', 'foo'), new FangxEnumDefinition('b', 'bar'), ]; }}
推薦教程:《PHP》