文档

本文档由自动生成工具创建于 2025-09-17 13:17:05

一些代码示例

详情可以看示例

//使用Api中的类
//在继承 App\Base 之后(必须)
$this->api->message; //使用Api\message 其他以此类推
$this->redis; //redis类
$this->group; //当前群号
$this->qq; //发言人
$this->nickname; //发言人昵称
$this->sender; //发言人的object
$this->input; //参数列表
$this->raw; //raw_message，\Controller\Attr\Rule基于这个匹配


//不继承 App\BaseApp 不会被识别为插件

#[\Controller\Attr\Rule()]
/**
 * 该注解方法必须的，不使用不会被命令解析
 * @param string $match 正则表达式
 * @param string $name 菜单列表中显示名，可以为空
 * @param string $pattern 忘了干啥的了，不必理会
 * @param string|int $permission 权限等级，>= 才能触发，最高5(super)，可选4(owner)、3(admin)、2(user)、1(default)
*/

配置示例

采用了composer配置，但多出一些自定义配置，底层还是composer

{
	"name": "plugin/test", //包名
	"version": "2.1.4", //版本号
	"displayName": "高级数据处理器 Pro", //插件显示名
	"description": "一个提供多种数据处理功能的插件，支持数据转换、分析和可视化", //描述
	"author": [ //作者信息列表
		{
			"name": "张三", //作者名
			"email": "zhangsan@example.com", //联系邮箱
			"homePage": "https://www.zhangsan-dev.com", //网站
			"role": "开发者" //所属角色
		}
	],
	"autoload": { //类似于composer的autoload
		"psr-4": {
			"test\\": "src/"
		}
	},
	"require": {}, //所需要的composer包
	"creationDate": "2023-01-15", //创建时间
	"lastUpdate": "2023-10-28", //最后更新时间
	"license": "MIT", //许可类型
	"support": { //支持者信息
		"documentation": "https://docs.example.com/data-processor", //官方文档地址
		"issues": "https://github.com/example/data-processor/issues", //问题反馈地址
		"forum": "https://forum.example.com/c/plugins/data-processor", //交流论坛地址
		"sourceCode": "https://github.com/example/data-processor" //源代码地址
	}
}

📁 目录索引

ai
- getAiCharacter
- getAiRecord
- sendGroupAiRecord
app
- __construct
bot
- init
- getLoginInfo
- setQQProfile
- getModelShow
- setModelShow
- getOnlineClients
cqHttp
- getCookies
- getClientKey
- getSkey
- getCsrfToken
- getCredentials
- getVersionInfo
- getStatus
- setRestart
- reloadEventFilter
- downloadFilter
- checkUrlSafely
- cleanCache
file
- uploadPrivateFile
- uploadGroupFile
- deleteGroupFile
- createGroupFileFolder
- deleteGroupFolder
- getGroupFileSystemInfo
- getGroupRootFiles
- getGroupRootFilesByFolder
- getGroupFileUrl
friend
- getStrangerInfo
- getFriendList
- getUnidirectionalFriendList
- deleteFriend
- deleteUnidirectionalFriend
groupInfo
- getGroupInfo
- getGroupList
- getGroupMemberInfo
- getGroupMemberList
- getGroupHonorInfo
- getGroupSystemMsg
- getEssenceMsgList
- getGroupAtAllRemain
groupSetup
- setGroupName
- setGroupPortrait
- setGroupAdmin
- setGroupCard
- setGroupSpecialTitle
- setGroupBan
- setGroupWholeBan
- setGroupAnonymousBan
- setEssenceMsg
- sendGroupSign
- setGroupAnonymous
- sendGroupNotice
- getGroupNotice
- setGroupKick
- setGroupLeave
handle
- setFriendAddRequest
- setGroupAddRequest
image
- getImage
- canSendImage
- ocrImage
message
- sendPrivateMsg
- sendGroupMsg
- sendMsg
- sendMarkdownMsg
- sendGreyTip
- sendKeyboardMsg
- getMsg
- deleteMsg
- markMsgAsRead
- getForwardMsg
- sendForwardMsg
- sendGroupForwardMsg
- sendPrivateForwardMsg
- getGroupMsgHistory
- escape
- structureImage
- structureVideo
- structureRecord
- structureFace
- structureMagic
- structureGift
- structurePoke
- structureShare
- structureContact
- structureLocation
- structureMusic
- structureReply
- structureNode
- structureCard
- structureTts
- structureText
- structureTextPro
- structureAt
- structureJson
- structureMarkdown
- structureLongMsg
- structureKeyboard
- structureGreyTip
record
- getRecord
- canSendRecord
uin
- __construct
- get
- set
- data
BaseApp
- __construct
- comparePermission
- permissionToNum
- permissionToName
- getUserPermission
- __get
- getGroupInfo
- groupStatus
- initGroupInfo
- updateGroupInfo
- scanWorkerList
Cache
- get
- set
- del
- getBatch
- setBatch
- __callStatic
CommandParser
- getInstance
- command
- option
- getHelp
- parse
CoroutineCurl
- __construct
- init
- location
- addHeaders
- setHeaders
- get
- post
- request
- accept
- timeout
- encode
- proxy
- json
- object
- string
- __toString
Env
- get
- refreshCache
- getAll
- Config
Logger
- init
- configure
- message
- success
- error
- info
- warning
- debug
- tput
- enableConsole
- enableFile
Markdown
- __construct
- render
- action
- id
- permission
- next
- prev
- current
- buttons
- url
- Image
- markdown
- at
- Face
- add
- cleanMarkdown
- cleanButton
- clean
- get
- send
- bind
- escape
Operate
- get
- set
- dir
- read_all
- readAll
- read_all_dir
- read_all_dir_list
- readAllDir
- readFile
- unzip
- xCopy
- delDir
- del_dir
- delfile
- del_file
Yargs
- getInstance
- command
- option
- positional
- getHelp
- parse

