romi45/yii2-rbac-collector

Using extension you can organize your RBAC configuration in separate files in application modules.

Yii 2 RBAC configuration stored in separate modules

This extension provides layer between Yii 2 AuthManager and access configuration that can be stored in separate config classes in application modules., _(*1)

It is useful for large projects where you have truckload of access rules, roles and other stuff., _(*2)

When you organize your RBAC code in modules - you can easy manage it., _(*3)

It is only console application component - you don't have to change something in your web application - just use Yii::$app->authManager as you used it before., _(*4)

Installation

Install this extension through composer., _(*5)

Either run, _(*6)

$ composer require romi45/yii2-rbac-collector:~1.0

or add, _(*7)

"romi45/yii2-rbac-collector": "~1.0"

to the require section of your composer.json file., _(*8)

Configuring

Add rbacc module into your modules section in console application config., _(*9)

'modules' => [
    ...
    'rbacc' => [
        'class' => 'rbacc\Module',
        'collection' => [
            // Here is a list of your RBAC config classes. Example you can get in /example directory
            'app\modules\user\rbac\Config',
            'app\modules\blog\rbac\Config',
            'app\modules\hobby\rbac\YouCanNameItAsYouWant',
        ]
    ],
    ...
]

Here is an example of config class. array keys - auth item name value - auth item data, _(*10)

if value is not array - collector recognize it as Permission. if value is array - you have to specify type of Item, _(*11)

namespace rbacc\example;

use rbacc\components\ConfigBase;
use rbacc\example\rules\UpdateOwnDataRule;
use yii\rbac\Item;

/**
 * Class Config
 *
 * Example RBAC configuration class
 *
 * @package user\rbac
 */
class Config extends ConfigBase
{
    /**
     * Gets config data as array
     *
     * @return array
     */
    public function getData()
    {
        return [
            'user___user__view_profile' => 'View user profile',
            'user___user__view_own_profile' => [
                'type' => Item::TYPE_PERMISSION,
                'description' => 'View user own profile',
                'rule' => new UpdateOwnDataRule(),
                'children' => ['user___user__view_profile']
            ],
            'user' => [
                'type' => Item::TYPE_ROLE,
                'description' => 'User',
                'children' => ['user___user__view_own_profile'],
            ],
            'admin' => [
                'type' => Item::TYPE_ROLE,
                'description' => 'Admin',
                'children' => ['user___user__view_profile']
            ],
            'owner' => [
                'type' => Item::TYPE_ROLE,
                'description' => 'Application owner',
                'children' => ['admin'],
            ]
        ];
    }
}

For updating RBAC configuration after some changes jus run following command:, _(*12)

$ yii rbacc/update

Collector will read your config classes and update RBAC data using your current AuthManager - PhpManager or DbManager, _(*13)

License

The MIT License (MIT). Please see License File for more information., _(*14)