potatopowered/role-auth

The RoleAuth Component aims to make authorization in CakePHP 3.x applications as simple as can be.

RoleAuth

, _(*1)

Description

The RoleAuth Component aims to make authorization in CakePHP 3.x applications as simple as can be., _(*2)

Installation Guide

Add the component to your composer.json you can do this easily using composer itself., _(*3)

composer require potatopowered/role-auth

Add the roles table using migrate., _(*4)

bin/cake migrations status -p RoleAuth

Load the RoleAuth Component with the other components in the initialize function of your AppController to have it accessible in all controllers., _(*5)

$this->loadComponent('RoleAuth.RoleAuth');

Advanced Load

$this->loadComponent('RoleAuth.RoleAuth', [
  'roles_table' => 'roles',
  'admin_role' => 'Admin',
  'default_role' => 'User'
]);

Usage

This assumes that you have role_id setup in the user linking to this plugins roles table., _(*6)

Check if a user is an admin

To use the RoleAuth component to check if a user is an admin you can make a call as such. The following will check the logged in users role_id and verify that they are an admin or not. The result is boolean., _(*7)

$this->RoleAuth->isAdmin($this->Auth->user('role_id'));

Check if a user has a specific role

To use the RoleAuth component to check if a user is a specific role you can make a call as such. The following will check the logged in users role_id and verify that they have a role or not. The result is boolean., _(*8)

$this->RoleAuth->hasRole('YourRole', $this->Auth->user('role_id'));

Set all role variables

To use the RoleAuth component to check the users role and set all role variables in one shot you can make a call as such. The following will check the logged in users role_id and verify that they have a role or not. The result is boolean., _(*9)

$this->RoleAuth->setRoles($this->Auth->user());