Implemented enum

src/generators/model/Generator.php

@@ -12,6 +12,7 @@
 use yii\base\NotSupportedException;
 use yii\db\ActiveQuery;
 use yii\db\ActiveRecord;
+use yii\db\ColumnSchema;
 use yii\db\Connection;
 use yii\db\Exception;
 use yii\db\Schema;
@@ -245,6 +246,7 @@ public function generate()
                 'rules' => $this->generateRules($tableSchema),
                 'relations' => $tableRelations,
                 'relationsClassHints' => $this->generateRelationsClassHints($tableRelations, $this->generateQuery),
+                'enum' => $this->getEnum($tableSchema->columns),
             ];
             $files[] = new CodeFile(
                 Yii::getAlias('@' . str_replace('\\', '/', $this->ns)) . '/' . $modelClassName . '.php',
@@ -429,6 +431,17 @@ public function generateRules($table)
             $rules[] = "[['" . implode("', '", $columns) . "'], 'string', 'max' => $length]";
         }
 
+        foreach ($this->getEnum($table->columns) as $field_name => $field_details) {
+            $fieldEnumValues = [];
+            foreach ($field_details['values'] as $field_enum_values) {
+                $fieldEnumValues[] = 'self::'.$field_enum_values['const_name'];
+            }
+            $rules['enum-' . $field_name] = "['".$field_name."', 'in', 'range' => [\n                    ".implode(
+                    ",\n                    ",
+                    $fieldEnumValues
+                ).",\n                ]\n            ]";
+        }
+
         $db = $this->getDbConnection();
 
         // Unique indexes rules
@@ -1094,4 +1107,60 @@ protected function isColumnAutoIncremental($table, $columns)
 
         return false;
     }
+
+    /**
+     * prepare ENUM field values.
+     *
+     * @param ColumnSchema[] $columns
+     *
+     * @return array
+     */
+    public function getEnum($columns)
+    {
+        $enum = [];
+        foreach ($columns as $column) {
+            if (!$this->isEnum($column)) {
+                continue;
+            }
+
+            $column_camel_name = str_replace(' ', '', ucwords(implode(' ', explode('_', $column->name))));
+            $enum[$column->name]['func_opts_name'] = 'opts'.$column_camel_name;
+            $enum[$column->name]['func_get_label_name'] = 'get'.$column_camel_name.'ValueLabel';
+            $enum[$column->name]['isFunctionPrefix'] = 'is'.$column_camel_name;
+            $enum[$column->name]['displayFunctionPrefix'] = 'display'.$column_camel_name;
+            $enum[$column->name]['columnName'] = $column->name;
+            $enum[$column->name]['values'] = [];
+
+            foreach ($column->enumValues as $value) {
+                $value = trim($value, "()'");
+
+                $const_name = strtoupper($column->name.'_'.$value);
+                $const_name = preg_replace('/\s+/', '_', $const_name);
+                $const_name = str_replace(['-', '_', ' '], '_', $const_name);
+                $const_name = preg_replace('/[^A-Z0-9_]/', '', $const_name);
+
+                $label = Inflector::camel2words($value);
+
+                $enum[$column->name]['values'][] = [
+                    'value' => $value,
+                    'const_name' => $const_name,
+                    'label' => $label,
+                    'isFunctionSuffix' => str_replace(' ', '', ucwords(implode(' ', explode('_', $value))))
+                ];
+            }
+        }
+
+        return $enum;
+    }
+
+    /**
+     * validate is ENUM column.
+     *
+     * @param  ColumnSchema $column Column instance
+     * @return bool
+     */
+    protected function isEnum($column)
+    {
+        return  !empty($column->enumValues) || stripos($column->dbType, 'ENUM') === 0;
+    }
 }

src/generators/model/default/model.php

@@ -13,6 +13,7 @@
 /* @var $labels string[] list of attribute labels (name => label) */
 /* @var $rules string[] list of validation rules */
 /* @var $relations array list of relations (name => relation declaration) */
+/* @var array $enum list of ENUM fields */
 
 echo "<?php\n";
 ?>
@@ -36,6 +37,22 @@
  */
 class <?= $className ?> extends <?= '\\' . ltrim($generator->baseClass, '\\') . "\n" ?>
 {
+
+<?php
+if(!empty($enum)){
+    ?>
+    /**
+    * ENUM field values
+    */
+<?php
+    foreach($enum as $column_name => $column_data){
+        foreach ($column_data['values'] as $enum_value){
+            echo '    const ' . $enum_value['const_name'] . ' = \'' . $enum_value['value'] . '\';' . PHP_EOL;
+        }
+    }
+}
+?>
+
     /**
      * {@inheritdoc}
      */
@@ -99,4 +116,59 @@ public static function find()
         return new <?= $queryClassFullName ?>(get_called_class());
     }
 <?php endif; ?>
