diff --git a/bin/gendoc b/bin/gendoc index b2c05312..2b5505db 100755 --- a/bin/gendoc +++ b/bin/gendoc @@ -5,7 +5,6 @@ * 决定是否忽略该类 * * @param ReflectionClass $class 准备生成的类的反射类 - * @return bool */ function should_ignore_class(ReflectionClass $class): bool { @@ -70,7 +69,7 @@ if (file_exists($root . '/vendor/jasny/phpdoc-parser/composer.json')) { foreach ($composers as $composer) { if (check_composer_executable($composer)) { echo '正在使用 ' . $composer . ' 安装 PHPDoc 解析库,请稍候...' . PHP_EOL; - passthru("$composer require --quiet jasny/phpdoc-parser", $exit_code); + passthru("{$composer} require --quiet jasny/phpdoc-parser", $exit_code); if ($exit_code === 0) { $phpdoc_package_temp_installed = true; break; @@ -231,7 +230,7 @@ function get_class_metas(string $class_name, PhpdocParser $parser): array * 将方法的元数据转换为 Markdown 格式 * * @param string $method 方法名 - * @param array $meta 元数据 + * @param array $meta 元数据 */ function convert_meta_to_markdown(string $method, array $meta): string { @@ -264,6 +263,7 @@ function convert_meta_to_markdown(string $method, array $meta): string foreach ($meta['params'] as $param_name => $param_meta) { $markdown .= '| ' . $param_name . ' | ' . $param_meta['type'] . ' | ' . $param_meta['description'] . ' |' . "\n"; } + $markdown .= "\n"; } // 返回值 diff --git a/docs/api/ZM/API/CQ.md b/docs/api/ZM/API/CQ.md index d90e6e90..3859cd98 100644 --- a/docs/api/ZM/API/CQ.md +++ b/docs/api/ZM/API/CQ.md @@ -3,7 +3,7 @@ ## at ```php -public function at(mixed $qq): string +public function at(int|string $qq): string ``` ### 描述 @@ -14,18 +14,19 @@ at一下QQ用户(仅在QQ群支持at全体) | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| qq | mixed | | +| qq | int|string | 用户QQ号/ID号 | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## face ```php -public function face(mixed $id): string +public function face(int|string $id): string ``` ### 描述 @@ -36,18 +37,19 @@ public function face(mixed $id): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | mixed | | +| id | int|string | 表情ID | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## image ```php -public function image(mixed $file, bool $cache, bool $flash, bool $proxy, int $timeout): string +public function image(string $file, bool $cache, bool $flash, bool $proxy, int $timeout): string ``` ### 描述 @@ -58,22 +60,23 @@ public function image(mixed $file, bool $cache, bool $flash, bool $proxy, int $t | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | -| cache | bool | | -| flash | bool | | -| proxy | bool | | -| timeout | int | | +| file | string | 文件的路径、URL或者base64编码的图片数据 | +| cache | bool | 是否缓存(默认为true) | +| flash | bool | 是否闪照(默认为false) | +| proxy | bool | 是否使用代理(默认为true) | +| timeout | int | 超时时间(默认不超时) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## record ```php -public function record(mixed $file, bool $magic, bool $cache, bool $proxy, int $timeout): string +public function record(string $file, bool $magic, bool $cache, bool $proxy, int $timeout): string ``` ### 描述 @@ -84,22 +87,23 @@ public function record(mixed $file, bool $magic, bool $cache, bool $proxy, int $ | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | -| magic | bool | | -| cache | bool | | -| proxy | bool | | -| timeout | int | | +| file | string | 文件的路径、URL或者base64编码的语音数据 | +| magic | bool | 是否加特技(默认为false) | +| cache | bool | 是否缓存(默认为true) | +| proxy | bool | 是否使用代理(默认为true) | +| timeout | int | 超时时间(默认不超时) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## video ```php -public function video(mixed $file, bool $cache, bool $proxy, int $timeout): string +public function video(string $file, bool $cache, bool $proxy, int $timeout): string ``` ### 描述 @@ -110,15 +114,16 @@ public function video(mixed $file, bool $cache, bool $proxy, int $timeout): stri | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | -| cache | bool | | -| proxy | bool | | -| timeout | int | | +| file | string | 文件的路径、URL或者base64编码的短视频数据 | +| cache | bool | 是否缓存(默认为true) | +| proxy | bool | 是否使用代理(默认为true) | +| timeout | int | 超时时间(默认不超时) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## rps @@ -135,7 +140,7 @@ public function rps(): string | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## dice @@ -152,7 +157,7 @@ public function dice(): string | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## shake @@ -169,13 +174,13 @@ public function shake(): string | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## poke ```php -public function poke(mixed $type, mixed $id, string $name): string +public function poke(int|string $type, int|string $id, string $name): string ``` ### 描述 @@ -186,14 +191,15 @@ public function poke(mixed $type, mixed $id, string $name): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| type | mixed | | -| id | mixed | | -| name | string | | +| type | int|string | 焯一戳类型 | +| id | int|string | 戳一戳ID号 | +| name | string | 戳一戳名称(可选) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## anonymous @@ -210,18 +216,19 @@ public function anonymous(int $ignore): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| ignore | int | | +| ignore | int | 是否忽略错误(默认为1,0表示不忽略错误) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## share ```php -public function share(mixed $url, mixed $title, null $content, null $image): string +public function share(string $url, string $title, null|string $content, null|string $image): string ``` ### 描述 @@ -232,21 +239,22 @@ public function share(mixed $url, mixed $title, null $content, null $image): str | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| url | mixed | | -| title | mixed | | -| content | null | | -| image | null | | +| url | string | 分享地址 | +| title | string | 标题 | +| content | null|string | 卡片内容(可选) | +| image | null|string | 卡片图片(可选) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## contact ```php -public function contact(mixed $type, mixed $id): string +public function contact(string $type, int|string $id): string ``` ### 描述 @@ -257,19 +265,20 @@ public function contact(mixed $type, mixed $id): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| type | mixed | | -| id | mixed | | +| type | string | 名片类型 | +| id | int|string | 好友或群ID | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## location ```php -public function location(mixed $lat, mixed $lon, string $title, string $content): string +public function location(float|string $lat, float|string $lon, string $title, string $content): string ``` ### 描述 @@ -280,56 +289,173 @@ public function location(mixed $lat, mixed $lon, string $title, string $content) | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| lat | mixed | | -| lon | mixed | | -| title | string | | -| content | string | | +| lat | float|string | 纬度 | +| lon | float|string | 经度 | +| title | string | 标题(可选) | +| content | string | 卡片内容(可选) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | ## music ```php -public function music(mixed $type, mixed $id_or_url, null $audio, null $title, null $content, null $image): string +public function music(string $type, int|string $id_or_url, null|string $audio, null|string $title, null|string $content, null|string $image): string ``` ### 描述 发送音乐分享(只能在单条回复中单独使用) qq、163、xiami为内置分享,需要先通过搜索功能获取id后使用 -custom为自定义分享 -当为自定义分享时: -$id_or_url 为音乐卡片点进去打开的链接(一般是音乐介绍界面啦什么的) -$audio 为音乐(如mp3文件)的HTTP链接地址(不可为空) -$title 为音乐卡片的标题,建议12字以内(不可为空) -$content 为音乐卡片的简介(可忽略) -$image 为音乐卡片的图片链接地址(可忽略) ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| type | mixed | | -| id_or_url | mixed | | -| audio | null | | -| title | null | | -| content | null | | -| image | null | | +| type | string | 分享类型(仅限 `qq`、`163`、`xiami` 或 `custom`) | +| id_or_url | int|string | 当分享类型不是 `custom` 时,表示的是分享音乐的ID(需要先通过搜索功能获取id后使用),反之表示的是音乐卡片点入的链接 | +| audio | null|string | 当分享类型是 `custom` 时,表示为音乐(如mp3文件)的HTTP链接地址(不可为空) | +| title | null|string | 当分享类型是 `custom` 时,表示为音乐卡片的标题,建议12字以内(不可为空) | +| content | null|string | 当分享类型是 `custom` 时,表示为音乐卡片的简介(可忽略) | +| image | null|string | 当分享类型是 `custom` 时,表示为音乐卡片的图片链接地址(可忽略) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | CQ码 | + + +## forward + +```php +public function forward(int|string $id): string +``` + +### 描述 + +合并转发消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| id | int|string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | CQ码 | + + +## node + +```php +public function node(int|string $user_id, string $nickname, string $content): string +``` + +### 描述 + +合并转发消息节点 +特殊说明: 需要使用单独的API /send_group_forward_msg 发送, 并且由于消息段较为复杂, 仅支持Array形式入参。 +如果引用消息和自定义消息同时出现, 实际查看顺序将取消息段顺序。 +另外按 CQHTTP 文档说明, data 应全为字符串, 但由于需要接收message 类型的消息, 所以 仅限此Type的content字段 支持Array套娃 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| user_id | int|string | 转发消息id | +| nickname | string | 发送者显示名字 | +| content | string | 具体消息 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | CQ码 | + + +## xml + +```php +public function xml(string $data): string +``` + +### 描述 + +XML消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | string | xml内容, xml中的value部分 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | CQ码 | + + +## json + +```php +public function json(string $data, int $resid): string +``` + +### 描述 + +JSON消息 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | string | json内容 | +| resid | int | 0为走小程序通道,其他值为富文本通道(默认为0) | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | CQ码 | + + +## _custom + +```php +public function _custom(string $type_name, array $params): string +``` + +### 描述 + +返回一个自定义扩展的CQ码(支持自定义类型和参数) + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| type_name | string | CQ码类型名称 | +| params | array | 参数 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | CQ码 | ## decode ```php -public function decode(mixed $msg, mixed $is_content): mixed +public function decode(string $msg, bool $is_content): string ``` ### 描述 @@ -340,19 +466,43 @@ public function decode(mixed $msg, mixed $is_content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| is_content | mixed | | +| msg | string | 字符串 | +| is_content | bool | 如果是解码CQ码本体内容,则为false(默认),如果是参数内的字符串,则为true | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| string | 转义后的CQ码 | + + +## replace + +```php +public function replace(string $str): string +``` + +### 描述 + +简单反转义替换CQ码的方括号 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| str | string | 字符串 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | 字符串 | ## escape ```php -public function escape(mixed $msg, mixed $is_content): mixed +public function escape(string $msg, bool $is_content): string ``` ### 描述 @@ -363,19 +513,20 @@ public function escape(mixed $msg, mixed $is_content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| is_content | mixed | | +| msg | string | 字符串 | +| is_content | bool | 如果是转义CQ码本体内容,则为false(默认),如果是参数内的字符串,则为true | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| string | 转义后的CQ码 | ## encode ```php -public function encode(mixed $msg, mixed $is_content): mixed +public function encode(string $msg, bool $is_content): string ``` ### 描述 @@ -386,19 +537,20 @@ public function encode(mixed $msg, mixed $is_content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| is_content | mixed | | +| msg | string | 字符串 | +| is_content | bool | 如果是转义CQ码本体内容,则为false(默认),如果是参数内的字符串,则为true | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| string | 转义后的CQ码 | ## removeCQ ```php -public function removeCQ(mixed $msg): string +public function removeCQ(string $msg): string ``` ### 描述 @@ -409,18 +561,19 @@ public function removeCQ(mixed $msg): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | +| msg | string | 消息 | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | 消息内容 | ## getCQ ```php -public function getCQ(mixed $msg, mixed $is_object): mixed +public function getCQ(string $msg, bool $is_object): array|CQObject ``` ### 描述 @@ -431,19 +584,20 @@ public function getCQ(mixed $msg, mixed $is_object): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| is_object | mixed | | +| msg | string | 消息内容 | +| is_object | bool | 是否以对象形式返回,如果为False的话,返回数组形式(默认为false) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| array|CQObject | 返回的CQ码(数组或对象) | ## getAllCQ ```php -public function getAllCQ(mixed $msg, mixed $is_object): mixed +public function getAllCQ(string $msg, bool $is_object): array|CQObject[] ``` ### 描述 @@ -454,10 +608,11 @@ public function getAllCQ(mixed $msg, mixed $is_object): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| is_object | mixed | | +| msg | string | 消息内容 | +| is_object | bool | 是否以对象形式返回,如果为False的话,返回数组形式(默认为false) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| array|CQObject[] | 返回的CQ码们(数组或对象) | diff --git a/docs/api/ZM/API/GoCqhttpAPIV11.md b/docs/api/ZM/API/GoCqhttpAPIV11.md index 00662971..326652e6 100644 --- a/docs/api/ZM/API/GoCqhttpAPIV11.md +++ b/docs/api/ZM/API/GoCqhttpAPIV11.md @@ -15,7 +15,7 @@ public function getGuildServiceProfile(): array|bool | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGuildList @@ -32,13 +32,13 @@ public function getGuildList(): array|bool | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGuildMetaByGuest ```php -public function getGuildMetaByGuest(mixed $guild_id): array|bool +public function getGuildMetaByGuest(int|string $guild_id): array|bool ``` ### 描述 @@ -49,18 +49,19 @@ public function getGuildMetaByGuest(mixed $guild_id): array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| guild_id | mixed | | +| guild_id | int|string | 频道ID | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGuildChannelList ```php -public function getGuildChannelList(mixed $guild_id, false $no_cache): array|bool +public function getGuildChannelList(int|string $guild_id, false $no_cache): array|bool ``` ### 描述 @@ -71,19 +72,20 @@ public function getGuildChannelList(mixed $guild_id, false $no_cache): array|boo | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| guild_id | mixed | | -| no_cache | false | | +| guild_id | int|string | 频道ID | +| no_cache | false | 禁用缓存(默认为false) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGuildMembers ```php -public function getGuildMembers(mixed $guild_id): array|bool +public function getGuildMembers(int|string $guild_id): array|bool ``` ### 描述 @@ -94,18 +96,19 @@ public function getGuildMembers(mixed $guild_id): array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| guild_id | mixed | | +| guild_id | int|string | 频道ID | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## sendGuildChannelMsg ```php -public function sendGuildChannelMsg(mixed $guild_id, mixed $channel_id, mixed $message): array|bool +public function sendGuildChannelMsg(int|string $guild_id, int|string $channel_id, string $message): array|bool ``` ### 描述 @@ -116,59 +119,12 @@ public function sendGuildChannelMsg(mixed $guild_id, mixed $channel_id, mixed $m | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| guild_id | mixed | | -| channel_id | mixed | | -| message | mixed | | +| guild_id | int|string | 频道ID | +| channel_id | int|string | 子频道ID | +| message | string | 信息内容 | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|bool | | - - -## processAPI - -```php -public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| connection | mixed | | -| reply | mixed | | -| function | |null | | -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | | - - -## processHttpAPI - -```php -public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| connection | mixed | | -| reply | mixed | | -| function | null | | -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | diff --git a/docs/api/ZM/API/OneBotV11.md b/docs/api/ZM/API/OneBotV11.md index 0e0096c3..2ff29f4d 100644 --- a/docs/api/ZM/API/OneBotV11.md +++ b/docs/api/ZM/API/OneBotV11.md @@ -3,23 +3,24 @@ ## get ```php -public function get(mixed $robot_id): ZMRobot +public function get(int|string $robot_id): ZMRobot ``` ### 描述 -作者很懒,什么也没有说 +获取机器人Action/API实例 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| robot_id | mixed | | +| robot_id | int|string | 机器人ID | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZMRobot | | +| ZMRobot | 机器人实例 | ## getRandom @@ -30,13 +31,13 @@ public function getRandom(): ZMRobot ### 描述 -作者很懒,什么也没有说 +随机获取一个连接到框架的机器人实例 ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZMRobot | | +| ZMRobot | 机器人实例 | ## getAllRobot @@ -47,19 +48,65 @@ public function getAllRobot(): ZMRobot[] ### 描述 -作者很懒,什么也没有说 +获取所有机器人实例 ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZMRobot[] | | +| ZMRobot[] | 机器人实例们 | + + +## setCallback + +```php +public function setCallback(bool|Closure $callback): OneBotV11 +``` + +### 描述 + +设置回调或启用协程等待API回包 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| callback | bool|Closure | 是否开启协程或设置异步回调函数,如果为true,则协程等待结果,如果为false,则异步执行并不等待结果,如果为回调函数,则异步执行且调用回调 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| OneBotV11 | 返回本身 | + + +## setPrefix + +```php +public function setPrefix(int $prefix): OneBotV11 +``` + +### 描述 + +设置API调用类型后缀 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| prefix | int | 设置后缀类型,API_NORMAL为不加后缀,API_ASYNC为异步调用,API_RATE_LIMITED为加后缀并且限制调用频率 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| OneBotV11 | 返回本身 | ## sendPrivateMsg ```php -public function sendPrivateMsg(mixed $user_id, mixed $message, bool $auto_escape): null|array|bool +public function sendPrivateMsg(int|string $user_id, string $message, bool $auto_escape): array|bool ``` ### 描述 @@ -70,14 +117,15 @@ public function sendPrivateMsg(mixed $user_id, mixed $message, bool $auto_escape | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| user_id | mixed | | -| message | mixed | | -| auto_escape | bool | | +| user_id | int|string | 用户ID | +| message | string | 消息内容 | +| auto_escape | bool | 是否自动转义(默认为false) | + ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## sendGroupMsg @@ -97,6 +145,7 @@ public function sendGroupMsg(mixed $group_id, mixed $message, bool $auto_escape) | group_id | mixed | | | message | mixed | | | auto_escape | bool | | + ### 返回 | 类型 | 描述 | @@ -122,6 +171,7 @@ public function sendMsg(mixed $message_type, mixed $target_id, mixed $message, b | target_id | mixed | | | message | mixed | | | auto_escape | bool | | + ### 返回 | 类型 | 描述 | @@ -144,6 +194,7 @@ public function deleteMsg(mixed $message_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | message_id | mixed | | + ### 返回 | 类型 | 描述 | @@ -166,6 +217,7 @@ public function getMsg(mixed $message_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | message_id | mixed | | + ### 返回 | 类型 | 描述 | @@ -188,6 +240,7 @@ public function getForwardMsg(mixed $id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | id | mixed | | + ### 返回 | 类型 | 描述 | @@ -211,6 +264,7 @@ public function sendLike(mixed $user_id, int $times): null|array|bool | -------- | ---- | ----------- | | user_id | mixed | | | times | int | | + ### 返回 | 类型 | 描述 | @@ -235,6 +289,7 @@ public function setGroupKick(mixed $group_id, mixed $user_id, bool $reject_add_r | group_id | mixed | | | user_id | mixed | | | reject_add_request | bool | | + ### 返回 | 类型 | 描述 | @@ -259,6 +314,7 @@ public function setGroupBan(mixed $group_id, mixed $user_id, int $duration): nul | group_id | mixed | | | user_id | mixed | | | duration | int | | + ### 返回 | 类型 | 描述 | @@ -283,6 +339,7 @@ public function setGroupAnonymousBan(mixed $group_id, mixed $anonymous_or_flag, | group_id | mixed | | | anonymous_or_flag | mixed | | | duration | int | | + ### 返回 | 类型 | 描述 | @@ -306,6 +363,7 @@ public function setGroupWholeBan(mixed $group_id, bool $enable): null|array|bool | -------- | ---- | ----------- | | group_id | mixed | | | enable | bool | | + ### 返回 | 类型 | 描述 | @@ -330,6 +388,7 @@ public function setGroupAdmin(mixed $group_id, mixed $user_id, bool $enable): nu | group_id | mixed | | | user_id | mixed | | | enable | bool | | + ### 返回 | 类型 | 描述 | @@ -353,6 +412,7 @@ public function setGroupAnonymous(mixed $group_id, bool $enable): null|array|boo | -------- | ---- | ----------- | | group_id | mixed | | | enable | bool | | + ### 返回 | 类型 | 描述 | @@ -377,6 +437,7 @@ public function setGroupCard(mixed $group_id, mixed $user_id, string $card): nul | group_id | mixed | | | user_id | mixed | | | card | string | | + ### 返回 | 类型 | 描述 | @@ -400,6 +461,7 @@ public function setGroupName(mixed $group_id, mixed $group_name): null|array|boo | -------- | ---- | ----------- | | group_id | mixed | | | group_name | mixed | | + ### 返回 | 类型 | 描述 | @@ -423,6 +485,7 @@ public function setGroupLeave(mixed $group_id, bool $is_dismiss): null|array|boo | -------- | ---- | ----------- | | group_id | mixed | | | is_dismiss | bool | | + ### 返回 | 类型 | 描述 | @@ -448,6 +511,7 @@ public function setGroupSpecialTitle(mixed $group_id, mixed $user_id, string $sp | user_id | mixed | | | special_title | string | | | duration | int | | + ### 返回 | 类型 | 描述 | @@ -472,6 +536,7 @@ public function setFriendAddRequest(mixed $flag, bool $approve, string $remark): | flag | mixed | | | approve | bool | | | remark | string | | + ### 返回 | 类型 | 描述 | @@ -497,6 +562,7 @@ public function setGroupAddRequest(mixed $flag, mixed $sub_type, bool $approve, | sub_type | mixed | | | approve | bool | | | reason | string | | + ### 返回 | 类型 | 描述 | @@ -537,6 +603,7 @@ public function getStrangerInfo(mixed $user_id, bool $no_cache): null|array|bool | -------- | ---- | ----------- | | user_id | mixed | | | no_cache | bool | | + ### 返回 | 类型 | 描述 | @@ -577,6 +644,7 @@ public function getGroupInfo(mixed $group_id, bool $no_cache): null|array|bool | -------- | ---- | ----------- | | group_id | mixed | | | no_cache | bool | | + ### 返回 | 类型 | 描述 | @@ -618,6 +686,7 @@ public function getGroupMemberInfo(mixed $group_id, mixed $user_id, bool $no_cac | group_id | mixed | | | user_id | mixed | | | no_cache | bool | | + ### 返回 | 类型 | 描述 | @@ -640,6 +709,7 @@ public function getGroupMemberList(mixed $group_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | group_id | mixed | | + ### 返回 | 类型 | 描述 | @@ -663,6 +733,7 @@ public function getGroupHonorInfo(mixed $group_id, mixed $type): null|array|bool | -------- | ---- | ----------- | | group_id | mixed | | | type | mixed | | + ### 返回 | 类型 | 描述 | @@ -702,6 +773,7 @@ public function getCredentials(string $domain): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | domain | string | | + ### 返回 | 类型 | 描述 | @@ -725,6 +797,7 @@ public function getRecord(mixed $file, mixed $out_format): null|array|bool | -------- | ---- | ----------- | | file | mixed | | | out_format | mixed | | + ### 返回 | 类型 | 描述 | @@ -747,6 +820,7 @@ public function getImage(mixed $file): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | file | mixed | | + ### 返回 | 类型 | 描述 | @@ -837,6 +911,7 @@ public function setRestart(int $delay): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | delay | int | | + ### 返回 | 类型 | 描述 | @@ -877,56 +952,9 @@ public function getExtendedAPI(string $package_name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | package_name | string | | + ### 返回 | 类型 | 描述 | | ---- | ----------- | | mixed | | - - -## processAPI - -```php -public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| connection | mixed | | -| reply | mixed | | -| function | |null | | -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array|bool | | - - -## processHttpAPI - -```php -public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| connection | mixed | | -| reply | mixed | | -| function | null | | -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| bool | | diff --git a/docs/api/ZM/API/TuringAPI.md b/docs/api/ZM/API/TuringAPI.md index 6957f75c..c7262960 100644 --- a/docs/api/ZM/API/TuringAPI.md +++ b/docs/api/ZM/API/TuringAPI.md @@ -17,6 +17,7 @@ public function getTuringMsg(mixed $msg, mixed $user_id, mixed $api): string | msg | mixed | | | user_id | mixed | | | api | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md index 78722c28..798115c2 100644 --- a/docs/api/ZM/Annotation/AnnotationParser.md +++ b/docs/api/ZM/Annotation/AnnotationParser.md @@ -50,6 +50,7 @@ public function addRegisterPath(mixed $path, mixed $indoor_name): mixed | -------- | ---- | ----------- | | path | mixed | | | indoor_name | mixed | | + ### 返回 | 类型 | 描述 | @@ -74,6 +75,7 @@ public function sortByLevel(mixed $events, string $class_name, string $prefix): | events | mixed | | | class_name | string | | | prefix | string | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md b/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md index 3ab07f91..75f8777b 100644 --- a/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md +++ b/docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md @@ -15,6 +15,7 @@ public function setLevel(int $level): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | level | int | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Command/CheckConfigCommand.md b/docs/api/ZM/Command/CheckConfigCommand.md index 5dc21f1c..7e24f1bf 100644 --- a/docs/api/ZM/Command/CheckConfigCommand.md +++ b/docs/api/ZM/Command/CheckConfigCommand.md @@ -17,6 +17,7 @@ public function check(mixed $remote, mixed $local, Symfony\Component\Console\Out | remote | mixed | | | local | mixed | | | out | Symfony\Component\Console\Output\OutputInterface | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/ConsoleApplication.md b/docs/api/ZM/ConsoleApplication.md index 8fc5fca8..011ac0c3 100644 --- a/docs/api/ZM/ConsoleApplication.md +++ b/docs/api/ZM/ConsoleApplication.md @@ -15,6 +15,7 @@ public function __construct(string $name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | name | string | | + ### 返回 | 类型 | 描述 | @@ -37,6 +38,7 @@ public function initEnv(string $with_default_cmd): ZM\ConsoleApplication | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | with_default_cmd | string | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Context/Context.md b/docs/api/ZM/Context/Context.md index 048b9c57..08ead474 100644 --- a/docs/api/ZM/Context/Context.md +++ b/docs/api/ZM/Context/Context.md @@ -50,6 +50,7 @@ only can used by cq->message event function | -------- | ---- | ----------- | | msg | mixed | | | yield | bool | | + ### 返回 | 类型 | 描述 | @@ -73,6 +74,7 @@ public function finalReply(mixed $msg, bool $yield): mixed | -------- | ---- | ----------- | | msg | mixed | | | yield | bool | | + ### 返回 | 类型 | 描述 | @@ -97,6 +99,7 @@ public function waitMessage(string $prompt, int $timeout, string $timeout_prompt | prompt | string | | | timeout | int | | | timeout_prompt | string | | + ### 返回 | 类型 | 描述 | @@ -120,6 +123,7 @@ public function getArgs(mixed $mode, mixed $prompt_msg): mixed|string | -------- | ---- | ----------- | | mode | mixed | | | prompt_msg | mixed | | + ### 返回 | 类型 | 描述 | @@ -142,6 +146,7 @@ public function getNextArg(string $prompt_msg): int|mixed|string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | prompt_msg | string | | + ### 返回 | 类型 | 描述 | @@ -164,6 +169,7 @@ public function getFullArg(string $prompt_msg): int|mixed|string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | prompt_msg | string | | + ### 返回 | 类型 | 描述 | @@ -186,6 +192,7 @@ public function getNumArg(string $prompt_msg): int|mixed|string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | prompt_msg | string | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/DB/DB.md b/docs/api/ZM/DB/DB.md index 41876389..4681bacb 100644 --- a/docs/api/ZM/DB/DB.md +++ b/docs/api/ZM/DB/DB.md @@ -15,6 +15,7 @@ public function initTableList(mixed $db_name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | db_name | mixed | | + ### 返回 | 类型 | 描述 | @@ -37,6 +38,7 @@ public function table(mixed $table_name): ZM\DB\Table | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | table_name | mixed | | + ### 返回 | 类型 | 描述 | @@ -59,6 +61,7 @@ public function statement(mixed $line): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | line | mixed | | + ### 返回 | 类型 | 描述 | @@ -81,6 +84,7 @@ public function unprepared(mixed $line): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | line | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/DB/DeleteBody.md b/docs/api/ZM/DB/DeleteBody.md index 59efd462..09702791 100644 --- a/docs/api/ZM/DB/DeleteBody.md +++ b/docs/api/ZM/DB/DeleteBody.md @@ -15,6 +15,7 @@ DeleteBody constructor. | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | table | ZM\DB\Table | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/DB/InsertBody.md b/docs/api/ZM/DB/InsertBody.md index e44313b5..c6477480 100644 --- a/docs/api/ZM/DB/InsertBody.md +++ b/docs/api/ZM/DB/InsertBody.md @@ -16,6 +16,7 @@ InsertBody constructor. | -------- | ---- | ----------- | | row | mixed | | | table | ZM\DB\Table | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/DB/SelectBody.md b/docs/api/ZM/DB/SelectBody.md index 986160ab..439d68b7 100644 --- a/docs/api/ZM/DB/SelectBody.md +++ b/docs/api/ZM/DB/SelectBody.md @@ -49,6 +49,7 @@ public function fetchAll(int $fetch_mode): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | fetch_mode | int | | + ### 返回 | 类型 | 描述 | @@ -88,6 +89,7 @@ public function value(null $key): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | key | null | | + ### 返回 | 类型 | 描述 | @@ -110,6 +112,7 @@ public function execute(int $fetch_mode): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | fetch_mode | int | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/DB/UpdateBody.md b/docs/api/ZM/DB/UpdateBody.md index 0ffd8ee9..cb892276 100644 --- a/docs/api/ZM/DB/UpdateBody.md +++ b/docs/api/ZM/DB/UpdateBody.md @@ -16,6 +16,7 @@ UpdateBody constructor. | -------- | ---- | ----------- | | table | ZM\DB\Table | | | set_value | array | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Event/EventDispatcher.md b/docs/api/ZM/Event/EventDispatcher.md index 607115ec..42e1057a 100644 --- a/docs/api/ZM/Event/EventDispatcher.md +++ b/docs/api/ZM/Event/EventDispatcher.md @@ -15,6 +15,7 @@ public function interrupt(mixed $return_var): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | return_var | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Event/EventManager.md b/docs/api/ZM/Event/EventManager.md index f36f19ce..2e5a812d 100644 --- a/docs/api/ZM/Event/EventManager.md +++ b/docs/api/ZM/Event/EventManager.md @@ -15,6 +15,7 @@ public function loadEventByParser(ZM\Annotation\AnnotationParser $parser): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | parser | ZM\Annotation\AnnotationParser | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Event/SwooleEvent/OnTask.md b/docs/api/ZM/Event/SwooleEvent/OnTask.md index 4207ecf1..46f3efe0 100644 --- a/docs/api/ZM/Event/SwooleEvent/OnTask.md +++ b/docs/api/ZM/Event/SwooleEvent/OnTask.md @@ -16,6 +16,7 @@ public function onCall(Swoole\Server $server, Swoole\Server\Task $task): mixed | -------- | ---- | ----------- | | server | Swoole\Server | | | task | Swoole\Server\Task | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Framework.md b/docs/api/ZM/Framework.md index f6eddee6..4e43d72e 100644 --- a/docs/api/ZM/Framework.md +++ b/docs/api/ZM/Framework.md @@ -17,6 +17,7 @@ public function saveProcessState(int|string $pid, int $type, array $data): mixed | pid | int|string | | | type | int | | | data | array | | + ### 返回 | 类型 | 描述 | @@ -40,6 +41,7 @@ public function getProcessState(mixed $id_or_name, int $type): false|int|mixed | -------- | ---- | ----------- | | id_or_name | mixed | | | type | int | | + ### 返回 | 类型 | 描述 | @@ -63,6 +65,7 @@ public function removeProcessState(null $id_or_name, int $type): mixed | -------- | ---- | ----------- | | id_or_name | null | | | type | int | | + ### 返回 | 类型 | 描述 | @@ -120,6 +123,7 @@ public function parseCliArgs(mixed $args, mixed $add_port): mixed | -------- | ---- | ----------- | | args | mixed | | | add_port | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Http/Response.md b/docs/api/ZM/Http/Response.md index c85e1122..4fb04281 100644 --- a/docs/api/ZM/Http/Response.md +++ b/docs/api/ZM/Http/Response.md @@ -34,6 +34,7 @@ public function status(mixed $http_code, mixed $reason, mixed $params): mixed | http_code | mixed | | | reason | mixed | | | params | mixed | | + ### 返回 | 类型 | 描述 | @@ -58,6 +59,7 @@ public function setStatusCode(mixed $http_code, mixed $reason, mixed $params): m | http_code | mixed | | | reason | mixed | | | params | mixed | | + ### 返回 | 类型 | 描述 | @@ -82,6 +84,7 @@ public function header(mixed $key, mixed $value, mixed $ucwords): mixed | key | mixed | | | value | mixed | | | ucwords | mixed | | + ### 返回 | 类型 | 描述 | @@ -106,6 +109,7 @@ public function setHeader(mixed $key, mixed $value, mixed $ucwords): mixed | key | mixed | | | value | mixed | | | ucwords | mixed | | + ### 返回 | 类型 | 描述 | @@ -129,6 +133,7 @@ public function trailer(mixed $key, mixed $value): mixed | -------- | ---- | ----------- | | key | mixed | | | value | mixed | | + ### 返回 | 类型 | 描述 | @@ -168,6 +173,7 @@ public function write(mixed $content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | content | mixed | | + ### 返回 | 类型 | 描述 | @@ -190,6 +196,7 @@ public function end(mixed $content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | content | mixed | | + ### 返回 | 类型 | 描述 | @@ -214,6 +221,7 @@ public function sendfile(mixed $filename, mixed $offset, mixed $length): mixed | filename | mixed | | | offset | mixed | | | length | mixed | | + ### 返回 | 类型 | 描述 | @@ -237,6 +245,7 @@ public function redirect(mixed $location, mixed $http_code): mixed | -------- | ---- | ----------- | | location | mixed | | | http_code | mixed | | + ### 返回 | 类型 | 描述 | @@ -276,6 +285,7 @@ public function create(mixed $fd): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | fd | mixed | | + ### 返回 | 类型 | 描述 | @@ -317,6 +327,7 @@ public function push(mixed $data, null $opcode, null $flags): mixed | data | mixed | | | opcode | null | | | flags | null | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Module/ModulePacker.md b/docs/api/ZM/Module/ModulePacker.md index a8764a76..f797819c 100644 --- a/docs/api/ZM/Module/ModulePacker.md +++ b/docs/api/ZM/Module/ModulePacker.md @@ -15,6 +15,7 @@ public function __construct(array $module): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | module | array | | + ### 返回 | 类型 | 描述 | @@ -37,6 +38,7 @@ public function setOutputPath(mixed $path): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | path | mixed | | + ### 返回 | 类型 | 描述 | @@ -59,6 +61,7 @@ public function setOverride(bool $override): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | override | bool | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Module/ModuleUnpacker.md b/docs/api/ZM/Module/ModuleUnpacker.md index ed05ec1a..929a59da 100644 --- a/docs/api/ZM/Module/ModuleUnpacker.md +++ b/docs/api/ZM/Module/ModuleUnpacker.md @@ -18,6 +18,7 @@ public function unpack(mixed $ignore_depends, bool $override_light_cache, bool $ | override_light_cache | bool | | | override_data_files | bool | | | override_source | bool | | + ### 返回 | 类型 | 描述 | @@ -57,6 +58,7 @@ public function checkDepends(mixed $ignore_depends): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | ignore_depends | mixed | | + ### 返回 | 类型 | 描述 | @@ -113,6 +115,7 @@ public function copyZMDataStore(mixed $override_data): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | override_data | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Module/QQBot.md b/docs/api/ZM/Module/QQBot.md index 08a89fab..9c522160 100644 --- a/docs/api/ZM/Module/QQBot.md +++ b/docs/api/ZM/Module/QQBot.md @@ -16,6 +16,7 @@ public function handle(mixed $data, int $level): mixed | -------- | ---- | ----------- | | data | mixed | | | level | int | | + ### 返回 | 类型 | 描述 | @@ -39,6 +40,7 @@ public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDi | -------- | ---- | ----------- | | data | mixed | | | time | mixed | | + ### 返回 | 类型 | 描述 | @@ -61,6 +63,7 @@ public function dispatchEvents(mixed $data): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | data | mixed | | + ### 返回 | 类型 | 描述 | @@ -83,6 +86,7 @@ public function dispatchAPIResponse(mixed $req): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | req | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/MySQL/MySQLPool.md b/docs/api/ZM/MySQL/MySQLPool.md index 64c67141..5f57a7d3 100644 --- a/docs/api/ZM/MySQL/MySQLPool.md +++ b/docs/api/ZM/MySQL/MySQLPool.md @@ -32,6 +32,7 @@ public function putConnection(PDO|PDOProxy $connection): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | connection | PDO|PDOProxy | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/MySQL/MySQLWrapper.md b/docs/api/ZM/MySQL/MySQLWrapper.md index acba88ac..50f7b169 100644 --- a/docs/api/ZM/MySQL/MySQLWrapper.md +++ b/docs/api/ZM/MySQL/MySQLWrapper.md @@ -66,6 +66,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | autoCommit | mixed | | + ### 返回 | 类型 | 描述 | @@ -90,6 +91,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -114,6 +116,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -138,6 +141,7 @@ public function fetchOne(string $query, array $params, array $types): false|mixe | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -179,6 +183,7 @@ public function delete(mixed $table, array $criteria, array $types): int | table | mixed | | | criteria | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -201,6 +206,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | level | mixed | | + ### 返回 | 类型 | 描述 | @@ -243,6 +249,7 @@ wrapper method | data | array | | | criteria | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -267,6 +274,7 @@ wrapper method | table | mixed | | | data | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -289,6 +297,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | str | mixed | | + ### 返回 | 类型 | 描述 | @@ -312,6 +321,7 @@ wrapper method | -------- | ---- | ----------- | | value | mixed | | | type | int | | + ### 返回 | 类型 | 描述 | @@ -336,6 +346,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -360,6 +371,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -384,6 +396,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -408,6 +421,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -432,6 +446,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -456,6 +471,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -480,6 +496,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -504,6 +521,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -528,6 +546,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -552,6 +571,7 @@ wrapper method | query | string | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -577,6 +597,7 @@ wrapper method | types | array | | | params | array | | | qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | + ### 返回 | 类型 | 描述 | @@ -602,6 +623,7 @@ wrapper method | params | mixed | | | types | mixed | | | qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | + ### 返回 | 类型 | 描述 | @@ -626,6 +648,7 @@ wrapper method | sql | mixed | | | params | array | | | types | array | | + ### 返回 | 类型 | 描述 | @@ -665,6 +688,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | name | null | | + ### 返回 | 类型 | 描述 | @@ -687,6 +711,7 @@ overwrite method to $this->connection->transactional() | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | func | Closure | | + ### 返回 | 类型 | 描述 | @@ -709,6 +734,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | nestTransactionsWithSavepoints | mixed | | + ### 返回 | 类型 | 描述 | @@ -799,6 +825,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | savepoint | mixed | | + ### 返回 | 类型 | 描述 | @@ -821,6 +848,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | savepoint | mixed | | + ### 返回 | 类型 | 描述 | @@ -843,6 +871,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | savepoint | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Store/LightCache.md b/docs/api/ZM/Store/LightCache.md index 43a4f1ed..8e9b95d0 100644 --- a/docs/api/ZM/Store/LightCache.md +++ b/docs/api/ZM/Store/LightCache.md @@ -15,6 +15,7 @@ public function init(mixed $config): bool|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | config | mixed | | + ### 返回 | 类型 | 描述 | @@ -37,6 +38,7 @@ public function get(string $key): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | key | string | | + ### 返回 | 类型 | 描述 | @@ -59,6 +61,7 @@ public function getExpire(string $key): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | key | string | | + ### 返回 | 类型 | 描述 | @@ -81,6 +84,7 @@ public function getExpireTS(string $key): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | key | string | | + ### 返回 | 类型 | 描述 | @@ -105,6 +109,7 @@ public function set(array|int|string $value, string $key, int $expire): bool | value | array|int|string | | | key | string | | | expire | int | | + ### 返回 | 类型 | 描述 | @@ -128,6 +133,7 @@ public function update(mixed $value, string $key): bool | -------- | ---- | ----------- | | value | mixed | | | key | string | | + ### 返回 | 类型 | 描述 | @@ -150,6 +156,7 @@ public function isset(string $key): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | key | string | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Store/LightCacheInside.md b/docs/api/ZM/Store/LightCacheInside.md index 240c5fdd..6a787ba4 100644 --- a/docs/api/ZM/Store/LightCacheInside.md +++ b/docs/api/ZM/Store/LightCacheInside.md @@ -16,6 +16,7 @@ public function get(string $table, string $key): null|mixed | -------- | ---- | ----------- | | table | string | | | key | string | | + ### 返回 | 类型 | 描述 | @@ -40,6 +41,7 @@ public function set(array|int|string $value, string $table, string $key): mixed | value | array|int|string | | | table | string | | | key | string | | + ### 返回 | 类型 | 描述 | @@ -65,6 +67,7 @@ public function createTable(mixed $name, mixed $size, mixed $str_size, int $conf | size | mixed | | | str_size | mixed | | | conflict_proportion | int | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Store/Redis/ZMRedis.md b/docs/api/ZM/Store/Redis/ZMRedis.md index 7793e22a..efee0423 100644 --- a/docs/api/ZM/Store/Redis/ZMRedis.md +++ b/docs/api/ZM/Store/Redis/ZMRedis.md @@ -32,6 +32,7 @@ public function call(callable $callable): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | callable | callable | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Store/ZMAtomic.md b/docs/api/ZM/Store/ZMAtomic.md index 66fb3c7a..c1036303 100644 --- a/docs/api/ZM/Store/ZMAtomic.md +++ b/docs/api/ZM/Store/ZMAtomic.md @@ -15,6 +15,7 @@ public function get(mixed $name): Swoole\Atomic | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | name | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/CoMessage.md b/docs/api/ZM/Utils/CoMessage.md index 37a2279f..92382d0f 100644 --- a/docs/api/ZM/Utils/CoMessage.md +++ b/docs/api/ZM/Utils/CoMessage.md @@ -17,6 +17,7 @@ public function yieldByWS(int $timeout, array $hang, array $compare): mixed | timeout | int | | | hang | array | | | compare | array | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/DataProvider.md b/docs/api/ZM/Utils/DataProvider.md index 72e0c1d6..eaf2d081 100644 --- a/docs/api/ZM/Utils/DataProvider.md +++ b/docs/api/ZM/Utils/DataProvider.md @@ -100,6 +100,7 @@ public function getDataFolder(string $second): null|array|false|mixed|string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | second | string | | + ### 返回 | 类型 | 描述 | @@ -123,6 +124,7 @@ public function saveToJson(mixed $filename, mixed $file_array): false|int | -------- | ---- | ----------- | | filename | mixed | | | file_array | mixed | | + ### 返回 | 类型 | 描述 | @@ -145,6 +147,7 @@ public function loadFromJson(mixed $filename): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | filename | mixed | | + ### 返回 | 类型 | 描述 | @@ -169,6 +172,7 @@ public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive) | dir | mixed | | | relative | bool|string | | | recursive | bool | | + ### 返回 | 类型 | 描述 | @@ -191,6 +195,7 @@ public function isRelativePath(mixed $path): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | path | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/HttpUtil.md b/docs/api/ZM/Utils/HttpUtil.md index e88dd386..ed1fc778 100644 --- a/docs/api/ZM/Utils/HttpUtil.md +++ b/docs/api/ZM/Utils/HttpUtil.md @@ -19,6 +19,7 @@ public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $nod | uri | mixed | | | node | mixed | | | params | mixed | | + ### 返回 | 类型 | 描述 | @@ -43,6 +44,7 @@ public function handleStaticPage(mixed $uri, Response|\Swoole\Http\Response $res | uri | mixed | | | response | Response|\Swoole\Http\Response | | | settings | array | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/Manager/CronManager.md b/docs/api/ZM/Utils/Manager/CronManager.md index e6b002bd..f6c0e7d5 100644 --- a/docs/api/ZM/Utils/Manager/CronManager.md +++ b/docs/api/ZM/Utils/Manager/CronManager.md @@ -35,6 +35,7 @@ public function startExecute(ZM\Annotation\Cron\Cron $v, ZM\Event\EventDispatche | v | ZM\Annotation\Cron\Cron | | | dispatcher | ZM\Event\EventDispatcher | | | cron | Cron\CronExpression | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/Manager/ModuleManager.md b/docs/api/ZM/Utils/Manager/ModuleManager.md index ec8cf1ff..51530044 100644 --- a/docs/api/ZM/Utils/Manager/ModuleManager.md +++ b/docs/api/ZM/Utils/Manager/ModuleManager.md @@ -32,6 +32,7 @@ public function packModule(mixed $module): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | module | mixed | | + ### 返回 | 类型 | 描述 | @@ -55,6 +56,7 @@ public function unpackModule(mixed $module, array $options): array|false | -------- | ---- | ----------- | | module | mixed | | | options | array | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/Manager/WorkerManager.md b/docs/api/ZM/Utils/Manager/WorkerManager.md index 05aa6d74..384d21e8 100644 --- a/docs/api/ZM/Utils/Manager/WorkerManager.md +++ b/docs/api/ZM/Utils/Manager/WorkerManager.md @@ -16,6 +16,7 @@ Worker 进程间通信触发的动作类型函数 | -------- | ---- | ----------- | | src_worker_id | mixed | | | data | mixed | | + ### 返回 | 类型 | 描述 | @@ -40,6 +41,7 @@ public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data) | worker_id | mixed | | | action | mixed | | | data | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/MessageUtil.md b/docs/api/ZM/Utils/MessageUtil.md index 7b493409..14976f34 100644 --- a/docs/api/ZM/Utils/MessageUtil.md +++ b/docs/api/ZM/Utils/MessageUtil.md @@ -16,6 +16,7 @@ public function downloadCQImage(mixed $msg, null $path): array|false | -------- | ---- | ----------- | | msg | mixed | | | path | null | | + ### 返回 | 类型 | 描述 | @@ -38,6 +39,7 @@ public function containsImage(mixed $msg): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | msg | mixed | | + ### 返回 | 类型 | 描述 | @@ -64,6 +66,7 @@ type == 2 : 返回图片的 http://xxx CQ 码(默认为 /images/ 路径就是 | -------- | ---- | ----------- | | file | mixed | | | type | int | | + ### 返回 | 类型 | 描述 | @@ -86,6 +89,7 @@ public function splitCommand(mixed $msg): array|string[] | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | msg | mixed | | + ### 返回 | 类型 | 描述 | @@ -109,6 +113,7 @@ public function matchCommand(mixed $msg, mixed $obj): ZM\Entity\MatchResult | -------- | ---- | ----------- | | msg | mixed | | | obj | mixed | | + ### 返回 | 类型 | 描述 | @@ -132,6 +137,7 @@ public function addShortCommand(mixed $command, string $reply): mixed | -------- | ---- | ----------- | | command | mixed | | | reply | string | | + ### 返回 | 类型 | 描述 | @@ -156,6 +162,7 @@ public function strToArray(mixed $msg, false $trim_text, bool $ignore_space): ar | msg | mixed | | | trim_text | false | | | ignore_space | bool | | + ### 返回 | 类型 | 描述 | @@ -179,6 +186,7 @@ public function arrayToStr(array $array): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | array | array | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/SignalListener.md b/docs/api/ZM/Utils/SignalListener.md index cc0dde20..9899144c 100644 --- a/docs/api/ZM/Utils/SignalListener.md +++ b/docs/api/ZM/Utils/SignalListener.md @@ -15,6 +15,7 @@ public function signalMaster(Swoole\Server $server): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | server | Swoole\Server | | + ### 返回 | 类型 | 描述 | @@ -55,6 +56,7 @@ public function signalWorker(mixed $worker_id, Swoole\Server $server): mixed | -------- | ---- | ----------- | | worker_id | mixed | | | server | Swoole\Server | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/Terminal.md b/docs/api/ZM/Utils/Terminal.md index 6dd66118..7f3e73e3 100644 --- a/docs/api/ZM/Utils/Terminal.md +++ b/docs/api/ZM/Utils/Terminal.md @@ -15,6 +15,7 @@ public function executeCommand(string $cmd): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | cmd | string | | + ### 返回 | 类型 | 描述 | @@ -88,6 +89,7 @@ public function call(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | it | mixed | | + ### 返回 | 类型 | 描述 | @@ -110,6 +112,7 @@ public function level(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | it | mixed | | + ### 返回 | 类型 | 描述 | @@ -132,6 +135,7 @@ public function bc(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | it | mixed | | + ### 返回 | 类型 | 描述 | @@ -154,6 +158,7 @@ public function echoI(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | it | mixed | | + ### 返回 | 类型 | 描述 | diff --git a/docs/api/ZM/Utils/ZMUtil.md b/docs/api/ZM/Utils/ZMUtil.md index 251a1004..5d0c3e54 100644 --- a/docs/api/ZM/Utils/ZMUtil.md +++ b/docs/api/ZM/Utils/ZMUtil.md @@ -3,13 +3,19 @@ ## stop ```php -public function stop(): mixed +public function stop(mixed $error_exit): mixed ``` ### 描述 作者很懒,什么也没有说 +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| error_exit | mixed | | + ### 返回 | 类型 | 描述 | @@ -69,6 +75,7 @@ public function getClassesPsr4(mixed $dir, mixed $base_namespace, null|mixed $ru | base_namespace | mixed | | | rule | null|mixed | | | return_path_value | bool | | + ### 返回 | 类型 | 描述 |