# yii2-enum

**Repository Path**: fakis/yii2-enum

## Basic Information

- **Project Name**: yii2-enum
- **Description**: No description available
- **Primary Language**: PHP
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-06-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Yii2 Enum
=========
通用字典解决方案

安装
---

通过 [composer](http://getcomposer.org/download/) 安装此扩展
```
php composer.phar require --prefer-dist fakis/yii2-enum "*"
```
或者在`composer.json`文件的require部分填上
```
"fakis/yii2-enum": "*"
```

使用
---
此特性适合应用在任何对象上
```php
use fakis\enum\EnumTrait;

class User
{
    use EnumTrait;
    
    const STATUS_ACTIVATED = 1;
    const STATUS_INACTIVATED = 2;
    
    const GENDER_MALE = 'male';
    const GENDER_FEMALE = 'female';
    
    public static function enums()
    {
        return [
            'status' => [
                self::STATUS_ACTIVATED => Yii::t('app', '已激活'),
                self::STATUS_INACTIVATED => Yii::t('app', '未激活'),
            ],
            'gender' => [
                self::GENDER_MALE => Yii::t('app', '男'),
                self::GENDER_FEMALE => Yii::t('app', '女'),
            ],
        ];
    }
}
```

API
---

```php
// 取得status的字典列表（标签为值）
User::getEnumsByLabel('status');
// return [1 => '已激活', 2 => '未激活'];

// 取得gender的字典列表（索引为值）
User::getEnumsByIndex('gender');
// return ['男' => 'male', '女' => 'female'];

// 取得gender的属性标签
User::getEnumLabel('gender', User::GENDER_MALE);
// return '男';

// 取得status的属性索引
User::getEnumIndex('status', '未激活');
// return 2;
```