+
+<?php if ($enum): ?>
+<?php
+foreach($enum as $column_name => $column_data){
+    ?>
+
+    /**
+    * column <?php echo $column_name?> ENUM value labels
+    * @return array
+    */
+    public static function <?php echo $column_data['func_opts_name']?>()
+    {
+        return [
+<?php
+    foreach($column_data['values'] as $k => $value){
+        if ($generator->enableI18N) {
+            echo '            '.'self::' . $value['const_name'] . ' => Yii::t(\'' . $generator->messageCategory . '\', \'' . $value['value'] . "'),\n";
+        } else {
+            echo '            '.'self::' . $value['const_name'] . ' => \'' . $value['value'] . "',\n";
+        }
+    }
+    ?>
+        ];
+    }
+<?php
+}
+
+
+    foreach($enum as $column_name => $column_data){
+?>
+
+    /**
+    * @return string
+    */
+    public function <?=$column_data['displayFunctionPrefix']?>()
+    {
+        return self::<?=$column_data['func_opts_name']?>()[$this-><?=$column_name?>];
+    }
+<?php
+        foreach ($column_data['values'] as $enum_value){
+?>
+
+    /**
+    * @return bool
+    */
+    public function <?=$column_data['isFunctionPrefix'].$enum_value['isFunctionSuffix']?>()
+    {
+        return $this-><?=$column_name?> === self::<?=$enum_value['const_name']?>;
+    }
+<?php
+        }
+    }
+endif;
+?>
+
 }

tests/generators/ModelGeneratorTest.php

@@ -1,6 +1,8 @@
 <?php
 namespace yiiunit\gii\generators;
 
+use yii\db\mysql\ColumnSchema;
+use yii\db\TableSchema;
 use yii\gii\generators\model\Generator as ModelGenerator;
 use yiiunit\gii\GiiTestCase;
 
@@ -413,4 +415,114 @@ public function testGenerateProperties($tableName, $columns)
         }
 
     }
+
+    public function testEnum()
+    {
+        $generator = new ModelGenerator();
+        $generator->template = 'default';
+        $generator->tableName = 'category_photo';
+
+
+        $tableSchema = $this->createEnumTableSchema();
+        $params = [
+            'tableName' => $tableSchema->name,
+            'className' => 'TestEnumModel',
+            'queryClassName' => false,
+            'tableSchema' => $tableSchema,
+            'properties' => [],
+            'labels' => $generator->generateLabels($tableSchema),
+            'rules' => $generator->generateRules($tableSchema),
+            'relations' => [],
+            'relationsClassHints' => [],
+            'enum' => $generator->getEnum($tableSchema->columns),
+        ];
+        $codeFile = $generator->render('model.php', $params);
+
+        /**
+         * Fix class code for eval - remove ?php, namespace and use Yii
+         */
+        $classCode = str_replace('<?php','',$codeFile);
+        $classCode = str_replace('namespace app\models;','',$classCode);
+        $classCode = str_replace('use Yii;','',$classCode);
+
+        /**
+         * add method getTableSchema for seting test schema
+         */
+        $classCode = substr($classCode, 0, strrpos($classCode, "\n"));
+        $classCode = substr($classCode, 0, strrpos($classCode, "\n"));
+        $classCode .= '
+    public static $testTableSchema;
+    public static function getTableSchema(){
+        return self::$testTableSchema;
+    }
+}
+        ';
+        if(!class_exists('TestEnumModel')) {
+            //echo $classCode;
+            eval($classCode);
+        }
+
+        $testEnumModel = new \TestEnumModel();
+        $testEnumModel::$testTableSchema = $this->createEnumTableSchema();
+
+        /** test assigning and method is... */
+        $testEnumModel->type = \TestEnumModel::TYPE_CLIENT;
+        $this->assertTrue($testEnumModel->isTypeClient());
+        $this->assertFalse($testEnumModel->isTypeConsignees());
+
+        $testEnumModel->type = \TestEnumModel::TYPE_CONSIGNEES;
+        $this->assertFalse($testEnumModel->isTypeClient());
+        $this->assertTrue($testEnumModel->isTypeConsignees());
+        $this->assertEquals(\TestEnumModel::TYPE_CONSIGNEES,$testEnumModel->displayType());
+
+        /** test validate */
+        $this->assertTrue($testEnumModel->validate());
+        $testEnumModel->type = '11111';
+        $this->assertFalse($testEnumModel->validate());
+
+
+    }
+
+    public function createEnumTableSchema()
+    {
+        $schema = new TableSchema();
+        $schema->name = 'company_type';
+        $schema->fullName = 'company_type';
+        $schema->primaryKey = ['id'];
+        $schema->columns = [
+            'id' => new ColumnSchema([
+                'name' => 'id',
+                'allowNull' => false,
+                'type' => 'smallint',
+                'phpType' => 'integer',
+                'dbType' => 'smallint(5) unsigned',
+                'size' => 5,
+                'precision' => 5,
+                'isPrimaryKey' => true,
+                'autoIncrement' => true,
+                'unsigned' => true,
+                'comment' => ''
+            ]),
+            'type' => new ColumnSchema([
+                'name' => 'type',
+                'allowNull' => true,
+                'type' => 'string',
+                'phpType' => 'string',
+                'dbType' => 'enum(\'Client\',\'Consignees\',\'Car cleaner\')',
+                'enumValues' => [
+                    0 => 'Client',
+                    1 => 'Consignees',
+                    2 => 'Car cleaner',
+                ],
+                'size' => null,
+                'precision' => null,
+                'isPrimaryKey' => false,
+                'autoIncrement' => false,
+                'unsigned' => false,
+                'comment' => ''
+            ]),
+        ];
+
+        return $schema;
+    }
 }