slince / cakephp-permission
The library provides a flexible way to add role-based access control management to CakePHP 3.x
Installs: 5 979
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 2
Forks: 3
Open Issues: 1
Type:cakephp-plugin
Requires
- php: >=5.6.0
- cakephp/cakephp: ^3.4
Requires (Dev)
- phpunit/phpunit: ^5.0|^6.0
This package is auto-updated.
Last update: 2024-10-08 18:55:32 UTC
README
The library provides a flexible way to add role-based access control management to CakePHP 3.x
Inspired by Laravel Permission
Quick example
//Creats a role $role = Role::create('editor'); //Givs a permission to the role $role->givePermission('edit article'); //Adds the role to the user $user->assignRole($role); // You can also give it directly by its name $user->assignRole('editor'); //Checks whether the user has the permission var_dump($user->hasPermission('edit article')) //output "true"
Installation
- Install via composer
composer require slince/cakephp-permission
- Load the plugin in
config/bootstrap.php
:
// Load the plugin. Plugin::load('Slince/CakePermission');
- Add the following configuration to your
app.php
'Permission' => [ 'tableNameMap' => [ /** * Your users table, remember to modify it */ 'users' => 'your users table name', /** * Your roles table;If you want to use the default configuration. you don't need to change. */ //'roles' => 'roles', /** * Your permissions table;If you want to use the default configuration. you don't need to change. */ //'permissions' => 'permissions', /** * The join table between users and roles;If you want to use the default configuration. you don't need to change. */ //'users_roles' => 'users_roles', /** * The join table between roles and permissions;If you want to use the default configuration. you don't need to change. */ //'roles_permissions' => 'roles_permissions', ], 'tableClassMap' => [ /** * The Users model class, remember to modify it */ 'Users' => App\Model\Table\YourUsersTable::class, /** * The Roles model class;If you want to use the default configuration. you don't need to change. */ //'Roles' => Slince\CakePermission\Model\Table\RolesTable::class, /** * The Permissions model class;If you want to use the default configuration. you don't need to change. */ //'Permissions' => Slince\CakePermission\Model\Table\PermissionsTable::class ] ]
- Generate the permission migration
./cake permission_migrate
If ok, now run the migrate command
./cake migrations migrate
Usage
Models
Open your User
entity, use UserTrait
like this:
namespace App\Model\Entity; use Cake\ORM\Entity; use Slince\CakePermission\Model\Entity\UserTrait; class User extends Entity { use UserTrait; //Use trait provied by CakePermission protected $_accessible = [ '*' => true, 'id' => false ]; // ... }
Open your UsersTable
, use UserTableTrait
like this:
namespace App\Model\Table; use Cake\ORM\Table; use Slince\CakePermission\Model\Table\UsersTableTrait; class UsersTable extends Table { use UsersTableTrait; // Use `UsersTableTrait` public function initialize(array $config) { parent::initialize($config); $this->setTable('users'); $this->setDisplayField('id'); $this->setPrimaryKey('id'); $this->buildPermissionRelationship(); // Creats the relationship } // ... }
Using permissions
Creates the permissions with PermissionTrait::create
or PermissionTrait::findOrCreate
$addPermission = Permission::findOrCreate('add article'); $editPermission = Permission::create('edit article');
Using roles and permissions
Creates a role to the database with the RoleTrait::create
or RoleTrait::findOrCreate
$role = Role::create('editor'); //You can also use the following method. $role = Role::findOrCreate('editor');
Give the permission to the role; You must confirm that the permission exists.
$role->givePermission($addPermission); $role->givePermission($editPermission); //You can also directly give them by thier name $role->givePermission('add article'); $role->givePermission('edit article'); //You can also give multiple permissions at once $role->givePermission(['add article', 'edit article']);
Gets all permissions of the role
$role->getAllPermissions();
Checks whether the role has permission to do something:
$role->hasPermission('edit article'); //true $role->hasPermission(['edit artic;e', 'add article']); //true $role->hasPermission(['edit article', 'drop article']); // false $role->hasAnyPermission('edit article', 'drop article'); // true
Removes the permission
$role->revokePermission($addPermission); //Or by its name $role->revokePermission('add article'); //Revokes all permissions $role->revokeAllPermissions();
User's roles and permissions
Add the role to the user:
$user->assignRole($role); $user->assignRole('editor'); //You can also assign multiple roles at once $user->assignRole(['editor', 'other role']);
Gets all the roles of user
$user->getAllRoles();
Gets all permissions of user:
$user->getAllPermissions();
Checks whether the user has permission to do something:
$user->hasPermission('edit article'); //true $user->hasPermission(['edit artic;e', 'add article']); //true $user->hasPermission(['edit article', 'drop article']); // false $user->hasAnyPermission('edit article', 'drop article'); // true
Removes the role of the user:
$user->removeRole('editor'); //Or removes all roles of the user $user->removeAllRoles();
Extending
You can extends all existing Entity or Table. Do not forget to modify the default configuration in your app.php
Requirements
- CakePHP >=3.4
- PHP 5.5.9+
LICENSE
The MIT license. See MIT