diff --git a/docs/event/bot.md b/docs/event/bot.md index ab48a1dd..d82489fd 100644 --- a/docs/event/bot.md +++ b/docs/event/bot.md @@ -12,49 +12,49 @@ 啊？ -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| action | string | 动作名称 | “” | -| need_response | string | 动作是否需要响应 | false | -| level | int | 事件优先级（越大越先执行） | 20 | +| 参数名称 | 允许值 | 用途 | 默认 | +|---------------|--------|---------------|-------| +| action | string | 动作名称 | “” | +| need_response | string | 动作是否需要响应 | false | +| level | int | 事件优先级（越大越先执行） | 20 | ## BotActionResponse 啊？？ -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| retcode | int | 响应码 | null | -| level | int | 事件优先级（越大越先执行） | 20 | +| 参数名称 | 允许值 | 用途 | 默认 | +|---------|-----|---------------|------| +| retcode | int | 响应码 | null | +| level | int | 事件优先级（越大越先执行） | 20 | ## BotEvent 用于处理所有的机器人事件，具体的参数含义可以参见 [https://12.onebot.dev/connect/data-protocol/event/](https://12.onebot.dev/connect/data-protocol/event/)。 -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| type | string | 对应标准中的事件类型 | null | -| detail_type | string | 对应标准中的事件详细类型 | null | -| sub_type | string | 对应标准中的事件子类型 | null | -| level | int | 事件优先级（越大越先执行） | 20 | +| 参数名称 | 允许值 | 用途 | 默认 | +|-------------|--------|---------------|------| +| type | string | 对应标准中的事件类型 | null | +| detail_type | string | 对应标准中的事件详细类型 | null | +| sub_type | string | 对应标准中的事件子类型 | null | +| level | int | 事件优先级（越大越先执行） | 20 | ## BotCommand 对于 `BotEvent` 的封装，用于支持常用的命令式调用（如：”天气 深圳”）。 -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| name | string | 命令名称，应全局唯一 | “” | -| match | string | 匹配第一个词的命令式消息，如 天气 北京 中的 天气 | “” | -| pattern | string | 根据 * 号通配符进行模式匹配用户消息，如 查询*天气 | “” | -| regex | string 合法的正则表达式 | 匹配正则表达式匹配到的用户消息 | “” | -| start_with | string | 匹配消息开头相匹配的消息，如 我叫炸毛，这里写 我叫 | “” | -| end_with | string | 匹配消息结尾相匹配的消息，以 start_with 类推 | “” | -| keyword | string | 匹配消息中有相关关键词的消息 | “” | -| alias | string | match 匹配到命令的别名，数组形式 | [] | -| detail_type | string | 限定消息事件的详细类型，见 BotEvent | “” | -| prefix | string | | | -| level | int | 事件优先级（越大越先执行） | 20 | +| 参数名称 | 允许值 | 用途 | 默认 | +|-------------|-----------------|------------------------------|-----| +| name | string | 命令名称，应全局唯一 | “” | +| match | string | 匹配第一个词的命令式消息，如 天气 北京 中的 天气 | “” | +| pattern | string | 根据 * 号通配符进行模式匹配用户消息，如 查询*天气 | “” | +| regex | string 合法的正则表达式 | 匹配正则表达式匹配到的用户消息 | “” | +| start_with | string | 匹配消息开头相匹配的消息，如 我叫炸毛，这里写 我叫 | “” | +| end_with | string | 匹配消息结尾相匹配的消息，以 start_with 类推 | “” | +| keyword | string | 匹配消息中有相关关键词的消息 | “” | +| alias | string | match 匹配到命令的别名，数组形式 | [] | +| detail_type | string | 限定消息事件的详细类型，见 BotEvent | “” | +| prefix | string | | | +| level | int | 事件优先级（越大越先执行） | 20 | > 机器人命令注册的实例可参见【一堆例子链接】 > @@ -63,24 +63,23 @@ 与 BotCommand 搭配使用，可以自动识别参数及生成帮助。 -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| name | string | 参数名称 | “” | -| description | string | 参数描述 | “” | -| required | bool | 参数是否必需 | false | -| prompt | string | 当参数缺失时请求用户输入时提示的消息（需要参数设为必需） | “请输入{$name}” | -| default | mixed | 当参数非必需且未填入时的默认值 | null | -| timeout | int 单位秒 | 请求输入超时时间 | 60 | +| 参数名称 | 允许值 | 用途 | 默认 | +|-------------|---------|------------------------------|--------------| +| name | string | 参数名称 | “” | +| description | string | 参数描述 | “” | +| required | bool | 参数是否必需 | false | +| prompt | string | 当参数缺失时请求用户输入时提示的消息（需要参数设为必需） | “请输入{$name}” | +| default | mixed | 当参数非必需且未填入时的默认值 | null | +| timeout | int 单位秒 | 请求输入超时时间 | 60 | ## CommandHelp 与 BotCommand 搭配使用，可以补充生成的帮助信息。 -| 参数名称 | 允许值 | 用途 | 默认 | -| --- | --- | --- | --- | -| description | string | 命令描述 | “” | -| usage | string | 命令用法 | “” | -| example | string | 命令示例 | “” | +| 参数名称 | 允许值 | 用途 | 默认 | +|-------------|--------|------|-----| +| description | string | 命令描述 | “” | +| usage | string | 命令用法 | “” | +| example | string | 命令示例 | “” | > 关于自动帮助生成的更多信息，请参见 【这里链接】 -> diff --git a/docs/guide/get-started.md b/docs/guide/get-started.md index 2c875717..8aba89b7 100644 --- a/docs/guide/get-started.md +++ b/docs/guide/get-started.md @@ -7,7 +7,7 @@ 其中一些可用的选项为： - Walle-Q（QQ 端） -- 更多… +- onebots（QQ 端） ## 机器人实现端 diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 411d3fdf..8b9760c6 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -31,8 +31,6 @@ bash <(curl -fsSL https://zhamao.xin/v3.sh) 如果你已经有了必要的 PHP 环境和 Composer 工具，你可以直接在任意目录下初始化框架。 -> 由于目前 3.0 仍处于预发布阶段，请使用 `composer require zhamao/framework:^3` 来安装 - ```shell # 在当前目录初始化框架 composer require zhamao/framework diff --git a/docs/update/v3.md b/docs/update/v3.md index 485a978b..5259e5a1 100644 --- a/docs/update/v3.md +++ b/docs/update/v3.md @@ -2,6 +2,21 @@ > 本页面由框架命令 `./zhamao generate:text update-log-md` 自动生成 +## v3.0.0 + +> 更新时间：2023-02-10 + +* 添加容器缓存配置 by [@sunxyw](https://github.com/sunxyw) in [PR#279](https://github.com/zhamao-robot/zhamao-framework/pull/279) +* 本次更新包含文档更新内容 1 个 +* 修复 Pipeline 回调参数缺失 by [@sunxyw](https://github.com/sunxyw) in [PR#281](https://github.com/zhamao-robot/zhamao-framework/pull/281) +* 修复中间件传参解析冲突 by [@sunxyw](https://github.com/sunxyw) in [PR#282](https://github.com/zhamao-robot/zhamao-framework/pull/282) +* 修复不兼容 onebots 端的问题 by [@crazywhalecc](https://github.com/crazywhalecc) in [PR#284](https://github.com/zhamao-robot/zhamao-framework/pull/284) +* 新增计时器 by [@crazywhalecc](https://github.com/crazywhalecc) in [PR#283](https://github.com/zhamao-robot/zhamao-framework/pull/283) +* 准备发布 3.0 的一些小修 by [@crazywhalecc](https://github.com/crazywhalecc) in [PR#285](https://github.com/zhamao-robot/zhamao-framework/pull/285) +* 修复排程任务 Swoole 死锁 by [@sunxyw](https://github.com/sunxyw) in [PR#286](https://github.com/zhamao-robot/zhamao-framework/pull/286) + +**源码变更记录**: + ## v3.0.0-beta7 > 更新时间：2023-02-04