itstructure/yii2-rbac-module

Module to manage roles and permissions for the Yii2 Framework.

Yii2 RBAC module

Introduction

, _(*1)

RBAC module - Module for the Yii2 framework, which provides management with the next data: - Roles - Permissions - Assign roles for users(profiles), _(*2)

, _(*3)

Dependencies

• php >= 7.1
• composer
• MySql >= 5.5

Installation

General from remote repository

Via composer:, _(*4)

composer require itstructure/yii2-rbac-module "~3.0.5", _(*5)

If you are testing this package from local server directory

In application composer.json file set the repository, like in example:, _(*6)

"repositories": [
    {
        "type": "path",
        "url": "../yii2-rbac-module",
        "options": {
            "symlink": true
        }
    }
],

Here,, _(*7)

yii2-rbac-module - directory name, which has the same directory level like application and contains yii2 rbac module., _(*8)

Then run command:, _(*9)

composer require itstructure/yii2-rbac-module:dev-master --prefer-source, _(*10)

Addition components

In accordance with the documentation for Yii2, set authManager for application:, _(*11)

'components' => [
    'authManager' => [
        'class' => 'yii\rbac\DbManager',
    ],
    // ...
],

In accordance with the documentation for Yii2, run command:, _(*12)

yii migrate --migrationPath=@yii/rbac/migrations

Usage

Main properties

• The name of module: rbac
• The namespace for used classes: Itstructure\RbacModule.

• The alias to access in to module root directory: @rbac., _(*13)

• There is not a layout ! It's taken from application layout main by default or how it is configured. You cat set layout attribute in module by custom., _(*14)

• View component is taken by default from the framework like yii\web\View. You cat set view component in module by custom., _(*15)

Application config

Base application config must be like in example below:, _(*16)

use Itstructure\RbacModule\Module;
use Itstructure\RbacModule\controllers\{RoleController, PermissionController, ProfileController};

'modules' => [
    'rbac' => [
        'class' => Module::class,
        'controllerMap' => [
            'roles' => RoleController::class,
            'permissions' => PermissionController::class,
            'profiles' => ProfileController::class,
        ],
    ],
],

Useful module attributes

You can set the following attributes in a module config:, _(*17)

• loginUrl - set url to be redirected if you are not authorized.
• accessRoles - The roles of users who are allowed access to work with this package.
• urlPrefix - Url prefix for redirect and view links (Default is empty).
• urlPrefixNeighbor - Url prefix for redirect and view links of neighbor entity (Default is empty).

License

Copyright © 2018-2023 Andrey Girnik girnikandrey@gmail.com., _(*18)

Licensed under the MIT license. See LICENSE.txt for details., _(*19)