Entrust 拡張パッケージを使用して Laravel 5 で RBAC 権限管理を実装する (2): 使用法

前のチュートリアルでは、Entrust のインストールと構成方法について説明しました。この記事では、その使用方法について詳しく説明します。

1. ロール/権限を作成して割り当てます

最初にロールと権限を作成します:

$owner = new Role();$owner->name = 'owner';$owner->display_name = 'Project Owner';$owner->description = 'User is the owner of a given project';$owner->save();$admin = new Role();$admin->name = 'admin';$admin->display_name = 'User Administrator';$admin->description = 'User is allowed to manage and edit other users';$admin->save();

次に、作成した 2 つのロールをユーザーに割り当てます:

$user = User::where('username', '=', 'michele')->first();//调用hasRole提供的attachRole方法$user->attachRole($admin); // 参数可以是Role对象，数组或id// 或者也可以使用Eloquent原生的方法$user->roles()->attach($admin->id); //只需传递id即可

次に、これらのロールに対応する権限を追加する必要もあります:

$createPost = new Permission();$createPost->name = 'create-post';$createPost->display_name = 'Create Posts';$createPost->description = 'create new blog posts';$createPost->save();$editUser = new Permission();$editUser->name = 'edit-user';$editUser->display_name = 'Edit Users';$editUser->description = 'edit existing users';$editUser->save();$admin->attachPermission($createPost);//等价于 $admin->perms()->sync(array($createPost->id));$owner->attachPermissions(array($createPost, $editUser));//等价于 $owner->perms()->sync(array($createPost->id, $editUser->id));

2. ロールと権限を確認します

上記の操作を完了した後、以下の対応するロールと権限を確認できます:

$user->hasRole('owner'); // false$user->hasRole('admin'); // true$user->can('edit-user'); // false$user->can('create-post'); // true

hasRole() と can の両方で、チェックのために配列の形式でロールと権限を受け取ることができます:

$user->hasRole(['owner', 'admin']); // true$user->can(['edit-user', 'create-post']); // true

デフォルトでは、ユーザーが上記のロールまたは権限のいずれかを持っている場合、true が返されます。ユーザーがすべてのロールと権限を持っているかどうかを確認したい場合は、対応するメソッドの 2 番目のパラメーターとして true を渡すことができます。

ユーザーは複数の役割を持つことができます。

さらに、Entrust ファサードを使用して、現在ログインしているユーザーが指定されたロールと権限を持っているかどうかを確認することもできます:

$user->hasRole(['owner', 'admin']); // true$user->hasRole(['owner', 'admin'], true); // false$user->can(['edit-user', 'create-post']); // true$user->can(['edit-user', 'create-post'], true); // false

ワイルドカードを使用してユーザー権限を確認することもできます:

Entrust::hasRole('role-name');Entrust::can('permission-name');

能力メソッド

3.チェックスルー より高度なチェックを実装するには、能力メソッドを使用します。これには 3 つのパラメータ (ロール、権限、オプション) が必要です。同様に、ロールと権限には文字列または配列を指定できます。

// match any admin permission$user->can("admin.*"); // true// match any permission about users$user->can("*_users"); // true

これにより、ユーザーが提供されたいずれかを持っているかどうかがチェックされます。ロールと権限。この場合、ユーザーのロールは管理者であり、作成/投稿権限があるため、true が返されます。

3 番目のパラメータはオプションの配列です:

$user->ability(array('admin', 'owner'), array('create-post', 'edit-user'));// 或者$user->ability('admin,owner', 'create-post,edit-user');

ここで、 validate_all は、すべての値をチェックするかどうかを設定するために使用されるブール値であり、 return_type は、ブール値を返すか、値の配列をチェックするか、またはその両方を指定するために使用されます。

以下は出力例です:

$options = array(    'validate_all' => true | false (Default: false),    'return_type' => boolean | array | both (Default: boolean));

同様に、Entrust ファサードは、現在ログインしているユーザーのアビリティ メソッドも提供します:

