API 参考

本目录是如意框架 kernel/ 的完整 API 参考，按源码目录结构组织。每个类一个独立页面，记录其命名空间、文件位置、继承关系、构造方式、公开接口签名与使用示例。

提示：入门与使用概念请查阅 框架核心 等文档；本目录是面向开发者的结构化接口速查。

目录结构

kernel/ 下的核心代码集中在 kernel/Foundation/（框架基础层），其余为框架提供、可在应用中扩展的服务、模型、中间件、控制器与平台封装。

kernel/
├── Foundation/            → 框架基础层（根层级类 + 命名空间子目录）
│   ├── App.php            → 应用入口
│   ├── Cache.php          → 缓存
│   ├── Common.php         → 全局函数（getApp/config/path/url…）
│   ├── Config.php         → 配置
│   ├── Event.php          → 事件
│   ├── Lifecycle.php      → 生命周期
│   ├── Log.php            → 日志
│   ├── Output.php         → 调试输出
│   ├── Provisioner.php    → 生命周期编排器
│   ├── Result.php         → 返回结果
│   ├── Router.php         → 路由
│   ├── Service.php        → 服务基类
│   ├── URL.php            → 统一 URL 静态门面
│   ├── Console/           → 控制台与命令
│   ├── Controller/        → 控制器体系
│   ├── Data/              → 数据/字符串工具类
│   ├── Database/          → 数据库（PDO/MongoDB/SQLite）
│   ├── Exception/         → 异常体系（Error / ErrorCode / ExceptionHandler）
│   ├── Extension/         → 扩展机制
│   ├── FileSystem/        → 文件系统/路径/压缩/存储
│   ├── HTTP/              → HTTP 请求响应
│   ├── Middleware/        → 中间件
│   ├── Object/            → 对象基类
│   └── Validation/        → 数据校验
├── Service/               → 应用服务类（框架提供）
├── Middleware/            → 全局中间件（框架提供）
├── Model/                 → 数据模型（框架提供）
├── Traits/                → 复用特性（框架提供）
├── Modules/               → 功能模块（框架提供）
├── Controller/            → 命令 / 内置入口控制器
└── Platform/              → 第三方平台（Wechat/Aliyun/QCloud/DiscuzX）

分篇索引

Foundation 根层级

• App 应用入口
• Cache 缓存
• Config 配置
• Event 事件
• Lifecycle 生命周期
• Log 日志
• Output 输出
• Provisioner 编排器
• Result 返回结果
• Router 路由
• Service 服务基类
• URL 统一地址
• Common 全局函数

Foundation 命名空间子目录

• Console 控制台（Command）
• Controller 控制器（AuthController · ControllerQuery · ControllerBody · ControllerResponse）
• Data 数据工具（Str · Numeric · Date · Money · Mutator · Serializer · Transform）
• Error 业务异常（ErrorCode · ExceptionHandler）
• Extension 扩展（ExtensionMain · ExtensionProvisioner）
• FileSystem 文件系统（FileHelper · Path · Zip · Storage）
• HTTP 请求与响应（Response · URL · Curl）
• Middleware 中间件（MiddlewareBase）
• Object 对象基类（AbilityBaseObject · DataObject）
• Validation 校验（Rules · Rule · RuleBuilder · RuleInterface）

Database 数据库

• PDO（Query · Model · Schema · Table · Connections · Driver · Statement · Paginator · Relation）
• MongoDB（Driver · Collection）
• SQLite（SQLiteModel）

框架提供的应用类

• Service 服务类（LanguageService · RedisService · StorageService）
• 全局中间件（GlobalCorsMiddleware · GlobalWechatOfficialAccountMiddleware）
• Model 模型（AccessTokenModel · LoginsModel · AttachmentsModel · ExtensionsModel · OrderModel · SettingsModel · WechatUsersModel）
• Traits 特性
• Modules 模块（SettingService · SettingsModel）

Controller 命令与内置入口

• 命令控制器（make:app · make:model · make:controller · make:middleware · schedule:run）
• Main 内置入口（文件控制器 · 扩展控制器）

Platform 第三方平台

• Wechat 微信（AccessToken · 小程序 · 公众号 · 微信支付）
• Aliyun 阿里云（AliyunRequest · AliyunSignature · AliyunOSS）
• QCloud 腾讯云（QCloudFaceId · QCloudSTS · QCloudCOS）
• DiscuzX（Foundation 基类 · Model · Member · Middleware · Controller）

通用约定

• 命名空间：根层级类为 kernel\Foundation；子目录类为 kernel\Foundation\{子目录}\...；kernel\ 下其他目录（Service/Model/Platform 等）对应各自命名空间
• camelCase：框架方法/参数统一小写驼峰命名
• 自动装配：App 延迟实例化组件，由 Setup/Bootstrap.php 通过 $app->set([...]) 注入；也可用 getApp() 在业务代码中获取当前实例
• 返回结果：Service/Controller 等方法多以 Result 作为统一返回，判断 ->isSuccess()/->isError() 后处理
• 单例：多数 Model/Service 通过 BaseObject::singleton() 获取，具体见对应页面