ai 类

完整类名: Api\ai

📋 可用方法

方法导航: getAiCharacter | getAiRecord | sendGroupAiRecord

`getAiCharacter`

参数:
- type int 类型，1 tts，2 song
返回: Object

`getAiRecord`

参数:
- character string 语音声音，可通过getAiCharacter获取
- group float 群号
- content string 音频内容
返回: Object

`sendGroupAiRecord`

参数:
- character string 语音声音，可通过getAiCharacter获取
- group float 群号
- content string 音频内容
返回: Object

⬆️ 返回顶部

app 类

完整类名: Api\app

📋 可用方法

方法导航: __construct

`__construct`

⬆️ 返回顶部

bot 类

完整类名: Api\bot

📋 可用方法

`init` `(static)`

`getLoginInfo`

返回: object

`setQQProfile`

参数:
- nickname string 名称
- company ?string 公司
- email ?string 邮箱
- college ?string 学校
- personal_note ?string 个人介绍
返回: void

`getModelShow`

参数:
- model string 机型名称
返回: object

`setModelShow`

参数:
- model string 机型名称
- model_show string -
返回: object

`getOnlineClients`

参数:
- cache bool 是否无视缓存
返回: object

⬆️ 返回顶部

cqHttp 类

完整类名: Api\cqHttp

📋 可用方法

`getCookies`

参数:
- domain ?string Cookie域名，例如：vip.qq.com、y.qq.com、qun.qq.com;
返回: object

`getClientKey`

返回: object

`getSkey`

参数:
- domain ?string Cookie域名，例如：vip.qq.com、y.qq.com、qun.qq.com;
返回: object

`getCsrfToken`

返回: object

`getCredentials`

参数:
- domain ?string Cookie域名，例如：vip.qq.com、y.qq.com、qun.qq.com;
返回: object

`getVersionInfo`

返回: object

`getStatus`

返回: object

`setRestart`

参数:
- delay float 延迟时间，默认2000毫秒，最小2000
返回: void

`reloadEventFilter`

参数:
- file string 过滤文件
返回: void

`downloadFilter`

参数:
- url string 链接
- thread_count int 线程数量
- headers string|array 头部 ["User-Agent=YOUR_UA","Referer=https://www.baidu.com"] 或者 User-Agent=YOUR_UA\nReferer=https://www.baidu.com
返回: object

`checkUrlSafely`

参数:
- url string 链接
返回: object

`cleanCache`

返回: void

⬆️ 返回顶部

file 类

完整类名: Api\file

📋 可用方法

`uploadPrivateFile`

参数:
- qq float 群号
- file string 文件路径，必须是本地
- name string 文件名称
返回: object

`uploadGroupFile`

参数:
- group float 群号
- file string 文件路径，必须是本地
- name string 储存名称
- folder string 父目录id，默认是根目录
返回: object