$options = array(    'validate_all' => true,    'return_type' => 'both');list($validate, $allValidations) = $user->ability(    array('admin', 'owner'),    array('create-post', 'edit-user'),    $options);var_dump($validate);// bool(false)var_dump($allValidations);// array(4) {//     ['role'] => bool(true)//     ['role_2'] => bool(false)//     ['create-post'] => bool(true)//     ['edit-user'] => bool(false)// }

4. ブレード テンプレート

上記 3 つのメソッドに対応する命令も、ブレード テンプレート:

Entrust::ability('admin,owner', 'create-post,edit-user');// 等价于Auth::user()->ability('admin,owner', 'create-post,edit-user');

ミドルウェア

ミドルウェアの役割または権限によってルートとルーティング グループをフィルターできます:

@role('admin')    <p>This is visible to users with the admin role. Gets translated to    \Entrust::role('admin')</p>@endrole@permission('manage-admins')    <p>This is visible to users with the given permissions. Gets translated to    \Entrust::can('manage-admins'). The @can directive is already taken by core    laravel authorization package, hence the @permission directive instead.</p>@endpermission@ability('admin,owner', 'create-post,edit-user')    <p>This is visible to users with the given abilities. Gets translated to    \Entrust::ability('admin,owner', 'create-post,edit-user')</p>@endability

OR/AND ロジックをサポートします:

Route::group(['prefix' => 'admin', 'middleware' => ['role:admin']], function() {    Route::get('/', 'AdminController@welcome');    Route::get('/manage', [        'middleware' => ['permission:manage-admins'],         'uses' => 'AdminController@manageAdmins'    ]);});

機能ミドルウェアを使用することもできます:

'middleware' => ['role:admin|root']'middleware' => ['permission:owner', 'permission:writer']

5.フィルタリング ルーターの簡単な実装

権限とロールを通じてルートをフィルタリングする app/Http/routes.php で次のコードを呼び出すこともできます:

'middleware' => ['ability:admin|owner,create-post|edit-user,true']

3 番目のパラメータが空の場合、上記のメソッドは 3 番目のパラメータを受け入れることができます。アクセスは禁止されています。デフォルトで App::abort(403) が呼び出されます。それ以外の場合は 3 番目のパラメータが返されるので、次のようにすることができます。

// 只有拥有'create-post'权限对应角色的用户才能访问admin/post*Entrust::routeNeedsPermission('admin/post*', 'create-post');// 只有所有者才能访问admin/advanced*Entrust::routeNeedsRole('admin/advanced*', 'owner');// 第二个参数可以是数组，这样用户必须满足所有条件才能访问对应路由Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment'));Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'));

デフォルトで true になる 4 番目のパラメータを受け入れることもできます。提供されたロールとパーミッションを false に設定すると、このメソッドはすべてのロール/パーミッションが満たされていない場合にのみ失敗を返します:

Entrust::routeNeedsRole('admin/advanced*', 'owner', Redirect::to('/home'));

6. ルーティング フィルター

Entrust ファサードを呼び出すことで Entrust ロール/パーミッションにアクセスできます。 hasRole メソッドはフィルターに適用されます:

// 如果用户拥有'create-post'、'edit-comment'其中之一或者两个权限都具备则可以访问Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment'), null, false);// 如果用户是所有者、作者或者都具备则可以访问Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'), null, false);Entrust::routeNeedsRoleOrPermission(    'admin/advanced*',    array('owner', 'writer'),    array('create-post', 'edit-comment'),    null,    false);

フィルターを使用してロールを確認します:

Route::filter('manage_posts', function(){    // check the current user    if (!Entrust::can('create-post')) {        return Redirect::to('admin');    }});// 只有用户对应角色拥有 'manage_posts' 权限才能访问任意 admin/post 路由Route::when('admin/post*', 'manage_posts');

ご覧のとおり、Entrust::hasRole メソッドと Entrust::can メソッドは、判断する前にユーザーがログインしているかどうかを確認します。ユーザーがログインしていない場合は、直接 false が返されます。

Laravel 5.2 で Entrust に基づいたバックグラウンド権限管理の実装例を見たい場合は、Ryan の Github プロジェクトを参照してください: https://github.com/yuansir/laravel5-rbac-example