README

基础枚举 Composer 包提供了一个通用的超类，用于在 PHP 中创建具有增强功能的枚举类。枚举是表示代码中一组固定命名值的强大方式，此包简化了其实现和使用。

安装

要安装 Base Enum 包，请使用以下 Composer 命令

composer require ariantron/base-enum

使用方法

创建枚举类

要使用 Base Enum 包创建枚举类，请扩展 BaseEnum 类并在类内定义您的常量。以下是一个示例

<?php

namespace App\Enums;

use ArianTron\BaseEnum\BaseEnum;

class Numbers extends BaseEnum
{
    const ONE = 'one';
    const TWO = 'two';
    const THREE = 'three';
}

枚举类方法

`isValidName($name, $strict = false): bool`

检查给定的 $name 是否是枚举中的有效常量名称。默认情况下，检查是不区分大小写的，但您可以设置 $strict 为 true 以进行区分大小写的检查。

`getConstants(): array`

检索枚举类中定义的所有常量的数组。

`isValidValue($value, $strict = true): bool`

检查给定的 $value 是否是枚举中的有效常量值。默认情况下，检查是严格的（值和类型），但您可以设置 $strict 为 false 以进行宽松的检查。

`getName($val): int|string`

将枚举常量值转换回其对应的常量名称。

示例用法

// Check if a name is a valid constant in the Enum
$result = Numbers::isValidName('TWO'); // true

// Get all constants in the Enum
$constants = Numbers::getConstants(); // ['one','two','three']

// Check if a value is a valid constant value in the Enum
$result = Numbers::isValidValue('two'); // true

// Convert a constant value back to its name
$name_1 = Numbers::getName('two'); // 'TWO'
//or
$name_2 = Numbers::getName(Numbers::TWO); // 'TWO'

贡献

您可以在此包的GitHub 仓库上提交问题或拉取请求，以自由地为此包的开发做出贡献。

许可

此包是开源的，可在MIT 许可证下使用。您可以根据许可证条款自由使用、修改和分发它。

ariantron / base-enum

维护者

详细信息