`deleteGroupFile`

参数:
- group float 群号
- file_id string 文件id
- busid int 文件类型
返回: void

`createGroupFileFolder`

参数:
- group float 群号
- name string 文件夹名字
返回: void

`deleteGroupFolder`

参数:
- group float 群号
- folder_id string 文件夹id
返回: void

`getGroupFileSystemInfo`

参数:
- group float 群号
返回: object

`getGroupRootFiles`

参数:
- group float 群号
返回: object

`getGroupRootFilesByFolder`

参数:
- group float 群号
- folder_id string 文件夹id
返回: object

`getGroupFileUrl`

参数:
- group float 群号
- file_id string 文件id
- busid int 文件类型
返回: object

⬆️ 返回顶部

friend 类

完整类名: Api\friend

📋 可用方法

方法导航: getStrangerInfo | getFriendList | getUnidirectionalFriendList | deleteFriend | deleteUnidirectionalFriend

`getStrangerInfo`

参数:
- qq float QQ帐号
- no_cache bool 是否无视缓存，无视可能更新不及时
返回: object

`getFriendList`

返回: object

`getUnidirectionalFriendList`

返回: object

`deleteFriend`

参数:
- qq float 账号
返回: void

`deleteUnidirectionalFriend`

参数:
- qq float 账号
返回: void

⬆️ 返回顶部

groupInfo 类

完整类名: Api\groupInfo

📋 可用方法

`getGroupInfo`

参数:
- group float 群号
- no_cache bool 是否不使用缓存，默认是
返回: object

`getGroupList`

参数:
- no_cache bool 是否不使用缓存，默认是
返回: object

`getGroupMemberInfo`

参数:
- group float 群号
- qq float 账号
- no_cache bool 是否不使用缓存，默认是
返回: object

`getGroupMemberList`

参数:
- group float 群号
- no_cache bool 是否不使用缓存，默认是
返回: object

`getGroupHonorInfo`

参数:
- group float 群号
- type string 要获取的群荣誉类型, 可传入 talkative performer legend strong_newbie emotion 以分别获取单个类型的群荣誉数据, 或传入 all 获取所有数据
返回: object

`getGroupSystemMsg`

返回: object

`getEssenceMsgList`

参数:
- group float 群号
返回: object

`getGroupAtAllRemain`

参数:
- group float 群号
返回: object

⬆️ 返回顶部

groupSetup 类

完整类名: Api\groupSetup

📋 可用方法

`setGroupName`

参数:
- group float 群号
- group_name string 要设置的群名
返回: object

`setGroupPortrait`

参数:
- group float 群号
- file string 图片链接，可以file://，url，base64://
- cache int 是否使用已缓存文件，0否1是
返回: object

`setGroupAdmin`

参数:
- group float 群号
- qq float 账号
- enable bool true设置 false取消
返回: void

`setGroupCard`

参数:
- group float 群号
- qq float 账号
- card ?string 群名片，不填或空为删除群名片
返回: void

`setGroupSpecialTitle`

参数:
- group float 群号
- qq float 账号
- special_title ?string 群头衔，不填或空为删除群头衔
- duration int 专属头衔有效期, 单位秒, -1 表示永久, 不过此项似乎没有效果, 可能是只有某些特殊的时间长度有效, 有待测试
返回: void

`setGroupBan`

参数:
- group float 群号
- qq float 账号
- duration float 时长，单位秒默认1800，0为取消禁言
返回: void

`setGroupWholeBan`

参数:
- group float 群号
- enable bool 是否禁言，默认true
返回: void

`setGroupAnonymousBan`

参数:
- group float 群号
- anonymous object|array|null 可选, 要禁言的匿名用户对象（群消息上报的 anonymous 字段）
- flag ?string 可选, 要禁言的匿名用户的 flag（需从群消息上报的数据中获得）
- duration float 禁言时长, 单位秒, 无法取消匿名用户禁言
返回: void

`setEssenceMsg`

参数:
- message_id float 消息id
返回: void

`sendGroupSign`

参数:
- group float 群号
返回: void

`setGroupAnonymous`

参数:
- group float 群号
- enable bool 开关 true开false关，默认true
返回: void

`sendGroupNotice`

参数:
- group float 群号
- content string 公告内容
- image ?string 公告图片
返回: void

`getGroupNotice`

参数:
- group float 群号
返回: object

`setGroupKick`

