README

Library with migrations and models to easily create RMDB tables and models.

Installation

You can use composer to install the library roaresearch/yii2-rmdb by running the command;

composer require roaresearch/yii2-rmdb

or edit the composer.json file

require: {
    "roareasearch/yii2-rmdb": "*",
}

Usage

Create Migrations

There are 3 migration classes for each type of RMDB tables.

`roaresearch\yii2\rmdb\migrations\CreatePivot`

Uses the properties $createdByColumn, $createdAtColumn and methods createdByDefinition(), createdAtDefinition() to store the user and datetime a record was created.

use roaresearch\yii2\rmdb\migrations\CreatePivot;

class m170101_000001_product_sale extends CreatePivot
{
    public $createdByColumn = 'creation_user';
    public $createdAtColumn = 'creation_date';

    public function getTableName()
    {
        return 'product_sale';
    }

    public function columns()
    {
        return [
            'product_id' => ...,
            'sale_id' => ...,
        ];
    }

    public function compositePrimaryKeys()
    {
        return ['product_id', 'sale_id'];
    }
}

`roaresearch\yii2\rmdb\migrations\CreateEntity`

Extends the previous class adding the properties $updatedByColumn, $updatedAtColumn and methods updatedByDefinition(), updatedAtDefinition() to store the user and datetime a record was updated.

use roaresearch\yii2\rmdb\migrations\CreateEntity;

class m170101_000001_product extends CreateEntity
{
    public $createdByColumn = 'creation_user';
    public $createdAtColumn = 'creation_date';
    public $updatedByColumn = 'edition_user';
    public $updatedAtColumn = 'edition_date';

    public function getTableName()
    {
        return 'product';
    }

    public function columns()
    {
        return [
            'id' => $this->prymariKey()->...,
            'name' => ...,
        ];
    }
}

`roaresearch\yii2\rmdb\migrations\CreatePersistentEntity`

A persistent entity remains stored in the database after the user deletes it.

The library yii2tech/ar-softdelete provides support for this functionality.

CreateEntity extends the previous class adding the properties $deletedByColumn, $deletedAtColumn and methods deletedByDefinition(), deletedAtDefinition() to store the user and datetime a record was deleted.

use roaresearch\yii2\rmdb\migrations\CreatePersistentEntity;

class m170101_000001_sale extends CreatePersistentEntity
{
    public $createdByColumn = 'creation_user';
    public $createdAtColumn = 'creation_date';
    public $updatedByColumn = 'edition_user';
    public $updatedAtColumn = 'edition_date';
    public $deletedByColumn = 'deletion_user';
    public $deletedAtColumn = 'deletion_date';

    public function getTableName()
    {
        return 'product';
    }

    public function columns()
    {
        return [
            'id' => $this->prymariKey()->...,
            'store_id' => ...,
        ];
    }
}

RMDB Module

This library uses a custom module to help configure all the extended models in an homologued way.

configure it in your common\config\main.php in yii-app-advanced and common\config.php in yii-app-basic.

use roaresearch\yii2\rmdb\Module as RmdbModule;

return [
    // ...
    'modules' => [
        'rmdb' => [
            'class' => RmdbModule::class,
            'timestampClass' => ..., // optional
            'blameableClass' => ..., // optional
            'softDeleteClass' => ..., // optional
            'timestampValue' => time(), // optional by default uses `now()`
            'defaultUserId' => 5, // optional
        ],
    ],
];

Models

Like the migrations there are 3 classes for models.

`roaresearch\yii2\rmdb\models\Pivot`

Adds protected properties $createdByAttribute and $createdAtAttribute to configure the names of the attributes. The class will automatically load the needed behaviors and configure them to use the attributes as provided by this properties.

class ProductSale extends \roaresearch\yii2\rmdb\models\Pivot
{
    protected $createdByAttribute = 'creation_user';
    protected $createdAtAttribute = 'creation_date';

    // rest of model methods and logic
}

`roaresearch\yii2\rmdb\models\Entity`

Extends the previous class and adds protected properties $updatedByAttribute and $updatedAtAttribute to configure the names of the attributes. The class will automatically load the needed behaviors and configure them to use the attributes as provided by this properties.

class Product extends \roaresearch\yii2\rmdb\models\Entity
{
    protected $createdByAttribute = 'creation_user';
    protected $createdAtAttribute = 'creation_date';
    protected $updatedByAttribute = 'edition_user';
    protected $updatedAtAttribute = 'edition_date';

    // rest of model methods and logic
}

`roaresearch\yii2\rmdb\models\PersistentEntity`

Extends the previous class and adds protected properties $deletedByAttribute and $deletedAtAttribute to configure the names of the attributes. The class will automatically load the needed behaviors and configure them to use the attributes as provided by this properties.

class Product extends \roaresearch\yii2\rmdb\models\PersistentEntity
{
    protected $createdByAttribute = 'creation_user';
    protected $createdAtAttribute = 'creation_date';
    protected $updatedByAttribute = 'edition_user';
    protected $updatedAtAttribute = 'edition_date';
    protected $deletedAtAttribute = 'deletion_user';
    protected $deletedAtAttribute = 'deletion_date';

    // rest of model methods and logic
}

This model uses the SoftDeleteActiveQuery class which add 2 methods to filter based on the deletion status of a record.

deleted()
notDeleted()

This methods will use columns $deletedByAttribute and $deletedByAttribute to determine if a record was soft deleted or not. To prevent conflicts in joins the attributes are normalized with the query alias. For this reason the alias() method must be called before the deleleted() or notDeleted().

Product::find()
  ->alias('p')
  ->notDeleted()
  ->innerJoin('brand b')

Testing Environment

This library use Composer Utils to quickly deploy the needed database and testing Environment.

git clone https://github.com/ROAResearch/yii2-rmdb.git
cd yii2-rmdb/
composer deploy

This will ask db credentials, validate them and create the needed database and structure.

roaresearch / yii2-rmdb

Maintainers

Details