mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-03-18 21:24:52 +08:00

jerry 6155236d3c update to v2.4.0 (build 399)

add CheckConfigCommand.php
add config update record docs
adjust swoole version to 4.5.0
fix stop and reload bugs
add $_running_annotation
add remote terminal
update global config
add timer tick exception handler
add zm_xxx global functions
add isAtMe(), splitCommand(), matchCommand() function for MessageUtil
add workerAction(), sendActionToWorker(), resumeAllWorkerCoroutines() functions for ProcessManager
optimize CQCommand match function
add custom TerminalCommand annotation
add TuringAPI
add getReloadableFiles() function for ZMUtil

2021-03-24 23:34:46 +08:00

3.0 KiB

Raw Blame History

MessageUtil 消息处理工具类

类定义：\ZM\Utils\MessageUtil

2.3.0 版本起可用。

这里放置一些机器人聊天消息处理的便捷静态方法，例如下载图片等。

方法

downloadCQImage()

下载用户消息中所带的所有图片，并返回文件路径。

定义：downloadCQImage($msg, $path = null)

参数 $msg 为带图片的用户消息，例如 你好啊！\n[CQ:image,file=a.jpg,url=https://zhamao.xin/file/hello.jpg]

参数 $path 为图片下载的路径，如果不填（默认 null）则指定为 zm_data/images/ 目录，且不存在会自动创建。

$r = MessageUtil::downloadCQImage("你好啊！\n[CQ:image,file=a.jpg,url=https://zhamao.xin/file/hello.jpg]");
/*
$r == [
    "/path-to/zhamao-framework/zm_data/images/a.jpg"
];
*/

如果返回的是空数组 [ ]，则表明消息中没有图片。如果返回的是 false，则表明其中至少一张下载失败或路径有误。

containsImage()

检查消息中是否含有图片。

定义：containsImage($msg)

返回：bool，你懂的，true 就是有，false 就没有。

MessageUtil::containsImage("[CQ:image,file=a.jpg,url=http://xxx]"); // true
MessageUtil::containsImage("[CQ:face,id=140] 咦，这是一条带表情的消息"); // false

getImageCQFromLocal()

通过文件路径获取图片的发送 CQ 码。

定义：getImageCQFromLocal($file, $type = 0)

参数 $file 为图片的绝对路径。

返回：图片的 CQ 码，如 [CQ:image,file=xxxxx]

参数 $type：

0：以 base64 的方式发送图片，返回结果如 [CQ:image,file=base64://xxxxxx]
1：以 file:// 本地文件的方式发送图片，返回结果如 [CQ:image,file=file:///path-to/images/a.jpg]
2：返回图片的 http:// CQ 码（默认为 /images/ 路径就是文件对应所在的目录），如 [CQ:image,file=http://127.0.0.1:20001/images/a.jpg]

splitCommand()

切割用户消息为数组形式（@CQCommand 就是使用此方式切割的）

定义：splitCommand($msg): array

返回：数组，切分后的。

!!! tip "为什么不直接使用 explode 呢"

因为 `explode()` 只会简单粗暴的切割字符串，假设用户输入的消息中两个词中间有多个空格，则会有空的词出现。例如 `你好     我是一个长空格`。此函数会将多个空格当作一个空格来对待。

MessageUtil::splitCommand("你好 我是傻瓜\n我是傻瓜二号"); // ["你好","我是傻瓜","我是傻瓜二号"]
MessageUtil::splitCommand("我有   三个空格"); // ["我有","三个空格"]

matchCommand()

匹配一条消息到 @CQCommand 规则的注解事件，返回要执行的类和函数位置。

定义：matchCommand($msg, $obj)

参数 $msg 为消息内容。

参数 $obj 为事件的对象，可使用 ctx()->getData() 获取原先的事件体（仅限 OneBot 消息类型事件中使用）

返回：\ZM\Entity\MatchObject 对象，含有匹配成功与否，匹配到的注解对象，匹配到的分割词等，见 []

3.0 KiB Raw Blame History Unescape Escape