参数:
- group float 群号
- qq float 账号
- reject_add_request bool 是否拒绝此人进群，默认false
返回: void

`setGroupLeave`

参数:
- group float 群号
- is_dismiss bool 是否解散(只在Bot是群主时候有用)，默认false
返回: void

⬆️ 返回顶部

handle 类

完整类名: Api\handle

📋 可用方法

方法导航: setFriendAddRequest | setGroupAddRequest

`setFriendAddRequest`

参数:
- flag string 好友请求的flag，从上报中获取
- approve bool 是否同意，默认同意
- remark ?string 添加好友后的备注，空为不备注
返回: void

`setGroupAddRequest`

参数:
- flag string|float 入群请求的flag，从上报中获取
- type string 入群请求的type，从上报中的sub_type获取，(add/invite);
- approve bool 是否同意，默认同意
- remark ?string 拒绝理由，只在拒绝的时候有效，可以为空
返回: void

⬆️ 返回顶部

image 类

完整类名: Api\image

📋 可用方法

方法导航: getImage | canSendImage | ocrImage

`getImage`

参数:
- file string 图片缓存文件名
返回: object

`canSendImage`

返回: object

`ocrImage`

参数:
- image string 图片id
返回: object

⬆️ 返回顶部

message 类

完整类名: Api\message

📋 可用方法

`sendPrivateMsg`

参数:
- qq float 账号
- group float 群号
- message string|array 消息内容
- auto_escape bool 发送内容是否是纯文本(不解析CQ码)
返回: object

`sendGroupMsg`

参数:
- group float 群号
- message string|array 消息内容
- auto_escape bool 发送内容是否是纯文本(不解析CQ码)
返回: object

`sendMsg`

参数:
- message_type string 类型(group/private)
- qq float 账号
- group float 群号
- message string|array 消息内容
- auto_escape bool 发送内容是否是纯文本(不解析CQ码)
返回: object

`sendMarkdownMsg`

参数:
- group float 群号
- message string|array 消息内容
- rows array 按钮组
- callback bool 是否回调
- auto_escape bool 发送内容是否是纯文本(不解析CQ码)
返回: object

`sendGreyTip`

参数:
- group float 群号
- content string tip内容
- message string 消息内容，必须携带消息发送
返回: object

`sendKeyboardMsg`

参数:
- group float 群号
- message string|array 消息内容
- auto_escape bool 发送内容是否是纯文本(不解析CQ码)
返回: object

`getMsg`

参数:
- message_id int 消息id
返回: object

`deleteMsg`

参数:
- message_id int 消息id
返回: void

`markMsgAsRead`

参数:
- message_id int 消息id
返回: void

`getForwardMsg`

参数:
- message_id int 消息id
返回: object

`sendForwardMsg`

参数:
- message object|array 消息内容
返回: object

`sendGroupForwardMsg`

参数:
- group float 群号
- message object|array 消息内容
返回: object

`sendPrivateForwardMsg`

参数:
- qq float 账号
- message object|array 消息内容
返回: object

`getGroupMsgHistory`

参数:
- message_seq float 起始消息序号，可以通过getMsg获取
- group float 群号
返回: object

`escape`

参数:
- str string
- escape bool 正反默认正
返回: ?string

`structureImage`

参数:
- file ?string 文件路径/Url
- type ?string 图片类型, flash 表示闪照, show 表示秀图, 默认普通图片
- subType ?int 图片子类型, 只出现在群聊. 0 正常图片，1 表情包, 在客户端会被分类到表情包图片并缩放显示，2 热图，3 斗图，4 智图?，7 贴图，8 自拍，9 贴图广告?，10 有待测试，13 热搜图, 14 ai表情。默认1，后改成14了
- url ?string 图片链接，与file相比，file优先
- cache int 只在通过网络 URL 发送时有效, 表示是否使用已缓存的文件, 默认 1
- width int 图片显示宽度默认 0 既自适应
- height int 图片显示高度默认 0 既自适应
- id int 发送秀图时的特效id, 默认为40000，有效id：40000-40005
- c int 通过网络下载图片时的线程数, 默认单线程. (在资源不支持并发时会自动处理)
- escape bool 是否用cq码输出，默认不是
返回: array|string

`structureVideo`

参数:
- file ?string 文件路径/Url
- cover ?string 视频封面, 支持http, file和base64发送, 格式必须为jpg
- c int 通过网络下载图片时的线程数, 默认单线程. (在资源不支持并发时会自动处理)
- escape bool 是否用cq码输出，默认不是
返回: array|string

