the-real-start / enums
简单的用于处理枚举的PHP工具
v1.0.3
2016-08-23 21:34 UTC
This package is not auto-updated.
Last update: 2024-09-25 00:15:50 UTC
README
用于处理不可扩展目录的基本类。元素列表通过常量定义
使用方法
要开始使用不可扩展目录的功能,只需创建一个新的类,从其基类继承。
class OrderStatus extends Enum { const NEW = 'new'; const FAILED = 'failed'; const CANCELED = 'canceled'; }
现在,为了获取特定订单的状态名称,您可以使用
echo '<p>Статус заказа: '.OrderStatus::getUiLabel($model->status).'</p>';
或者例如,为了获取所有可能的状态列表
$statuses = OrderStatus::getUiEnums();
所有可用方法列表可以在Enum.php文件中查看
安装
要通过composer安装包,需要在您的composer.json
中指定额外源(因为该包不在公开访问中),并指定该包。
...
"require": {
...
"the-real-start/enums": "*"
}
...
或者,在命令行中执行以下命令
composer require the-real-start/enums
安装后,所有扩展类都可通过namespace TRS\Enum
访问。
文档
代码已被良好文档化,并允许生成可读的phpdoc
。
简要说明如何生成文档。
生成phpdoc
用于生成代码文档的命令
phpdoc run -d ./ -t doc/ -i vendor/