rocksheep/enum-helpers

PHP 枚举辅助函数集合

维护者

详细信息

github.com/Rocksheep/enum-helpers

源代码

问题

安装: 455

依赖: 0

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

v1.0.1 2024-07-05 16:38 UTC

Requires

  • php: ^8.1

Requires (Dev)

MIT 43e2eeb5810a60e05afe7ee195fdd3db0529e619

  • Marinus van Velzen <rienvanvelzen.woop@gmail.com>

phphelpersenum

This package is auto-updated.

Last update: 2024-09-05 18:08:03 UTC

README

PHP from Packagist Latest Version on Packagist Software License Build Status

此包提供了一组用于处理 PHP 枚举的实用工具，使枚举到数组的转换和隐藏枚举情况的处理更加容易。它利用了 PHP 8.1 的枚举功能，增加了增强其项目内可用性的功能。

安装

您可以通过 composer 安装此包

composer require rocksheep/enum-helpers

使用方法

基本用法

要在您的枚举中使用 EnumToArray 特性，只需在枚举定义中引用它即可

use Rocksheep\EnumHelpers\EnumToArray;

enum YourEnum: string
{
    use EnumToArray;

    case Example = 'example';
}

这将允许您轻松地将枚举情况转换为数组。

隐藏枚举情况

要隐藏特定枚举情况不被列出，请使用 Hidden 属性

use Rocksheep\EnumHelpers\Attributes\Hidden;
use Rocksheep\EnumHelpers\EnumToArray;

enum YourEnum: string
{
    use EnumToArray;

    case Visible = 'visible';

    #[Hidden]
    case Hidden = 'hidden';
}

枚举到数组的转换

要将枚举转换为数组，只需调用 toArray 方法

$array = YourEnum::toArray(); // ['visible' => 'Visible']

测试

要运行测试，请执行

./vendor/bin/pest

或者您可以使用

composer test

贡献

欢迎贡献！请随时提交拉取请求。

许可证

此包是开源软件，许可协议为 MIT 许可证。