potatopowered/role-auth

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

1.1.2 2018-07-02 23:13 UTC

Requires

• php: >=5.4.16
• cakephp/cakephp: ~3.0
• cakephp/migrations: ~1.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^3.0
• phpunit/phpunit: ^5.7|^6.0

MIT

• Blake Sutton

• authorization
• cakephp
• Potato Powered Software
• RoleAuth

README

Description

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

Installation Guide

Add the component to your composer.json you can do this easily using composer itself.

composer require potatopowered/role-auth

Add the roles table using migrate.

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.

$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.

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.

$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.

$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.

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