`structureRecord`

参数:
- file ?string 文件路径/Url
- magic int 语音类型，0默认1变声;
- cache int 是否使用缓存，默认1使用，0不使用
- proxy int 只在通过网络 URL 发送时有效, 表示是否通过代理下载文件 ( 需通过环境变量或配置文件配置代理 ) , 默认 1
- timeout int 只在通过网络 URL 发送时有效, 单位秒, 表示下载网络文件的超时时间 , 默认不超时
- escape bool 是否用cq码输出，默认不是
返回: array|string

`structureFace`

参数:
- id int 表情id
- escape bool 是否用cq码输出，默认不是
返回: array|string

`structureMagic`

参数:
- id int 表情id
- type string 魔法表情类型，rps猜拳，dice骰子，shake串口抖动，默认猜拳
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureGift`

参数:
- qq float 账号
- id int 0 甜 Wink，1 快乐肥宅水，2 幸运手链，3 卡布奇诺，4 猫咪手表，5 绒绒手套，6 彩虹糖果，7 坚强，8 告白话筒，9 牵你的手，10 可爱猫咪，11 神秘面具，12 我超忙的，13 爱心口罩
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structurePoke`

参数:
- qq float 账号
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureShare`

参数:
- url string 链接
- title string 标题
- content string 简介
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureContact`

参数:
- type string qq为好友，group为群
- id float 标题
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureLocation`

参数:
- lat float 经度
- lon float 纬度
- title ?string 发送时可选, 标题
- content ?string 发送时可选, 内容描述
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureMusic`

参数:
- type string|int qq 163 xm 分别表示使用 QQ 音乐、网易云音乐、虾米音乐，custom 表示音乐自定义分享
- id string|int 歌曲id
- url ?string 自定义时点击跳转链接
- audio ?string 音乐链接
- title ?string 标题
- content ?string 发送时可选, 内容描述
- image ?string 图片链接
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureReply`

参数:
- id ?int 引用的消息id，如果有自定义，自定义优先
- text ?string 自定义消息内容
- qq ?float 自定义回复时的自定义QQ, 如果使用自定义信息必须指定.
- time ?float 时间戳
- seq ?float 起始消息序号, 可通过 get_msg 获得
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureNode`

参数:
- id ?string 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序与下面的自定义消息二选一
- name ?string 用于自定义消息 (自定义消息并合并转发, 实际查看顺序为自定义消息段顺序)
- uin ?float 用于自定义消息中的账号
- content string|array|null 用于自定义消息不支持转发，message消息组或者cq码
- seq ?float 起始消息序号, 可通过 get_msg 获得用于自定义消息
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureCard`

参数:
- data string 卡片内容
- resid ?int 可能为空, 或空字符串
- type string 类型，xml，json
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureTts`

参数:
- text string 消息内容
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureText`

参数:
- text string 消息内容
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureTextPro`

参数:
- text string 消息内容
- escape bool 是否用cq码输出，默认不是，魔法表情无法使用cq码
返回: array|string

`structureAt`

参数:
- qq float 账号
- name string 当在群中找不到此QQ号的名称时才会生效
- escape bool 是否用cq码输出，默认不是。
返回: array|string

`structureJson`

参数:
- data string json内容, json的所有字符串记得实体化处理
- escape bool 是否用cq码输出，默认不是。
返回: array|string

`structureMarkdown`

参数:
- data string json内容, json的所有字符串记得实体化处理
- escape bool 是否用cq码输出，默认不是。
返回: array|string

`structureLongMsg`

参数:
- id string|float 消息id
- escape bool 是否用cq码输出，默认不是。
返回: array|string

`structureKeyboard`

参数:
- rows array rows内容，参考 https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/trans/msg-btn.html
- escape bool 是否用cq码输出，默认不是。
返回: array|string

`structureGreyTip`

参数:
- content string 内容
- escape bool 是否用cq码输出，默认不是。
返回: array|string

⬆️ 返回顶部

record 类

完整类名: Api\record

📋 可用方法

方法导航: getRecord | canSendRecord

`getRecord`

参数:
- file string 文件名
- out_format string 要转换到的格式, 目前支持 mp3、amr、wma、m4a、spx、ogg、wav、flac
返回: object

`canSendRecord`

