Yii2 RBAC Migration
![Software License][ico-license]
, (*1)
Simple and useful extension for migrations in Yii2. It allows you to perform operations on the Roles and Permission
directly within the database migrations. This can be useful if you assign the Roles and Permissions for users in the
application and not during the generation of RBAC., (*2)
Extension allows you to create, update and remove Roles, Permissions and Rules, and also contains useful builder to
easy roles creation., (*3)
A warning: if you using constants for Roles, Permissions or Rules names, you should not to use it inside migration classes!
Use simple strings with it names. Constants values during application development can change, but you old migrations
should stay persistent., (*4)
Install
Via Composer, (*5)
``` bash
$ composer require erickskrauch/yii2-rbac-migration, (*6)
## Usage
First of all we must *use trait*. You can do it within the migration file:
``` php
<?php
class m160705_120827_init extends \yii\db\Migration
{
use \ErickSkrauch\Yii2\RbacMigrateTrait;
public function safeUp()
{
$this->createPermission('upload_data');
}
public function safeDown()
{
$this->removePermission('upload_data');
}
protected function getAuthManager()
{
return Yii::$app->authManager;
}
}
But it's somewhat uncomfortable due to the fact, that every time you will have to implement a getAuthManager() method., (*7)
Therefore, a more convenient way is to create your own base migration class, which already is use this trait
and implemented the required method. For Yii2 Advanced Template this
can be done by creating \console\models\Migration class with the following contents:, (*8)
<?php
namespace console\models;
use ErickSkrauch\Yii2\RbacMigrateTrait;
use yii\db\Migration as YiiMigration;
class Migration extends YiiMigration
{
use RbacMigrateTrait;
protected function getAuthManager()
{
return \Yii::$app->authManager;
}
}
...and extending the migration class from the newly created:, (*9)
``` php
<?php, (*10)
use console\models\Migration;, (*11)
class m160705_120827_init extends Migration
{
public function safeUp()
{
$this->createPermission('upload_data');
}, (*12)
public function safeDown()
{
$this->removePermission('upload_data');
}
}, (*13)
In search of the ideal, you can override in the console application configuration migration path to the you own template
file, which will be immediately with necessary base class.
In the future, you can use the methods as follows:
// Init db structure, create few permissions and one role and assing permissions to that role
public function safeUp()
{
$this->initRbacStructure();
$this->createPermission('view_invoices');
$this->createPermission('data_analysis');
$this->createPermission('upload_data');
$this->createRole('accountant')
->addPermission('view_invoices')
->addPermission('data_analysis')
->addPermission('upload_data');
}, (*14)
public function safeDown()
{
$this->removePermission('view_invoices');
$this->removePermission('data_analysis');
$this->removePermission('upload_data');
$this->removeRole('accountant');
$this->rollbackRbacStructure();
}
```, (*15)
Available methods
RbacMigrateTrait
createPermission($name, $description = null, $ruleName = null): ItemBuilder
Create new permission, add it to authManager and return ItemBuilder object., (*16)
createRole($name, $description = null): ItemBuilder
Create new role, add it to authManager and return ItemBuilder object., (*17)
addRule($className, $name): void
Add new rule to auth manager. If class no more exists by provided $className, then it will be created and added
to authManager, so you old migrations will not fail if you change or delete original rule., (*18)
updatePermission($oldName, $newName, $newDescription = false, $newRule = false): void
Method allows you to change signature of exists permission. If $newDescription passed as (bool)false, then description
will not be changed. The same behavior with $newRule., (*19)
updateRole($oldName, $newName, $newDescription = false): void
Method allows you to change signature of exists role. If $newDescription passed as (bool)false, then description
will not be changed., (*20)
removePermission($name): void
Remove permission by passed name., (*21)
removeRole($name): void
Remove role by passed name., (*22)
removeRule($name): void
Removing rule from auth manager. If class no more exists by provided $name, then it will be created and removed
from authManager, so you old migrations will not fail if you change or delete original rule, (*23)
getRole($role): ItemBuilder
Return ItemBuilder object for passed role name., (*24)
getPermission($permission): ItemBuilder
Return ItemBuilder object for passed permission name., (*25)
initRbacStructure(): void
Initialize RBAC structure. This is alternative to execute yii migrate --migrationPath=@yii/rbac/migrations/
from console, (*26)
rollbackRbacStructure(): void
Call down method of RBAC migration. This is alternative to execute
yii migrate/down --migrationPath=@yii/rbac/migrations/ from console, (*27)
ItemBuilder
addPermission($permission): ItemBuilder
Add child permission by passed permission object or it's name. $this will be returned., (*28)
addRole($role): ItemBuilder
Add child role by passed role object or it's name. $this will be returned., (*29)
removePermission($permission): ItemBuilder
Remove child permission by passed permission object or it's name. $this will be returned., (*30)
removeRole($role): ItemBuilder
Remove child role by passed role object or it's name. $this will be returned., (*31)
Change log
Until the 1.0.0 version will be released, backwards compatibility is guaranteed only in patch releases.
Minor updates may include breaking changes, so check CHANGELOG when updating the minor version., (*32)
Testing
For now I have not figured out how to test it and whether it should be tested.
If you have any ideas, contributes are welcome., (*33)
Contributing
Please see CONTRIBUTING for details., (*34)
Credits
License
The MIT License (MIT). Please see License File for more information., (*35)
Wallogit.com
ErickSkrauch