{"id":20719713,"url":"https://github.com/slince/cakephp-permission","last_synced_at":"2025-07-05T10:39:06.621Z","repository":{"id":57053316,"uuid":"91069879","full_name":"slince/cakephp-permission","owner":"slince","description":":cake: The role-based permissions management for CakePHP 3 :pancakes: ","archived":false,"fork":false,"pushed_at":"2017-08-25T09:41:44.000Z","size":37,"stargazers_count":9,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-28T14:54:00.677Z","etag":null,"topics":["cakephp","manage-permission","manage-roles","manage-users","permission","rbac","role-based-access-control"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slince.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-12T08:36:19.000Z","updated_at":"2023-10-27T09:31:41.000Z","dependencies_parsed_at":"2022-08-24T04:11:33.929Z","dependency_job_id":null,"html_url":"https://github.com/slince/cakephp-permission","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/slince/cakephp-permission","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2Fcakephp-permission","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2Fcakephp-permission/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2Fcakephp-permission/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2Fcakephp-permission/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slince","download_url":"https://codeload.github.com/slince/cakephp-permission/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2Fcakephp-permission/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262659537,"owners_count":23344406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cakephp","manage-permission","manage-roles","manage-users","permission","rbac","role-based-access-control"],"created_at":"2024-11-17T03:18:06.233Z","updated_at":"2025-07-05T10:39:06.594Z","avatar_url":"https://github.com/slince.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Permission Management For CakePHP 3.x\n\n[![Build Status](https://img.shields.io/travis/slince/cakephp-permission/master.svg?style=flat-square)](https://travis-ci.org/slince/cakephp-permission)\n[![Coverage Status](https://img.shields.io/codecov/c/github/slince/cakephp-permission.svg?style=flat-square)](https://codecov.io/github/slince/cakephp-permission)\n[![Latest Stable Version](https://img.shields.io/packagist/v/slince/cakephp-permission.svg?style=flat-square\u0026label=stable)](https://packagist.org/packages/slince/cakephp-permission)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/slince/cakephp-permission.svg?style=flat-square)](https://scrutinizer-ci.com/g/slince/cakephp-permission/?branch=master)\n\nThe library provides a flexible way to add role-based access control management to CakePHP 3.x\n\nInspired by [Laravel Permission](https://github.com/spatie/laravel-permission)\n\n## Quick example\n\n```php\n//Creats a role\n$role = Role::create('editor');\n \n//Givs a permission to the role\n$role-\u003egivePermission('edit article');\n\n//Adds the role to the user \n$user-\u003eassignRole($role); \n// You can also give it directly by its name\n$user-\u003eassignRole('editor');\n\n//Checks whether the user has the permission\nvar_dump($user-\u003ehasPermission('edit article')) //output \"true\"\n```\n## Installation\n\n1. Install via composer\n\n```bash\ncomposer require slince/cakephp-permission\n```\n\n2. Load the plugin in `config/bootstrap.php`:\n\n```php\n// Load the plugin.\nPlugin::load('Slince/CakePermission');\n```\n3. Add the following configuration to your `app.php`\n\n```php\n'Permission' =\u003e [\n\n    'tableNameMap' =\u003e [\n        /**\n         * Your users table, remember to modify it\n         */\n        'users' =\u003e 'your users table name',\n\n        /**\n         * Your roles table;If you want to use the default configuration. you don't need to change.\n         */\n        //'roles' =\u003e 'roles',\n\n        /**\n         * Your permissions table;If you want to use the default configuration. you don't need to change.\n         */\n        //'permissions' =\u003e 'permissions',\n\n        /**\n         * The join table between users and roles;If you want to use the default configuration. you don't need to change.\n         */\n        //'users_roles' =\u003e 'users_roles',\n\n        /**\n         * The join table between roles and permissions;If you want to use the default configuration. you don't need to change.\n         */\n        //'roles_permissions' =\u003e 'roles_permissions',\n    ],\n\n    'tableClassMap' =\u003e [\n        /**\n         * The Users model class, remember to modify it\n         */\n        'Users' =\u003e App\\Model\\Table\\YourUsersTable::class,\n\n        /**\n         * The Roles model class;If you want to use the default configuration. you don't need to change.\n         */\n        //'Roles' =\u003e Slince\\CakePermission\\Model\\Table\\RolesTable::class,\n\n        /**\n         * The Permissions model class;If you want to use the default configuration. you don't need to change.\n         */\n        //'Permissions' =\u003e Slince\\CakePermission\\Model\\Table\\PermissionsTable::class\n    ]\n]\n```\n\n4. Generate the permission migration\n\n```bash\n./cake permission_migrate\n```\nIf ok, now run the migrate command\n\n```bash\n./cake migrations migrate\n```\n \n \n## Usage\n\n### Models\n\nOpen your `User` entity, use `UserTrait` like this:\n\n```php\nnamespace App\\Model\\Entity;\n\nuse Cake\\ORM\\Entity;\nuse Slince\\CakePermission\\Model\\Entity\\UserTrait;\n\nclass User extends Entity\n{\n    use UserTrait; //Use trait provied by CakePermission\n\n    protected $_accessible = [\n        '*' =\u003e true,\n        'id' =\u003e false\n    ];\n    \n    // ...\n}\n```\n\nOpen your `UsersTable`, use `UserTableTrait` like this:\n\n```php\nnamespace App\\Model\\Table;\n\nuse Cake\\ORM\\Table;\nuse Slince\\CakePermission\\Model\\Table\\UsersTableTrait;\n\nclass UsersTable extends Table\n{\n    use UsersTableTrait;  // Use `UsersTableTrait`\n\n    public function initialize(array $config)\n    {\n        parent::initialize($config);\n\n        $this-\u003esetTable('users');\n        $this-\u003esetDisplayField('id');\n        $this-\u003esetPrimaryKey('id');\n\n        $this-\u003ebuildPermissionRelationship(); // Creats the relationship\n    }\n    \n    // ...\n}\n```\n\n### Using permissions\n\nCreates the permissions with `PermissionTrait::create` or `PermissionTrait::findOrCreate`\n\n```php\n$addPermission = Permission::findOrCreate('add article');\n\n$editPermission = Permission::create('edit article');\n```\n\n### Using roles and permissions\n\nCreates a role to the database with the `RoleTrait::create` or `RoleTrait::findOrCreate`\n\n```php\n$role = Role::create('editor');\n\n//You can also use the following method. \n$role = Role::findOrCreate('editor');\n```\n\nGive the permission to the role;  You must confirm that the permission exists.\n\n```php\n$role-\u003egivePermission($addPermission);\n$role-\u003egivePermission($editPermission);\n\n//You can also directly give them by thier name\n$role-\u003egivePermission('add article');\n$role-\u003egivePermission('edit article');\n\n//You can also give multiple permissions at once\n$role-\u003egivePermission(['add article', 'edit article']);\n```\n\nGets all permissions of the role\n\n```php\n$role-\u003egetAllPermissions();\n```\n\nChecks whether the role has permission to do something:\n\n```php\n$role-\u003ehasPermission('edit article'); //true\n\n$role-\u003ehasPermission(['edit artic;e', 'add article']); //true\n\n$role-\u003ehasPermission(['edit article', 'drop article']); // false\n\n$role-\u003ehasAnyPermission('edit article', 'drop article'); // true\n```\n\nRemoves the permission\n\n```php\n$role-\u003erevokePermission($addPermission);\n \n//Or by its name\n$role-\u003erevokePermission('add article'); \n\n//Revokes all permissions\n$role-\u003erevokeAllPermissions();\n```\n\n\n### User's roles and permissions\n\nAdd the role to the user:\n\n```php\n$user-\u003eassignRole($role);\n\n$user-\u003eassignRole('editor');\n\n//You can also assign multiple roles at once\n$user-\u003eassignRole(['editor', 'other role']);\n```\n\nGets all the roles of user\n\n```php\n$user-\u003egetAllRoles();\n```\n\nGets all permissions of user:\n\n```php\n$user-\u003egetAllPermissions();\n```\n\nChecks whether the user has permission to do something:\n\n```php\n$user-\u003ehasPermission('edit article'); //true\n\n$user-\u003ehasPermission(['edit artic;e', 'add article']); //true\n\n$user-\u003ehasPermission(['edit article', 'drop article']); // false\n\n$user-\u003ehasAnyPermission('edit article', 'drop article'); // true\n```\n\nRemoves the role of the user:\n\n```php\n$user-\u003eremoveRole('editor');\n\n//Or removes all roles of the user\n$user-\u003eremoveAllRoles(); \n```\n\n## Extending\n\nYou can extends all existing Entity or Table. Do not forget to modify the default configuration in your `app.php`\n\n## Requirements\n\n- CakePHP \u003e=3.4\n- PHP 5.5.9+\n\n## LICENSE\n\nThe MIT license. See [MIT](https://opensource.org/licenses/MIT)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslince%2Fcakephp-permission","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslince%2Fcakephp-permission","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslince%2Fcakephp-permission/lists"}