返回: object

⬆️ 返回顶部

uin 类

完整类名: Api\uin

📋 可用方法

方法导航: __construct | get | set | data

`__construct`

`get`

`set`

`data`

⬆️ 返回顶部

BaseApp 类

完整类名: App\BaseApp

插件统一基础类优化Redis连接、初始化逻辑及性能

📋 可用方法

`__construct`

构造函数：统一初始化所有基础资源

参数:
- app mixed 业务应用实例（兼容原app类参数）

`comparePermission`

权限比较：判断用户权限是否满足要求

参数:
- userPerm string|int 用户当前权限
- requiredPerm string|int 所需权限
返回: bool 满足返回true，否则false

`permissionToNum`

权限名称转数字（统一格式）

参数:
- perm string|int 权限（名称/数字）
返回: int 权限数字（默认1：普通用户）

`permissionToName`

权限数字转名称（统一格式）

参数:
- perm string|int 权限（数字/名称）
返回: string 权限名称（默认'default'）

`getUserPermission`

获取用户权限（从Redis缓存读取）

参数:
- userQQ float 用户QQ
返回: string|int 权限（名称/数字）

`__get`

`getGroupInfo`

获取群信息（优化版：避免递归，支持插件）

参数:
- group float 群号
返回: object|bool 群信息（失败返回false）

`groupStatus`

检测群状态：开启返回true，关闭返回false

参数:
- group float 群号
返回: bool 群状态

`initGroupInfo`

初始化群信息（兼容旧数据）

参数:
- group float 群号
- isArray bool 是否返回数组
返回: object|array|bool 群信息

`updateGroupInfo`

更新群信息

参数:
- group float 群号
- info object|array 新群信息
返回: bool 更新结果

`scanWorkerList`

扫描Worker列表（对接Router的自动扫描逻辑）

返回: array Worker类名列表

⬆️ 返回顶部

Cache 类

完整类名: Utils\Cache

缓存工具类：区分静态核心属性与动态缓存，支持过期、过滤、并发安全

📋 可用方法

`get` `(static)`

获取缓存/静态属性值

参数:
- name string 缓存名/静态属性名（前缀"?"表示仅判断是否存在）
- default mixed 默认值（缓存不存在时返回）
- filter string|array 过滤函数（多个用逗号分隔或传数组）
返回: mixed 结果（判断存在时返回bool，否则返回处理后的值）

`set` `(static)`

设置缓存/静态属性值

参数:
- name string 缓存名/静态属性名
- value mixed 值
- expire int 动态缓存过期时间（秒，0=永久，仅对动态缓存有效）

`del` `(static)`

删除缓存/重置静态属性

`getBatch` `(static)`

批量获取动态缓存

参数:
- names array 缓存名列表
- default mixed 默认值
返回: array 键值对结果

`setBatch` `(static)`

批量设置动态缓存

参数:
- data array 键值对数组（key=缓存名，value=值）
- expire int 过期时间（秒，0=永久）

`__callStatic` `(static)`

魔术方法：禁止静态调用动态缓存（避免语义混淆）

参数:
- method string 方法名
- args array 参数

⬆️ 返回顶部

CommandParser 类

完整类名: Utils\CommandParser

📋 可用方法

方法导航: getInstance | command | option | getHelp | parse

`getInstance` `(static)`

`command`

新增：注册命令描述（用于生成帮助）

参数:
- desc string 命令功能描述
返回: $this

`option`

新增：注册参数规则（核心方法，类似yargs.option）

参数:
- name string 参数名（短选项用单字符，长选项用多字符，如 'n' 或 'name'）
- rule array 规则配置，支持：
返回: $this

`getHelp`

新增：生成帮助信息（类似yargs --help）

返回: string

`parse`

原解析方法：新增「规则校验」和「默认值填充」

⬆️ 返回顶部

CoroutineCurl 类

完整类名: Utils\CoroutineCurl

📋 可用方法

`__construct`

`init` `(static)`

`location`

`addHeaders`

`setHeaders`

`get`

`post`

`request`

`accept`

`timeout`

`encode`

`proxy`

`json`

`object`

`string`

返回: string

`__toString`

返回: string

⬆️ 返回顶部

Env 类

完整类名: Utils\Env

配置工具类：支持INI文件解析、内存缓存、多维配置读取，仅首次读取文件

📋 可用方法

方法导航: get | refreshCache | getAll | Config

