opus-online/yii2-enum

There is no license information available for the latest version (v1.0) of this package.

Enumeration extension for Yii2

This package's canonical repository appears to be gone and the package has been frozen as a result.

v1.0 2014-08-12 14:12 UTC

Requires

• symfony/yaml: 2.5.*
• yiisoft/yii2: *

Unknown License

• Ivo Kund

• type
• enum
• enumeration
• yii
• classifier
• yii2

README

This component allows you to define enumeration types in a Yaml definition file and build PHP classes with class constants corresponding to these types.

Installation

Add the following to your composer.json:

{
	"require": {
		"opus-online/yii2-enum": "*"
	}
}

Attach the EnumController class to you project. You can do this either by creating a new controller that extends EnumController or you can override coreCommands in your console application and add the controller there.

'enum' => [
    'class' => EnumController::className(),
    // add the path alias of the Yaml file here
    'definitionAlias' => '@app/build/enum.yml',
],

Usage

Define your types in a Yaml file:

Gender:
  - MALE
  - FEMALE
  - OTHER
# you can also use shorter syntax
UserStatus: [ACTIVE, INACTIVE, BLOCKED]
# and you can define an explicit value for the type
TrendDirection:
  - INCREASING
      value: 1
  - DECREASING:
      value: -1
  - NOT_DETERMINED

Run the build command to generate PHP classes for the definition.

php yii enum/build my\\ns @app/src/enum

This creates the type classes under namespace my\ns (notice the double \\) and places the files into a directory that corresponds to @app/src/enum path alias.

After this you can use enumeration types like this:

echo UserStatus::INACTIVE; // INACTIVE
echo TrendDirection::DECREASING; // -1

// return all values of a type
TrendDirection::getList();

// return a human-readable label for one value (by constant name)
echo TrendDirection::getLabel('NOT_DETERMINED'); // Not determined

// returns an array where type value is the key and human readable
// label is the value. This can be useful when populating drop-downs
TrendDirection::getListLabels();