Skip to content

Latest commit

 

History

History
163 lines (142 loc) · 3.59 KB

privilege.md

File metadata and controls

163 lines (142 loc) · 3.59 KB

Privilege

Privilege only wrapper of yii2-admin, for detail informations You should read https://github.com/mdmsoft/yii2-admin

Configuration

In app config @app\config\main.php

return [
  'modules' => [
    ...
    'heart' => [
      'class' => 'hscstudio\heart\Module',
	  'features'=>[
			...
			'privilege'=>[
				'allowActions' => [
					'debug/*',
					'site/*',
					'gii/*',
					'user/*',
					'privilege/*', // add or remove allowed actions to this list
				],
				'authManager' => [
				  'class' => 'yii\rbac\DbManager', // or use 'yii\rbac\PhpManager'
				]
			],
			...
	  ]
    ]
    ...
  ],
  ...
];

Assigment

Assigment menu used for grant or revoke role to/from user.

Role

Role menu used for manage role. You can create, delete or update role from this menu. Adding and remove child of role can be doing there.

Permision

Route

Route is list of avaliable route of your application. It is automatic read application structure. Click button '>>' to save it and button '<<' to delete.

Rule

see Rules.

You can then access Auth manager through the following URL:

http://localhost/path/to/index.php?r=privilege

See Yii RBAC for more detail.

Using Menu

Menu manager used for build hierarchical menu. This is automatically look of user role and permision then return menus that he has access.

use hscstudio\heart\modules\admin\components\MenuHelper;
use hscstudio\heart\widgets\Nav;

echo Nav::widget([
    'items' => MenuHelper::getAssignedMenu(Yii::$app->user->id)
]);

Return of hscstudio\heart\modules\admin\components\MenuHelper::getAssignedMenu() has default format like:

[
    [
        'label' => $menu['name'], 
        'url' => [$menu['route']],
        'items' => [
			[
				'label' => $menu['name'], 
				'url' => [$menu['route']]
            ],
            ....
        ]
    ],
    [
        'label' => $menu['name'], 
        'url' => [$menu['route']],
        'items' => [
			[
				'label' => $menu['name'], 
				'url' => [$menu['route']]
            ]
        ]
    ],
    ....
]

where $menu variable corresponden with a record of table menu. You can customize return format of hscstudio\heart\modules\admin\components\MenuHelper::getAssignedMenu() by provide a callback to this methode. The callback must have format function($menu){}. E.g:

$callback = function($menu){
    $data = eval($menu['data']);
    return [
        'label' => $menu['name'], 
        'url' => [$menu['route']],
        'options' => $data,
        'items' => $menu['children']
        ]
    ]
}

$items = MenuHelper::getAssignedMenu(Yii::$app->user->id, null, $callback);

Default result is get from cache. If you want to force regenerate, provide boolean true as forth parameter.

Second parameter of hscstudio\heart\modules\admin\components\MenuHelper::getAssignedMenu() used to get menu on it's own hierarchy. E.g. Your menu structure:

  • Side Menu
    • Menu 1
      • Menu 1.1
      • Menu 1.2
      • Menu 1.3
    • Menu 2
      • Menu 2.1
      • Menu 2.2
      • Menu 2.3
  • Top Menu
    • Top Menu 1
      • Top Menu 1.1
      • Top Menu 1.2
      • Top Menu 1.3
    • Top Menu 2
    • Top Menu 3
    • Top Menu 4

You can get 'Side Menu' chldren by calling

$items = MenuHelper::getAssignedMenu(Yii::$app->user->id, $sideMenuId);

It will result in

  • Menu 1
    • Menu 1.1
    • Menu 1.2
    • Menu 1.3
  • Menu 2
    • Menu 2.1
    • Menu 2.2
    • Menu 2.3