`get` `(static)`

获取配置值（优先读内存缓存，未初始化则读取文件并缓存）

参数:
- key string 配置键（支持多维，如"Redis.host"）
- default mixed 默认值（配置不存在时返回）
返回: mixed 配置值

`refreshCache` `(static)`

手动刷新配置缓存（强制重新读取文件，用于动态更新配置）

返回: bool 刷新结果

`getAll` `(static)`

获取全部配置（仅调试/特殊场景使用，避免暴露敏感配置）

返回: array 全部配置数组

`Config` `(static)`

兼容原Config方法（保持向下兼容）

参数:
- key string 配置键
- default mixed 默认值
返回: mixed 配置值

⬆️ 返回顶部

Logger 类

完整类名: Utils\Logger

📋 可用方法

`init` `(static)`

`configure` `(static)`

初始化配置

`message` `(static)`

静态日志方法

`success` `(static)`

`error` `(static)`

`info` `(static)`

`warning` `(static)`

`debug` `(static)`

`tput` `(static)`

`enableConsole` `(static)`

开关控制

`enableFile` `(static)`

⬆️ 返回顶部

Markdown 类

完整类名: Utils\Markdown

📋 可用方法

`__construct`

`render`

参数:
- label string 按钮显示文本
- visited string 按钮按下后显示文本，默认同$label
- style int 主题颜色 0灰色 1蓝色默认0
返回: void

`action`

参数:
- type int 按钮类型设置 0 跳转按钮：http 或小程序客户端识别 scheme，设置 1 回调按钮：回调后台接口, data 传给后台，设置 2 指令按钮：自动在输入框插入 @bot data
- data string 操作相关的数据
- reply bool 按钮按下后是否使用回复消息，默认否
- enter bool 按钮按下后是否发送，默认否
- tips string 客户端不支持本action的时候，弹出的toast文案
返回: void

`id`

参数:
- id ?string 按钮id，默认为uniqid()
返回: void

`permission`

参数:
- type int 0 指定用户可操作，1 仅管理者可操作，2 所有人可操作，3 指定身份组可操作（仅频道可用）
- user float|array 有权限的用户 id 的列表
返回: void

`next`

返回: void

`prev`

返回: void

`current`

返回: array

`buttons`

返回: void

`url`

参数:
- title ?string 链接名
- url string 链接
返回: bool

`Image`

参数:
- title ?string 链接名
- url string 链接
返回: bool

`markdown`

参数:
- markdown string markdown语法的str
返回: void

`at`

`Face`

`add`

参数:
- markdown string markdown语法的str
返回: void

`cleanMarkdown`

返回: void

`cleanButton`

返回: void

`clean`

返回: void

`get`

参数:
- key string
返回: mixed

`send`

参数:
- callback bool 是否回调，默认否
返回: array|Object

`bind`

参数:
- qq float|string
返回: void

`escape`

参数:
- str string
- escape bool 正反默认正
返回: ?string

⬆️ 返回顶部

Operate 类

完整类名: Utils\Operate

📋 可用方法

`get` `(static)`

获取文件内容

参数:
- file String 文件绝对路径
- isJson Bool 如果是读取JSON文件写true，可自动格式化为JSONObject
返回: Bool|String|JSONObject|Array

`set` `(static)`

写入文件

参数:
- file String 文件绝对路径
- write String 写入内容
返回: Bool|int

`dir` `(static)`

检测文件夹是否存在不存在就创建

参数:
- dir String 文件夹绝对路径
返回: Bool

`read_all` `(static)`

读取文件夹内某些文件

参数:
- dir String 文件夹绝对路径
返回: Array

`readAll` `(static)`

读取文件夹内某些文件

参数:
- dir String 文件夹绝对路径
返回: Array

`read_all_dir` `(static)`

获取文件夹内所有子文件

参数:
- dir String 文件夹绝对路径
返回: Array

`read_all_dir_list` `(static)`

获取文件夹内所有子文件

参数:
- dir String 文件夹绝对路径
返回: Array

`readAllDir` `(static)`

获取文件夹内所有子文件

参数:
- dir String 文件夹绝对路径
返回: Array

`readFile` `(static)`

`unzip` `(static)`

解压缩

参数:
- zipName string 压缩包名称绝对路径
- dest string 解压到指定目录绝对路径
返回: boolean true|false

`xCopy` `(static)`

copy 文件夹

