init

Author: Tinywan

.gitignore

@@ -0,0 +1,6 @@
+build
+vendor
+.idea
+.vscode
+.phpunit*
+composer.lock

README.md

@@ -1,2 +1,105 @@
-# webman-permission
+# webman casbin plugin
+
+[![Latest Stable Version](http://poser.pugx.org/tinywan/casbin/v)](https://packagist.org/packages/tinywan/casbin) 
+[![Total Downloads](http://poser.pugx.org/tinywan/casbin/downloads)](https://packagist.org/packages/tinywan/casbin) 
+[![License](http://poser.pugx.org/tinywan/casbin/license)](https://packagist.org/packages/tinywan/casbin) 
+[![PHP Version Require](http://poser.pugx.org/tinywan/casbin/require/php)](https://packagist.org/packages/tinywan/casbin)
+[![webman-event](https://img.shields.io/github/last-commit/tinywan/casbin/main)]()
+[![webman-event](https://img.shields.io/github/v/tag/tinywan/casbin?color=ff69b4)]()
+
 An authorization library that supports access control models like ACL, RBAC, ABAC for webman plugin
+
+## Requirements
+
+- [ThinkORM](https://www.workerman.net/doc/webman/db/others.html)
+- [PHP-DI](https://github.com/PHP-DI/PHP-DI)
+
+## Installation
+
+```sh
+composer require tinywan/casbin
+```
+
+## Configure
+
+### 1、DI
+
+configure `config/container.php`，Its final content is as follows：
+
+```php
+$builder = new \DI\ContainerBuilder();
+$builder->addDefinitions(config('dependence', []));
+$builder->useAutowiring(true);
+return $builder->build();
+```
+
+### 2、Database configuration
+
+（1）修改数据库 `thinkorm` 配置
+
+（2）创建 `casbin_rule` 数据表
+
+```sql
+CREATE TABLE `casbin_rule` (
+	`id` BIGINT ( 20 ) UNSIGNED NOT NULL AUTO_INCREMENT,
+	`ptype` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v0` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v1` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v2` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v3` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v4` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	`v5` VARCHAR ( 128 ) NOT NULL DEFAULT '',
+	PRIMARY KEY ( `id` ) USING BTREE,
+	KEY `idx_ptype` ( `ptype` ) USING BTREE,
+	KEY `idx_v0` ( `v0` ) USING BTREE,
+	KEY `idx_v1` ( `v1` ) USING BTREE,
+	KEY `idx_v2` ( `v2` ) USING BTREE,
+	KEY `idx_v3` ( `v3` ) USING BTREE,
+	KEY `idx_v4` ( `v4` ) USING BTREE,
+    KEY `idx_v5` ( `v5` ) USING BTREE 
+) ENGINE = INNODB CHARSET = utf8mb4 COMMENT = '策略规则表';
+```
+（3）配置 `config/redis` 配置
+
+## 重启webman
+
+```
+php start.php restart
+```
+或者
+```
+php start.php restart -d
+```
+
+## 用法
+
+### 快速开始
+
+安装成功后，可以这样使用:
+
+```php
+use Tinywan\Casbin\Permission;
+
+// adds permissions to a user
+Permission::addPermissionForUser('eve', 'articles', 'read');
+// adds a role for a user.
+Permission::addRoleForUser('eve', 'writer');
+// adds permissions to a rule
+Permission::addPolicy('writer', 'articles','edit');
+```
+
+你可以检查一个用户是否拥有某个权限:
+
+```php
+if (Permission::enforce("eve", "articles", "edit")) {
+    echo '恭喜你！通过权限认证';
+} else {
+    echo '对不起，您没有该资源访问权限';
+}
+```
+
+更多 `API` 参考 [Casbin API](https://casbin.org/docs/en/management-api) 。
+
+## 感谢
+
+[Casbin](https://github.com/php-casbin/php-casbin)，你可以查看全部文档在其 [官网](https://casbin.org/) 上。

composer.json

@@ -0,0 +1,34 @@
+{
+  "name": "tinywan/casbin",
+  "description": "Webman Casbin Plugin",
+  "type": "library",
+  "license": "MIT",
+  "require": {
+    "php": ">=7.4",
+    "casbin/casbin": "^3.20",
+    "topthink/think-orm": "^2.0",
+    "php-di/php-di": "^6.3",
+    "workerman/redis": "^1.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Tinywan\\Casbin\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Tinywan\\Tests\\": "tests/"
+    }
+  },
+  "require-dev": {
+    "phpunit/phpunit": "~7.0|~8.0|~9.0",
+    "php-coveralls/php-coveralls": "^2.1",
+    "workerman/webman": "^1.0"
+  },
+  "repositories": {
+    "packagist": {
+      "type": "composer",
+      "url": "https://mirrors.aliyun.com/composer//"
+    }
+  }
+}