https://github.com/itstructure/yii2-rbac-module
Module to manage roles and permissions for the Yii2 Framework
https://github.com/itstructure/yii2-rbac-module
module rbac yii2 yii2-framework yii2-rbac
Last synced: about 2 months ago
JSON representation
Module to manage roles and permissions for the Yii2 Framework
- Host: GitHub
- URL: https://github.com/itstructure/yii2-rbac-module
- Owner: itstructure
- License: mit
- Created: 2018-05-12T16:30:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T13:42:11.000Z (over 2 years ago)
- Last Synced: 2025-03-10T13:40:21.063Z (2 months ago)
- Topics: module, rbac, yii2, yii2-framework, yii2-rbac
- Language: PHP
- Homepage: https://pack-develop.info/en/product/rbac-yii2-module
- Size: 95.7 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Yii2 RBAC module
## Introduction
[](https://packagist.org/packages/itstructure/yii2-rbac-module)
[](https://packagist.org/packages/itstructure/yii2-rbac-module)
[](https://packagist.org/packages/itstructure/yii2-rbac-module)
[](https://packagist.org/packages/itstructure/yii2-rbac-module)
[](https://scrutinizer-ci.com/g/itstructure/yii2-rbac-module/build-status/master)
[](https://scrutinizer-ci.com/g/itstructure/yii2-rbac-module/?branch=master)
**RBAC module** - Module for the Yii2 framework, which provides management with the next data:
- Roles
- Permissions
- Assign roles for users(profiles)
## Dependencies
- php >= 7.1
- composer
- MySql >= 5.5
## Installation
### General from remote repository
Via composer:
`composer require itstructure/yii2-rbac-module "~3.0.5"`
### If you are testing this package from local server directory
In application `composer.json` file set the repository, like in example:
```json
"repositories": [
{
"type": "path",
"url": "../yii2-rbac-module",
"options": {
"symlink": true
}
}
],
```
Here,
**yii2-rbac-module** - directory name, which has the same directory level like application and contains yii2 rbac module.
Then run command:
`composer require itstructure/yii2-rbac-module:dev-master --prefer-source`
### Addition components
In accordance with the [documentation for Yii2](http://www.yiiframework.com/doc-2.0/guide-security-authorization.html), set **authManager** for application:
```php
'components' => [
'authManager' => [
'class' => 'yii\rbac\DbManager',
],
// ...
],
```
In accordance with the [documentation for Yii2](http://www.yiiframework.com/doc-2.0/guide-security-authorization.html), run command:
```php
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`.
- **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.
- **View** component is taken by default from the framework like **yii\web\View**. You cat set **view** component in module by custom.
### Application config
Base application config must be like in example below:
```php
use Itstructure\RbacModule\Module;
use Itstructure\RbacModule\controllers\{RoleController, PermissionController, ProfileController};
```
```php
'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:
- `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 [email protected].
Licensed under the [MIT license](http://opensource.org/licenses/MIT). See LICENSE.txt for details.