CakePHP TinyAuth 插件使用教程
1. 项目目录结构及介绍
CakePHP TinyAuth 插件的目录结构如下:
cakephp-tinyauth/
├── composer.json
├── LICENSE
├── README.md
├── docs/
│ ├── Authentication.md
│ ├── Authorization.md
│ └── ...
├── src/
│ ├── Controller/
│ ├── Middleware/
│ ├── Plugin.php
│ └── ...
├── tests/
│ ├── TestCase/
│ └── ...
├── templates/
│ ├── element/
│ └── ...
└── ...
目录结构介绍
- composer.json: 项目的依赖管理文件,定义了插件的依赖关系。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的介绍文档,包含了插件的基本信息和使用说明。
- docs/: 包含插件的详细文档,如
Authentication.md
和Authorization.md
,分别介绍了认证和授权的相关内容。 - src/: 插件的核心代码目录,包含了控制器、中间件、插件入口文件等。
- tests/: 插件的测试代码目录,包含了各种测试用例。
- templates/: 插件的视图模板目录,包含了各种视图元素。
2. 项目的启动文件介绍
CakePHP TinyAuth 插件的启动文件是 src/Plugin.php
。这个文件是插件的入口文件,负责加载插件并初始化相关配置。
// src/Plugin.php
namespace TinyAuth;
use Cake\Core\BasePlugin;
class Plugin extends BasePlugin
{
// 插件的初始化逻辑
}
启动文件介绍
- Plugin.php: 这是插件的入口文件,继承自
Cake\Core\BasePlugin
类。通过这个文件,插件可以被 CakePHP 框架识别并加载。
3. 项目的配置文件介绍
CakePHP TinyAuth 插件的配置文件主要有两个:auth_allow.ini
和 auth_acl.ini
。这两个文件分别用于定义公共访问的控制器和操作,以及用户角色的访问权限。
auth_allow.ini
[Users]
index = *
view = *
[Admin/Maintenance]
pingCheck = *
[PluginName/SomeController]
* = *
[MyPlugin/Api/V1]
* = *
auth_acl.ini
[Users]
index = *
add,edit = user,super-user
[Admin/Users]
* = admin
[Translate/Admin/Languages]
* = *
配置文件介绍
- auth_allow.ini: 定义了哪些控制器和操作可以被任何人访问。例如,
Users
控制器的index
和view
操作可以被任何人访问。 - auth_acl.ini: 定义了哪些操作可以被哪些用户角色访问。例如,
Users
控制器的index
操作可以被所有角色访问,而add
和edit
操作只能被user
和super-user
角色访问。
通过这两个配置文件,CakePHP TinyAuth 插件可以轻松地管理用户的认证和授权,而无需修改控制器代码。