参数:
- child int 类型 1包括子目录 0不包括子目录
返回: Bool

`delDir` `(static)`

删除目录

参数:
- path string
返回: bool

`del_dir` `(static)`

删除目录

参数:
- path string
返回: bool

`delfile` `(static)`

删除过期文件

返回: Bool

`del_file` `(static)`

删除过期文件

返回: Bool

⬆️ 返回顶部

Yargs 类

完整类名: Utils\Yargs

📋 可用方法

`getInstance` `(static)`

`command`

注册命令描述（支持子命令）

`option`

注册选项参数规则

`positional`

注册位置参数规则

`getHelp`

生成帮助信息

`parse`

解析入口

⬆️ 返回顶部

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
src		src
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json

License

areCodeOI/test

Folders and files

Latest commit

History

Repository files navigation

文档

一些代码示例

配置示例

📁 目录索引

ai 类

📋 可用方法

getAiCharacter

getAiRecord

sendGroupAiRecord

app 类

📋 可用方法

__construct

bot 类

📋 可用方法

init (static)

getLoginInfo

setQQProfile

getModelShow

setModelShow

getOnlineClients

cqHttp 类

📋 可用方法

getCookies

getClientKey

getSkey

getCsrfToken

getCredentials

getVersionInfo

getStatus

setRestart

reloadEventFilter

downloadFilter

checkUrlSafely

cleanCache

file 类

📋 可用方法

uploadPrivateFile

uploadGroupFile

deleteGroupFile

createGroupFileFolder

deleteGroupFolder

getGroupFileSystemInfo

getGroupRootFiles

getGroupRootFilesByFolder

getGroupFileUrl

friend 类

📋 可用方法

getStrangerInfo

getFriendList

getUnidirectionalFriendList

deleteFriend

deleteUnidirectionalFriend

groupInfo 类

📋 可用方法

getGroupInfo

getGroupList

getGroupMemberInfo

getGroupMemberList

getGroupHonorInfo

getGroupSystemMsg

getEssenceMsgList

getGroupAtAllRemain

groupSetup 类

📋 可用方法

setGroupName

setGroupPortrait

setGroupAdmin

setGroupCard

setGroupSpecialTitle

setGroupBan

setGroupWholeBan

setGroupAnonymousBan

setEssenceMsg

sendGroupSign

`getAiCharacter`

`getAiRecord`

`sendGroupAiRecord`

`__construct`

`init` `(static)`

`getLoginInfo`

`setQQProfile`

`getModelShow`

`setModelShow`

`getOnlineClients`

`getCookies`

`getClientKey`

`getSkey`

`getCsrfToken`

`getCredentials`

`getVersionInfo`

`getStatus`

`setRestart`

`reloadEventFilter`

`downloadFilter`

`checkUrlSafely`

`cleanCache`

`uploadPrivateFile`

`uploadGroupFile`

`deleteGroupFile`

`createGroupFileFolder`

`deleteGroupFolder`

`getGroupFileSystemInfo`

`getGroupRootFiles`

`getGroupRootFilesByFolder`

`getGroupFileUrl`

`getStrangerInfo`

`getFriendList`

`getUnidirectionalFriendList`

`deleteFriend`

`deleteUnidirectionalFriend`

`getGroupInfo`

`getGroupList`

`getGroupMemberInfo`

`getGroupMemberList`

`getGroupHonorInfo`

`getGroupSystemMsg`

`getEssenceMsgList`

`getGroupAtAllRemain`

`setGroupName`

`setGroupPortrait`

`setGroupAdmin`

`setGroupCard`

`setGroupSpecialTitle`

`setGroupBan`

`setGroupWholeBan`

`setGroupAnonymousBan`

`setEssenceMsg`

`sendGroupSign`

`setGroupAnonymous`

`sendGroupNotice`

`getGroupNotice`

`setGroupKick`

`setGroupLeave`

`setFriendAddRequest`

`setGroupAddRequest`

`getImage`

`canSendImage`

`ocrImage`

`sendPrivateMsg`

`sendGroupMsg`

`sendMsg`

`sendMarkdownMsg`

`sendGreyTip`

`sendKeyboardMsg`

`getMsg`

`deleteMsg`

`markMsgAsRead`

`getForwardMsg`

`sendForwardMsg`

`sendGroupForwardMsg`

`sendPrivateForwardMsg`

`getGroupMsgHistory`

`escape`

`structureImage`