{"id":15282224,"url":"https://github.com/php-casbin/yii-permission","last_synced_at":"2025-04-12T20:32:58.558Z","repository":{"id":46776508,"uuid":"157477822","full_name":"php-casbin/yii-permission","owner":"php-casbin","description":"Use casbin in Yii PHP Framework, Casbin is a powerful and efficient open-source access control library.","archived":false,"fork":false,"pushed_at":"2021-09-26T15:52:07.000Z","size":25,"stargazers_count":42,"open_issues_count":1,"forks_count":8,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-23T23:38:35.670Z","etag":null,"topics":["abac","access-control","acl","adapter","auth","casbin","permission","rbac","yii"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/php-casbin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-14T02:24:30.000Z","updated_at":"2024-01-02T03:21:55.000Z","dependencies_parsed_at":"2022-09-08T10:11:02.590Z","dependency_job_id":null,"html_url":"https://github.com/php-casbin/yii-permission","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-casbin%2Fyii-permission","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-casbin%2Fyii-permission/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-casbin%2Fyii-permission/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-casbin%2Fyii-permission/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/php-casbin","download_url":"https://codeload.github.com/php-casbin/yii-permission/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248630401,"owners_count":21136431,"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":["abac","access-control","acl","adapter","auth","casbin","permission","rbac","yii"],"created_at":"2024-09-30T14:24:43.631Z","updated_at":"2025-04-12T20:32:58.294Z","avatar_url":"https://github.com/php-casbin.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yii-Permission\n\n[![Build Status](https://github.com/php-casbin/yii-permission/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/php-casbin/yii-permission/actions/workflows/build.yml)\n[![Coverage Status](https://coveralls.io/repos/github/php-casbin/yii-permission/badge.svg)](https://coveralls.io/github/php-casbin/yii-permission)\n[![Latest Stable Version](https://poser.pugx.org/casbin/yii-permission/v/stable)](https://packagist.org/packages/casbin/yii-permission)\n[![Total Downloads](https://poser.pugx.org/casbin/yii-permission/downloads)](https://packagist.org/packages/casbin/yii-permission)\n[![License](https://poser.pugx.org/casbin/yii-permission/license)](https://packagist.org/packages/casbin/yii-permission)\n\nUse [Casbin](https://github.com/php-casbin/php-casbin) in Yii 2.0 PHP Framework.\n\n## Installation\n\n### Getting Composer package\n\nRequire this package in the `composer.json` of your Yii 2.0 project. This will download the package.\n\n```\ncomposer require casbin/yii-permission\n```\n\n### Configuring application\n\nTo use this extension, you have to configure the `Casbin` class in your application configuration:\n\n```php\nreturn [\n    //....\n    'components' =\u003e [\n        'permission' =\u003e [\n            'class' =\u003e \\yii\\permission\\Permission::class,\n            \n            /*\n             * Casbin model setting.\n             */\n            'model' =\u003e [\n                // Available Settings: \"file\", \"text\"\n                'config_type' =\u003e 'file',\n                'config_file_path' =\u003e '/path/to/casbin-model.conf',\n                'config_text' =\u003e '',\n            ],\n\n            // Casbin adapter .\n            'adapter' =\u003e \\yii\\permission\\Adapter::class,\n\n            /*\n             * Casbin database setting.\n             */\n            'database' =\u003e [\n                // Database connection for following tables.\n                'connection' =\u003e '',\n                // CasbinRule tables and model.\n                'casbin_rules_table' =\u003e '{{%casbin_rule}}',\n            ],\n        ],\n    ]\n];\n```\n\n\n## Usage\n\n### Quick start\n\nOnce installed you can do stuff like this:\n\n```php\n\n$permission = \\Yii::$app-\u003epermission;\n\n// adds permissions to a user\n$permission-\u003eaddPermissionForUser('eve', 'articles', 'read');\n// adds a role for a user.\n$permission-\u003eaddRoleForUser('eve', 'writer');\n// adds permissions to a rule\n$permission-\u003eaddPolicy('writer', 'articles','edit');\n\n```\n\nYou can check if a user has a permission like this:\n\n```php\n// to check if a user has permission\nif ($permission-\u003eenforce(\"eve\", \"articles\", \"edit\")) {\n    // permit eve to edit articles\n} else {\n    // deny the request, show an error\n}\n\n```\n\n### Using Enforcer Api\n\nIt provides a very rich api to facilitate various operations on the Policy:\n\nGets all roles:\n\n```php\n$permission-\u003egetAllRoles(); // ['writer', 'reader']\n```\n\nGets all the authorization rules in the policy.:\n\n```php\n$permission-\u003egetPolicy();\n```\n\nGets the roles that a user has.\n\n```php\n$permission-\u003egetRolesForUser('eve'); // ['writer']\n```\n\nGets the users that has a role.\n\n```php\n$permission-\u003egetUsersForRole('writer'); // ['eve']\n```\n\nDetermines whether a user has a role.\n\n```php\n$permission-\u003ehasRoleForUser('eve', 'writer'); // true or false\n```\n\nAdds a role for a user.\n\n```php\n$permission-\u003eaddRoleForUser('eve', 'writer');\n```\n\nAdds a permission for a user or role.\n\n```php\n// to user\n$permission-\u003eaddPermissionForUser('eve', 'articles', 'read');\n// to role\n$permission-\u003eaddPermissionForUser('writer', 'articles','edit');\n```\n\nDeletes a role for a user.\n\n```php\n$permission-\u003edeleteRoleForUser('eve', 'writer');\n```\n\nDeletes all roles for a user.\n\n```php\n$permission-\u003edeleteRolesForUser('eve');\n```\n\nDeletes a role.\n\n```php\n$permission-\u003edeleteRole('writer');\n```\n\nDeletes a permission.\n\n```php\n$permission-\u003edeletePermission('articles', 'read'); // returns false if the permission does not exist (aka not affected).\n```\n\nDeletes a permission for a user or role.\n\n```php\n$permission-\u003edeletePermissionForUser('eve', 'articles', 'read');\n```\n\nDeletes permissions for a user or role.\n\n```php\n// to user\n$permission-\u003edeletePermissionsForUser('eve');\n// to role\n$permission-\u003edeletePermissionsForUser('writer');\n```\n\nGets permissions for a user or role.\n\n```php\n$permission-\u003egetPermissionsForUser('eve'); // return array\n```\n\nDetermines whether a user has a permission.\n\n```php\n$permission-\u003ehasPermissionForUser('eve', 'articles', 'read');  // true or false\n```\n\n### Using Yii Authorization\n\nIt allows you to integrate Yii's authorization with the Casbin permission management system. \n\n**(1) AccessChecker**\n\nAdd the accessChecker configuration in your application's `config/web.php` file:\n\n```php\n$config = [\n    'components' =\u003e [\n        'user' =\u003e [\n            ...\n            'accessChecker' =\u003e 'yii\\permission\\components\\PermissionChecker',\n        ]\n];\n```\n\nOnce configured, you can use the `can()` method to check if a user has permission to perform certain actions:\n\n```php\n$user-\u003ecan('acrticles,read');\n```\n\n**(2) Behaviors**\n\nThe `PermissionControl` behavior allows you to enforce permission checks at the controller level. Add the PermissionControl behavior to your controller's behaviors() method:\n\n```php\npublic function behaviors()\n{\n    return [\n        'permission' =\u003e [\n            'class' =\u003e \\yii\\permission\\components\\PermissionControl::class,\n            'user' =\u003e $user, // optional, defaults to \\Yii::$app-\u003euser\n            'only' =\u003e ['read-articles', 'write-articles'],\n            'policy' =\u003e [\n                [\n                    'allow' =\u003e true,\n                    'actions' =\u003e ['read-articles'],\n                    'enforce' =\u003e ['articles', 'read']\n                ],\n                [\n                    'allow' =\u003e true,\n                    'actions' =\u003e ['write-articles'],\n                    'enforce' =\u003e ['articles', 'write']\n                ]\n            ],\n            'denyCallback' =\u003e function ($policy, $action) {\n                // custom action when access is denied\n            } // optional, defaults to throwing an exception\n        ]\n    ];\n}\n```\n\n**Note:** Additionally,You can also configure a `denyCallback` for each `policy`, which will be invoked when the user does not meet the required permission. This callback takes precedence. The configuration is similar to Yii's official [AccessControl](https://www.yiiframework.com/doc/guide/2.0/en/security-authorization#access-control-filter).\n\nSee [Casbin API](https://casbin.org/docs/en/management-api) for more APIs.\n\n## Define your own model.conf\n\n[Supported models](https://github.com/php-casbin/php-casbin#supported-models).\n\n## Learning Casbin\n\nYou can find the full documentation of Casbin [on the website](https://casbin.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-casbin%2Fyii-permission","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphp-casbin%2Fyii-permission","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-casbin%2Fyii-permission/lists"}