Download the PHP package roaresearch/yii2-rmdb without Composer
On this page you can find all versions of the php package roaresearch/yii2-rmdb. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download roaresearch/yii2-rmdb
More information about roaresearch/yii2-rmdb
Files in roaresearch/yii2-rmdb
Package yii2-rmdb
Short Description Yii 2 Library to create RMDB models and migrations
License BSD-3-Clause
Informations about the package yii2-rmdb
Yii2 RMDB Classes
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
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.
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.
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.
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
.
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.
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.
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.
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()
.
Testing Environment
This library use Composer Utils to quickly deploy the needed database and testing Environment.
This will ask db credentials, validate them and create the needed database and structure.