Yii2 RBAC Extension

Yii2-RBAC provides a web interface for advanced access control and includes following features:

• Allows CRUD operations for roles, permissions, rules
• Allows to assign multiple roles or permissions to the user
• Allows to create console migrations
• Integrated with yii2mod/base

Support us

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

Installation

The preferred way to install this extension is through composer.

Either run

or add

to the require section of your composer.json.

Usage

Once the extension is installed, simply modify your application configuration as follows:

After you downloaded and configured Yii2-rbac, the last thing you need to do is updating your database schema by applying the migration:

You can then access Auth manager through the following URL:

or if you have enabled pretty URLs, you may use the following URL:

Applying rules:

1) For applying rules only for controller add the following code:

2) For applying rules for module add the following code:

3) Also you can apply rules via main configuration:

Internationalization

All text and messages introduced in this extension are translatable under category 'yii2mod.rbac'. You may use translations provided within this extension, using following application configuration:

Migrations

You can create the console migrations for creating/updating RBAC items.

Module setup

To be able create the migrations, you need to add the following code to your console application configuration:

Methods

1. createPermission(): creating a permission
2. updatePermission(): updating a permission
3. removePermission(): removing a permission
4. createRole(): creating a role
5. updateRole(): updating a role
6. removeRole(): removing a role
7. createRule(): creating a rule
8. updateRule(): updating a rule
9. removeRule(): removing a rule
10. addChild(): creating a child
11. removeChild(): removing a child
12. assign(): assign a role to a user

Creating Migrations

To create a new migration, run the following command:

The required name argument gives a brief description about the new migration. For example, if the migration is about creating a new role named admin, you may use the name create_role_admin and run the following command:

The above command will create a new PHP class file named m160817_085702_create_role_admin.php in the @app/rbac/migrations directory. The file contains the following code which mainly declares a migration class m160817_085702_create_role_admin with the skeleton code:

The following code shows how you may implement the migration class to create a admin role:

You can see a complex example of migration here.

Applying Migrations

To upgrade a database to its latest structure, you should apply all available new migrations using the following command:

Reverting Migrations

To revert (undo) one or multiple migrations that have been applied before, you can run the following command:

Redoing Migrations

Redoing migrations means first reverting the specified migrations and then applying again. This can be done as follows: