kartavik/yii2-enum Yii2 enum mapping behavior / validator / database column type

993323

Enum integration for Yii Framework 2.0

  1. Databases support
  2. Installation
  3. Usage
  4. Suggest
  5. Author
  6. License

Latest Stable Version Total Downloads Build Status codecov Scrutinizer Code Quality Phpstan level

Based on myclabs\php-enum package;

Databases support

  • PostgreSQL
  • MySQL
  • MariaDB

Installation

composer require kartavik/yii2-enum

Usage

Example enum:

<?php

use MyCLabs\Enum\Enum;

class YourEnum extends Enum
{
    public const FIRST_VALUE = 'first';
    public const SECOND_VALUE = 'second';
}
Validator

This validator used MyCLabs\Enum\Enum::isValid($value) method and also checked value on instance of your enum;

ActiveRecord configuration
<?php

use YourEnum;
use Kartavik\Yii2;
use yii\db;

/**
 * @property YourEnum $attribute1
 * @property YourEnum $attribute2
 */
class Record extends db\ActiveRecord
{
    public function rules(): array
    {
        return [
            [
                ['attribute1', 'attribute2'],
                Yii2\Validators\EnumValidator::class,
                'targetEnum' => YourEnum::class,
            ],
            // Another variant, if you want use classic range validation
            [
                ['attribute1', 'attribute2'],
                'in',
                'range' => YourEnum::toArray(),
            ]
        ];
    }
}

Usage example
use Kartavik\Yii2;

$record = new Record([
    'attribute1' => YourEnum::FIRST_VALUE, // use constant
    'attribute2' => YourEnum::SECOND_VALUE(), // use method
]);

$record->trigger(Yii2\Behaviors\EnumMappingBehavior::EVENT_TO_ENUMS); // trigger if you put values not instance of Enum

$record->validate(); // true
Behavior

It can be used for classes that extends ActiveRecord

ActiveRecord configuration
<?php

use YourEnum;
use Kartavik\Yii2;
use yii\db;

/**
 * @property YourEnum $attribute1
 * @property YourEnum $attribute2
 */
class Record extends db\ActiveRecord
{
    public function behaviors(): array
    {
        return [
            'enum' => [
                'class' => Yii2\Behaviors\EnumMappingBehavior::class,
                'map' => [
                    'attribute1' => YourEnum::class,
                    'attribute2' => YourEnum::class,
                ],
                // Set attribute type if need explicitly specify it
                'attributesType' => [
                    'attribute1' => 'integer',
                    'attribute2' => 'float'
                ],
            ]
        ];
    }
}

Usage example
use Kartavik\Yii2;

$record = new Record([
    'attribute1' => YourEnum::FIRST_VALUE, // use const
    'attribute2' => YourEnum::SECOND_VALUE() // use method
]);

$this->trigger(Yii2\Behaviors\EnumMappingBehavior::EVENT_TO_ENUMS);
$record->save(); // will return true

$value = Record::find()
    ->where(['id' => $record->id])
    ->all()[0]
    ->attribute1; // Will contain YourEnum object with value `first`

Record::updateAll([
    'attribute1' => YourEnum::SECOND_VALUE()
]); // Updating records with new enum

$value = Record::find()
    ->where(['id' => $record->id])
    ->all()[0]
    ->attribute1; // Will containt YourEnum object with value `second`
Migration
PgSql
<?php

use Kartavik\Yii2\Database\Pgsql;

class CreateRecordTable extends Pgsql\Migration
{
    // You can use trait do receive all methods for enum
    use Pgsql\MigrationTrait;
    
    public function safeUp()
    {
         // simple usage
        $this->addEnum('test_enum_from_array', [/** your values */]);
         // use your enum that extends MyCLabs\Enum\Enum
         // use it for package, for big project this usage is not good practice
        $this->addEnum('test_enum_from_enum', YourEnum::class);
        
         // if enum already exists
        $column = $this->enum('test_enum_from_array');
         // you can do not to use addEnum to create it
        $column = $this->enum('test_enum_dynamic_from_array', [/** your values */]);
         // use your enum that extends MyCLabs\Enum\Enum
         // use it for package, for big project this usage is not good practice
        $column = $this->enum('test_enum_dynamic_from_enum', YourEnum::class);
        
        $this->createTable('record', [
            'enum' => $column->null()->default('default')
        ]);
    }
}
MySql
<?php

use Kartavik\Yii2\Database\Mysql;

class CreateRecordTable extends Mysql\Migration
{
    // You can use trait do receive all methods for enum
    use Mysql\MigrationTrait;
    
    public function safeUp()
    {
        $this->createTable('record', [
            'enum_column_from_array' => $this->enum(['1', '2', '3', '4']),
            // use your enum that extends MyCLabs\Enum\Enum
            // use it for package, for big project this usage is not good practice
            'enum_column_from_enum' => $this->enum(YourEnum::class),
        ]);
    }
}
MariaDB
<?php

use Kartavik\Yii2\Database\Mariadb;

class CreateRecordTable extends Mariadb\Migration
{
    // You can use trait do receive all methods for enum
    use Mariadb\MigrationTrait;
    
    public function safeUp()
    {
        $this->createTable('record', [
            'enum_column_from_array' => $this->enum(['1', '2', '3', '4']),
            // use your enum that extends MyCLabs\Enum\Enum
            // use it for package, for big project this usage is not good practice
            'enum_column_from_enum' => $this->enum(YourEnum::class),
        ]);
    }
}

Suggest

Author

License

MIT

1 0
1 follower
181 downloads
Yii Version: 2.0
License: MIT
Category: Database
Developed by: Roman Varkuta
Created on: May 15, 2019
Last updated: a month ago
Packagist Profile
Github Repository

Related Extensions