diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 4f5a7fe2..6bcc06b1 100644 --- a/docs/.vuepress/api.js +++ b/docs/.vuepress/api.js @@ -1 +1 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/Framework","ZM/ConsoleApplication","ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11","ZM/API/CQ","ZM/API/OneBotV11"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationParser"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModuleListCommand","ZM/Command/Module/ModulePackCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/Table","ZM/DB/SelectBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventManager","ZM/Event/EventTracer","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnWorkerStart","ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModuleBase","ZM/Module/ModuleUnpacker","ZM/Module/QQBot","ZM/Module/ModulePacker"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCacheInside","ZM/Store/LightCache","ZM/Store/ZMAtomic"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ZMUtil","ZM/Utils/DataProvider","ZM/Utils/HttpUtil","ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}] \ No newline at end of file +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/Framework","ZM/ConsoleApplication","ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11","ZM/API/CQ","ZM/API/OneBotV11"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationParser"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Module","collapsable":true,"children":["ZM/Command/Module/ModuleListCommand","ZM/Command/Module/ModulePackCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/Table","ZM/DB/SelectBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventManager","ZM/Event/EventTracer","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnWorkerStart","ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModuleBase","ZM/Module/ModuleUnpacker","ZM/Module/QQBot","ZM/Module/ModulePacker"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCacheInside","ZM/Store/LightCache","ZM/Store/ZMAtomic"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ZMUtil","ZM/Utils/DataProvider","ZM/Utils/HttpUtil","ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}] \ No newline at end of file diff --git a/docs/api/ZM/API/OneBotV11.md b/docs/api/ZM/API/OneBotV11.md index 3ef8ad18..6bd09e03 100644 --- a/docs/api/ZM/API/OneBotV11.md +++ b/docs/api/ZM/API/OneBotV11.md @@ -3,24 +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 @@ -31,13 +31,13 @@ public function getRandom(): ZMRobot ### 描述 -作者很懒,什么也没有说 +随机获取一个连接到框架的机器人实例 ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZMRobot | | +| ZMRobot | 机器人实例 | ## getAllRobot @@ -48,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 ``` ### 描述 @@ -71,21 +117,21 @@ 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 ```php -public function sendGroupMsg(mixed $group_id, mixed $message, bool $auto_escape): null|array|bool +public function sendGroupMsg(int|string $group_id, string $message, bool $auto_escape): array|bool ``` ### 描述 @@ -96,21 +142,21 @@ public function sendGroupMsg(mixed $group_id, mixed $message, bool $auto_escape) | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| message | mixed | | -| auto_escape | bool | | +| group_id | int|string | 群组ID | +| message | string | 消息内容 | +| auto_escape | bool | 是否自动转义(默认为false) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## sendMsg ```php -public function sendMsg(mixed $message_type, mixed $target_id, mixed $message, bool $auto_escape): null|array|bool +public function sendMsg(string $message_type, int|string $target_id, string $message, bool $auto_escape): array|bool ``` ### 描述 @@ -121,22 +167,22 @@ public function sendMsg(mixed $message_type, mixed $target_id, mixed $message, b | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| message_type | mixed | | -| target_id | mixed | | -| message | mixed | | -| auto_escape | bool | | +| message_type | string | 消息类型 | +| target_id | int|string | 目标ID | +| message | string | 消息内容 | +| auto_escape | bool | 是否自动转义(默认为false) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## deleteMsg ```php -public function deleteMsg(mixed $message_id): null|array|bool +public function deleteMsg(int|string $message_id): array|bool ``` ### 描述 @@ -147,19 +193,19 @@ public function deleteMsg(mixed $message_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| message_id | mixed | | +| message_id | int|string | 消息ID | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getMsg ```php -public function getMsg(mixed $message_id): null|array|bool +public function getMsg(int|string $message_id): array|bool ``` ### 描述 @@ -170,19 +216,19 @@ public function getMsg(mixed $message_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| message_id | mixed | | +| message_id | int|string | 消息ID | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getForwardMsg ```php -public function getForwardMsg(mixed $id): null|array|bool +public function getForwardMsg(int|string $id): array|bool ``` ### 描述 @@ -193,19 +239,19 @@ public function getForwardMsg(mixed $id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id | mixed | | +| id | int|string | ID | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## sendLike ```php -public function sendLike(mixed $user_id, int $times): null|array|bool +public function sendLike(int|string $user_id, int $times): array|bool ``` ### 描述 @@ -216,20 +262,20 @@ public function sendLike(mixed $user_id, int $times): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| user_id | mixed | | -| times | int | | +| user_id | int|string | 用户ID | +| times | int | 时间 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupKick ```php -public function setGroupKick(mixed $group_id, mixed $user_id, bool $reject_add_request): null|array|bool +public function setGroupKick(int|string $group_id, int|string $user_id, bool $reject_add_request): array|bool ``` ### 描述 @@ -240,21 +286,21 @@ public function setGroupKick(mixed $group_id, mixed $user_id, bool $reject_add_r | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | | reject_add_request | bool | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupBan ```php -public function setGroupBan(mixed $group_id, mixed $user_id, int $duration): null|array|bool +public function setGroupBan(int|string $group_id, int|string $user_id, int $duration): array|bool ``` ### 描述 @@ -265,21 +311,21 @@ public function setGroupBan(mixed $group_id, mixed $user_id, int $duration): nul | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | -| duration | int | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | +| duration | int | 禁言时长 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupAnonymousBan ```php -public function setGroupAnonymousBan(mixed $group_id, mixed $anonymous_or_flag, int $duration): null|array|bool +public function setGroupAnonymousBan(int|string $group_id, array|int|string $anonymous_or_flag, int $duration): array|bool ``` ### 描述 @@ -290,21 +336,21 @@ public function setGroupAnonymousBan(mixed $group_id, mixed $anonymous_or_flag, | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| anonymous_or_flag | mixed | | +| group_id | int|string | 群ID | +| anonymous_or_flag | array|int|string | 匿名禁言Flag或匿名用户对象 | | duration | int | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupWholeBan ```php -public function setGroupWholeBan(mixed $group_id, bool $enable): null|array|bool +public function setGroupWholeBan(int|string $group_id, bool $enable): array|bool ``` ### 描述 @@ -315,20 +361,20 @@ public function setGroupWholeBan(mixed $group_id, bool $enable): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | +| group_id | int|string | 群ID | | enable | bool | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupAdmin ```php -public function setGroupAdmin(mixed $group_id, mixed $user_id, bool $enable): null|array|bool +public function setGroupAdmin(int|string $group_id, int|string $user_id, bool $enable): array|bool ``` ### 描述 @@ -339,21 +385,21 @@ public function setGroupAdmin(mixed $group_id, mixed $user_id, bool $enable): nu | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | | enable | bool | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupAnonymous ```php -public function setGroupAnonymous(mixed $group_id, bool $enable): null|array|bool +public function setGroupAnonymous(int|string $group_id, bool $enable): array|bool ``` ### 描述 @@ -364,20 +410,20 @@ public function setGroupAnonymous(mixed $group_id, bool $enable): null|array|boo | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| enable | bool | | +| group_id | int|string | 群ID | +| enable | bool | 是否启用(默认为true) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupCard ```php -public function setGroupCard(mixed $group_id, mixed $user_id, string $card): null|array|bool +public function setGroupCard(int|string $group_id, int|string $user_id, string $card): array|bool ``` ### 描述 @@ -388,21 +434,21 @@ public function setGroupCard(mixed $group_id, mixed $user_id, string $card): nul | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | -| card | string | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | +| card | string | 名片内容(默认为空) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupName ```php -public function setGroupName(mixed $group_id, mixed $group_name): null|array|bool +public function setGroupName(int|string $group_id, string $group_name): array|bool ``` ### 描述 @@ -413,20 +459,20 @@ public function setGroupName(mixed $group_id, mixed $group_name): null|array|boo | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| group_name | mixed | | +| group_id | int|string | 群ID | +| group_name | string | 群名 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupLeave ```php -public function setGroupLeave(mixed $group_id, bool $is_dismiss): null|array|bool +public function setGroupLeave(int|string $group_id, bool $is_dismiss): array|bool ``` ### 描述 @@ -437,20 +483,20 @@ public function setGroupLeave(mixed $group_id, bool $is_dismiss): null|array|boo | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| is_dismiss | bool | | +| group_id | int|string | 群ID | +| is_dismiss | bool | 是否解散(默认为false) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupSpecialTitle ```php -public function setGroupSpecialTitle(mixed $group_id, mixed $user_id, string $special_title, int $duration): null|array|bool +public function setGroupSpecialTitle(int|string $group_id, int|string $user_id, string $special_title, int $duration): array|bool ``` ### 描述 @@ -461,22 +507,22 @@ public function setGroupSpecialTitle(mixed $group_id, mixed $user_id, string $sp | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | -| special_title | string | | -| duration | int | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | +| special_title | string | 专属头衔内容 | +| duration | int | 持续时间(默认为-1,永久) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setFriendAddRequest ```php -public function setFriendAddRequest(mixed $flag, bool $approve, string $remark): null|array|bool +public function setFriendAddRequest(array|int|string $flag, bool $approve, string $remark): array|bool ``` ### 描述 @@ -487,21 +533,21 @@ public function setFriendAddRequest(mixed $flag, bool $approve, string $remark): | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| flag | mixed | | -| approve | bool | | -| remark | string | | +| flag | array|int|string | 处理加好友请求的flag | +| approve | bool | 是否同意(默认为true) | +| remark | string | 设置昵称(默认不设置) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setGroupAddRequest ```php -public function setGroupAddRequest(mixed $flag, mixed $sub_type, bool $approve, string $reason): null|array|bool +public function setGroupAddRequest(array|int|string $flag, string $sub_type, bool $approve, string $reason): array|bool ``` ### 描述 @@ -512,22 +558,22 @@ public function setGroupAddRequest(mixed $flag, mixed $sub_type, bool $approve, | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| flag | mixed | | -| sub_type | mixed | | -| approve | bool | | -| reason | string | | +| flag | array|int|string | 处理加群请求的flag | +| sub_type | string | 处理请求类型(包含add和invite) | +| approve | bool | 是否同意(默认为true) | +| reason | string | 拒绝理由(仅在拒绝时有效,默认为空) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getLoginInfo ```php -public function getLoginInfo(): null|array|bool +public function getLoginInfo(): array|bool ``` ### 描述 @@ -538,13 +584,13 @@ public function getLoginInfo(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getStrangerInfo ```php -public function getStrangerInfo(mixed $user_id, bool $no_cache): null|array|bool +public function getStrangerInfo(int|string $user_id, bool $no_cache): array|bool ``` ### 描述 @@ -555,20 +601,20 @@ public function getStrangerInfo(mixed $user_id, bool $no_cache): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| user_id | mixed | | -| no_cache | bool | | +| user_id | int|string | 用户ID | +| no_cache | bool | 是否不使用缓存(默认为false) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getFriendList ```php -public function getFriendList(): null|array|bool +public function getFriendList(): array|bool ``` ### 描述 @@ -579,13 +625,13 @@ public function getFriendList(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGroupInfo ```php -public function getGroupInfo(mixed $group_id, bool $no_cache): null|array|bool +public function getGroupInfo(int|string $group_id, bool $no_cache): array|bool ``` ### 描述 @@ -596,20 +642,20 @@ public function getGroupInfo(mixed $group_id, bool $no_cache): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | +| group_id | int|string | 群ID | | no_cache | bool | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGroupList ```php -public function getGroupList(): null|array|bool +public function getGroupList(): array|bool ``` ### 描述 @@ -620,13 +666,13 @@ public function getGroupList(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGroupMemberInfo ```php -public function getGroupMemberInfo(mixed $group_id, mixed $user_id, bool $no_cache): null|array|bool +public function getGroupMemberInfo(int|string $group_id, int|string $user_id, bool $no_cache): array|bool ``` ### 描述 @@ -637,21 +683,21 @@ public function getGroupMemberInfo(mixed $group_id, mixed $user_id, bool $no_cac | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| user_id | mixed | | +| group_id | int|string | 群ID | +| user_id | int|string | 用户ID | | no_cache | bool | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGroupMemberList ```php -public function getGroupMemberList(mixed $group_id): null|array|bool +public function getGroupMemberList(int|string $group_id): array|bool ``` ### 描述 @@ -662,19 +708,19 @@ public function getGroupMemberList(mixed $group_id): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | +| group_id | int|string | 群ID | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getGroupHonorInfo ```php -public function getGroupHonorInfo(mixed $group_id, mixed $type): null|array|bool +public function getGroupHonorInfo(int|string $group_id, string $type): array|bool ``` ### 描述 @@ -685,20 +731,20 @@ public function getGroupHonorInfo(mixed $group_id, mixed $type): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| group_id | mixed | | -| type | mixed | | +| group_id | int|string | 群ID | +| type | string | 荣誉类型 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getCsrfToken ```php -public function getCsrfToken(): null|array|bool +public function getCsrfToken(): array|bool ``` ### 描述 @@ -709,13 +755,13 @@ public function getCsrfToken(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getCredentials ```php -public function getCredentials(string $domain): null|array|bool +public function getCredentials(string $domain): array|bool ``` ### 描述 @@ -732,13 +778,13 @@ public function getCredentials(string $domain): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getRecord ```php -public function getRecord(mixed $file, mixed $out_format): null|array|bool +public function getRecord(string $file, string $out_format): array|bool ``` ### 描述 @@ -749,20 +795,20 @@ public function getRecord(mixed $file, mixed $out_format): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | -| out_format | mixed | | +| file | string | 文件 | +| out_format | string | 输出格式 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getImage ```php -public function getImage(mixed $file): null|array|bool +public function getImage(string $file): array|bool ``` ### 描述 @@ -773,19 +819,19 @@ public function getImage(mixed $file): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | +| file | string | 文件 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## canSendImage ```php -public function canSendImage(): null|array|bool +public function canSendImage(): array|bool ``` ### 描述 @@ -796,13 +842,13 @@ public function canSendImage(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## canSendRecord ```php -public function canSendRecord(): null|array|bool +public function canSendRecord(): array|bool ``` ### 描述 @@ -813,13 +859,13 @@ public function canSendRecord(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getStatus ```php -public function getStatus(): null|array|bool +public function getStatus(): array|bool ``` ### 描述 @@ -830,13 +876,13 @@ public function getStatus(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getVersionInfo ```php -public function getVersionInfo(): null|array|bool +public function getVersionInfo(): array|bool ``` ### 描述 @@ -847,13 +893,13 @@ public function getVersionInfo(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## setRestart ```php -public function setRestart(int $delay): null|array|bool +public function setRestart(int $delay): array|bool ``` ### 描述 @@ -864,19 +910,19 @@ public function setRestart(int $delay): null|array|bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| delay | int | | +| delay | int | 延迟时间(毫秒,默认为0) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## cleanCache ```php -public function cleanCache(): null|array|bool +public function cleanCache(): array|bool ``` ### 描述 @@ -887,7 +933,7 @@ public function cleanCache(): null|array|bool | 类型 | 描述 | | ---- | ----------- | -| null|array|bool | | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | ## getExtendedAPI @@ -911,4 +957,28 @@ public function getExtendedAPI(string $package_name): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| mixed | 返回包的操作对象 | + + +## callExtendedAPI + +```php +public function callExtendedAPI(string $action, array $params): array|bool +``` + +### 描述 + +作者很懒,什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| action | string | 动作(API)名称 | +| params | array | 参数 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|bool | 返回API调用结果(数组)或异步API调用状态(bool) | diff --git a/docs/api/ZM/API/TuringAPI.md b/docs/api/ZM/API/TuringAPI.md index c7262960..2ed8ab30 100644 --- a/docs/api/ZM/API/TuringAPI.md +++ b/docs/api/ZM/API/TuringAPI.md @@ -3,7 +3,7 @@ ## getTuringMsg ```php -public function getTuringMsg(mixed $msg, mixed $user_id, mixed $api): string +public function getTuringMsg(string $msg, int|string $user_id, string $api): string ``` ### 描述 @@ -14,12 +14,35 @@ public function getTuringMsg(mixed $msg, mixed $user_id, mixed $api): string | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| user_id | mixed | | -| api | mixed | | +| msg | string | 消息 | +| user_id | int|string | 用户ID | +| api | string | API Key | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | 图灵的回复 | + + +## getResultStatus + +```php +public function getResultStatus(array $r): bool|string +``` + +### 描述 + +作者很懒,什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| r | array | 数据API回包 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool|string | 错误消息或成功鸥鸟 | diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md index 798115c2..9485d01e 100644 --- a/docs/api/ZM/Annotation/AnnotationParser.md +++ b/docs/api/ZM/Annotation/AnnotationParser.md @@ -37,7 +37,7 @@ public function registerMods(): mixed ## addRegisterPath ```php -public function addRegisterPath(mixed $path, mixed $indoor_name): mixed +public function addRegisterPath(string $path, string $indoor_name): mixed ``` ### 描述 @@ -48,8 +48,8 @@ public function addRegisterPath(mixed $path, mixed $indoor_name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| path | mixed | | -| indoor_name | mixed | | +| path | string | 注册解析注解的路径 | +| indoor_name | string | 起始命名空间的名称 | ### 返回 @@ -61,7 +61,7 @@ public function addRegisterPath(mixed $path, mixed $indoor_name): mixed ## sortByLevel ```php -public function sortByLevel(mixed $events, string $class_name, string $prefix): mixed +public function sortByLevel(array $events, string $class_name, string $prefix): mixed ``` ### 描述 @@ -72,9 +72,9 @@ public function sortByLevel(mixed $events, string $class_name, string $prefix): | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| events | mixed | | -| class_name | string | | -| prefix | string | | +| events | array | 需要排序的 | +| class_name | string | 排序的类名 | +| prefix | string | 前缀 | ### 返回 diff --git a/docs/api/ZM/Context/Context.md b/docs/api/ZM/Context/Context.md index 08ead474..3715fdf9 100644 --- a/docs/api/ZM/Context/Context.md +++ b/docs/api/ZM/Context/Context.md @@ -37,7 +37,7 @@ public function getData(): mixed ## reply ```php -public function reply(mixed $msg, bool $yield): array|bool +public function reply(array|string $msg, bool|callable|Closure $yield): array|bool ``` ### 描述 @@ -48,20 +48,20 @@ only can used by cq->message event function | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| yield | bool | | +| msg | array|string | 要回复的消息 | +| yield | bool|callable|Closure | 是否协程挂起(true),是否绑定异步事件(Closure) | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|bool | | +| array|bool | 返回API调用结果 | ## finalReply ```php -public function finalReply(mixed $msg, bool $yield): mixed +public function finalReply(array|string $msg, bool $yield): mixed ``` ### 描述 @@ -72,8 +72,8 @@ public function finalReply(mixed $msg, bool $yield): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| yield | bool | | +| msg | array|string | 要回复的消息 | +| yield | bool | 是否协程挂起(true),是否绑定异步事件(Closure) | ### 返回 @@ -104,31 +104,31 @@ public function waitMessage(string $prompt, int $timeout, string $timeout_prompt | 类型 | 描述 | | ---- | ----------- | -| string | | +| string | 返回用户输入的内容 | ## getArgs ```php -public function getArgs(mixed $mode, mixed $prompt_msg): mixed|string +public function getArgs(int|string $mode, string|Stringable $prompt_msg): float|int|string ``` ### 描述 -作者很懒,什么也没有说 +根据选定的模式获取消息参数 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| mode | mixed | | -| prompt_msg | mixed | | +| mode | int|string | 获取的模式 | +| prompt_msg | string|Stringable | 提示语回复 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| mixed|string | | +| float|int|string | | ## getNextArg @@ -139,19 +139,19 @@ public function getNextArg(string $prompt_msg): int|mixed|string ### 描述 -作者很懒,什么也没有说 +获取下一个参数 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| prompt_msg | string | | +| prompt_msg | string | 提示语回复 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| int|mixed|string | | +| int|mixed|string | 返回获取的参数 | ## getFullArg @@ -162,19 +162,19 @@ public function getFullArg(string $prompt_msg): int|mixed|string ### 描述 -作者很懒,什么也没有说 +获取接下来所有的消息当成一个完整的参数(包含空格) ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| prompt_msg | string | | +| prompt_msg | string | 提示语回复 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| int|mixed|string | | +| int|mixed|string | 返回获取的参数 | ## getNumArg @@ -185,25 +185,25 @@ public function getNumArg(string $prompt_msg): int|mixed|string ### 描述 -作者很懒,什么也没有说 +获取下一个数字类型的参数 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| prompt_msg | string | | +| prompt_msg | string | 提示语回复 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| int|mixed|string | | +| int|mixed|string | 返回获取的参数 | ## cloneFromParent ```php -public function cloneFromParent(): mixed +public function cloneFromParent(): ContextInterface ``` ### 描述 @@ -214,4 +214,4 @@ public function cloneFromParent(): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| ContextInterface | 返回上下文 | diff --git a/docs/api/ZM/DB/DB.md b/docs/api/ZM/DB/DB.md index 4681bacb..1bfaf55e 100644 --- a/docs/api/ZM/DB/DB.md +++ b/docs/api/ZM/DB/DB.md @@ -3,7 +3,7 @@ ## initTableList ```php -public function initTableList(mixed $db_name): mixed +public function initTableList(string $db_name): mixed ``` ### 描述 @@ -14,7 +14,7 @@ public function initTableList(mixed $db_name): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| db_name | mixed | | +| db_name | string | 数据库名称 | ### 返回 @@ -26,7 +26,7 @@ public function initTableList(mixed $db_name): mixed ## table ```php -public function table(mixed $table_name): ZM\DB\Table +public function table(string $table_name): Table ``` ### 描述 @@ -37,19 +37,19 @@ public function table(mixed $table_name): ZM\DB\Table | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| table_name | mixed | | +| table_name | string | 表名 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| ZM\DB\Table | | +| Table | 返回表对象 | ## statement ```php -public function statement(mixed $line): mixed +public function statement(string $line): mixed ``` ### 描述 @@ -60,7 +60,7 @@ public function statement(mixed $line): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| line | mixed | | +| line | string | SQL语句 | ### 返回 @@ -72,7 +72,7 @@ public function statement(mixed $line): mixed ## unprepared ```php -public function unprepared(mixed $line): bool +public function unprepared(string $line): bool ``` ### 描述 @@ -83,10 +83,35 @@ public function unprepared(mixed $line): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| line | mixed | | +| line | string | SQL语句 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| bool | | +| bool | 返回查询是否成功的结果 | + + +## rawQuery + +```php +public function rawQuery(string $line, array $params, int $fetch_mode): array|false +``` + +### 描述 + +作者很懒,什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| line | string | SQL语句 | +| params | array | 查询参数 | +| fetch_mode | int | fetch规则 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array|false | 返回结果集或false | diff --git a/docs/api/ZM/DB/InsertBody.md b/docs/api/ZM/DB/InsertBody.md index c6477480..eb8838a2 100644 --- a/docs/api/ZM/DB/InsertBody.md +++ b/docs/api/ZM/DB/InsertBody.md @@ -3,7 +3,7 @@ ## __construct ```php -public function __construct(mixed $row, ZM\DB\Table $table): mixed +public function __construct(Table $table, array|string $row): mixed ``` ### 描述 @@ -14,8 +14,8 @@ InsertBody constructor. | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| row | mixed | | -| table | ZM\DB\Table | | +| table | Table | 表对象 | +| row | array|string | 行数据 | ### 返回 diff --git a/docs/api/ZM/Framework.md b/docs/api/ZM/Framework.md index 4e43d72e..a2547214 100644 --- a/docs/api/ZM/Framework.md +++ b/docs/api/ZM/Framework.md @@ -110,7 +110,7 @@ public function registerServerEvents(): mixed ## parseCliArgs ```php -public function parseCliArgs(mixed $args, mixed $add_port): mixed +public function parseCliArgs(array $args, bool|string $add_port): mixed ``` ### 描述 @@ -121,8 +121,8 @@ public function parseCliArgs(mixed $args, mixed $add_port): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| args | mixed | | -| add_port | mixed | | +| args | array | 命令行参数 | +| add_port | bool|string | 是否添加端口号 | ### 返回 diff --git a/docs/api/ZM/Http/Response.md b/docs/api/ZM/Http/Response.md index 4fb04281..f1f71ad4 100644 --- a/docs/api/ZM/Http/Response.md +++ b/docs/api/ZM/Http/Response.md @@ -17,60 +17,10 @@ public function initHeader(): mixed | mixed | | -## status - -```php -public function status(mixed $http_code, mixed $reason, mixed $params): mixed -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| http_code | mixed | | -| reason | mixed | | -| params | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - -## setStatusCode - -```php -public function setStatusCode(mixed $http_code, mixed $reason, mixed $params): mixed -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| http_code | mixed | | -| reason | mixed | | -| params | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| mixed | | - - ## header ```php -public function header(mixed $key, mixed $value, mixed $ucwords): mixed +public function header(array|string $value, null|array|string $ucwords, string $key): mixed ``` ### 描述 @@ -81,9 +31,9 @@ public function header(mixed $key, mixed $value, mixed $ucwords): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| key | mixed | | -| value | mixed | | -| ucwords | mixed | | +| value | array|string | | +| ucwords | null|array|string | | +| key | string | | ### 返回 @@ -95,7 +45,7 @@ public function header(mixed $key, mixed $value, mixed $ucwords): mixed ## setHeader ```php -public function setHeader(mixed $key, mixed $value, mixed $ucwords): mixed +public function setHeader(array|string $value, null|array|string $ucwords, string $key): mixed ``` ### 描述 @@ -106,9 +56,9 @@ public function setHeader(mixed $key, mixed $value, mixed $ucwords): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| key | mixed | | -| value | mixed | | -| ucwords | mixed | | +| value | array|string | | +| ucwords | null|array|string | | +| key | string | | ### 返回 @@ -120,7 +70,7 @@ public function setHeader(mixed $key, mixed $value, mixed $ucwords): mixed ## trailer ```php -public function trailer(mixed $key, mixed $value): mixed +public function trailer(array|string $value, string $key): mixed ``` ### 描述 @@ -131,8 +81,8 @@ public function trailer(mixed $key, mixed $value): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| key | mixed | | -| value | mixed | | +| value | array|string | | +| key | string | | ### 返回 @@ -161,7 +111,7 @@ public function ping(): mixed ## write ```php -public function write(mixed $content): mixed +public function write(string|Stringable $content): mixed ``` ### 描述 @@ -172,7 +122,7 @@ public function write(mixed $content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| content | mixed | | +| content | string|Stringable | | ### 返回 @@ -184,7 +134,7 @@ public function write(mixed $content): mixed ## end ```php -public function end(mixed $content): mixed +public function end(null|string|Stringable $content): mixed ``` ### 描述 @@ -195,7 +145,7 @@ public function end(mixed $content): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| content | mixed | | +| content | null|string|Stringable | | ### 返回 @@ -207,7 +157,7 @@ public function end(mixed $content): mixed ## sendfile ```php -public function sendfile(mixed $filename, mixed $offset, mixed $length): mixed +public function sendfile(null|int|string $offset, null|int|string $length, string $filename): mixed ``` ### 描述 @@ -218,9 +168,9 @@ public function sendfile(mixed $filename, mixed $offset, mixed $length): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| filename | mixed | | -| offset | mixed | | -| length | mixed | | +| offset | null|int|string | | +| length | null|int|string | | +| filename | string | | ### 返回 @@ -232,7 +182,7 @@ public function sendfile(mixed $filename, mixed $offset, mixed $length): mixed ## redirect ```php -public function redirect(mixed $location, mixed $http_code): mixed +public function redirect(string $location, int $http_code): mixed ``` ### 描述 @@ -243,8 +193,8 @@ public function redirect(mixed $location, mixed $http_code): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| location | mixed | | -| http_code | mixed | | +| location | string | | +| http_code | int | | ### 返回 @@ -313,7 +263,7 @@ public function upgrade(): mixed ## push ```php -public function push(mixed $data, null $opcode, null $flags): mixed +public function push(mixed $data, mixed $opcode, mixed $flags): mixed ``` ### 描述 @@ -325,8 +275,8 @@ public function push(mixed $data, null $opcode, null $flags): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | data | mixed | | -| opcode | null | | -| flags | null | | +| opcode | mixed | | +| flags | mixed | | ### 返回 diff --git a/docs/api/ZM/Module/ModulePacker.md b/docs/api/ZM/Module/ModulePacker.md index f797819c..62af1292 100644 --- a/docs/api/ZM/Module/ModulePacker.md +++ b/docs/api/ZM/Module/ModulePacker.md @@ -26,7 +26,7 @@ public function __construct(array $module): mixed ## setOutputPath ```php -public function setOutputPath(mixed $path): mixed +public function setOutputPath(string $path): mixed ``` ### 描述 @@ -37,7 +37,7 @@ public function setOutputPath(mixed $path): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| path | mixed | | +| path | string | 输出路径 | ### 返回 diff --git a/docs/api/ZM/Module/QQBot.md b/docs/api/ZM/Module/QQBot.md index 9c522160..255ebeb6 100644 --- a/docs/api/ZM/Module/QQBot.md +++ b/docs/api/ZM/Module/QQBot.md @@ -1,9 +1,26 @@ # ZM\Module\QQBot +## handleByEvent + +```php +public function handleByEvent(): mixed +``` + +### 描述 + +作者很懒,什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + ## handle ```php -public function handle(mixed $data, int $level): mixed +public function handle(array|Iterator $data, int $level): mixed ``` ### 描述 @@ -14,8 +31,8 @@ public function handle(mixed $data, int $level): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| data | mixed | | -| level | int | | +| data | array|Iterator | 数据包 | +| level | int | 递归等级 | ### 返回 @@ -27,7 +44,7 @@ public function handle(mixed $data, int $level): mixed ## dispatchBeforeEvents ```php -public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDispatcher +public function dispatchBeforeEvents(array|Iterator $data, string $time): ZM\Event\EventDispatcher ``` ### 描述 @@ -38,8 +55,8 @@ public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDi | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| data | mixed | | -| time | mixed | | +| data | array|Iterator | 数据包 | +| time | string | 类型(pre或post) | ### 返回 @@ -51,7 +68,7 @@ public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDi ## dispatchEvents ```php -public function dispatchEvents(mixed $data): mixed +public function dispatchEvents(array|Iterator $data): mixed ``` ### 描述 @@ -62,7 +79,7 @@ public function dispatchEvents(mixed $data): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| data | mixed | | +| data | array|Iterator | 数据包 | ### 返回 @@ -71,6 +88,29 @@ public function dispatchEvents(mixed $data): mixed | mixed | | +## dispatchAfterEvents + +```php +public function dispatchAfterEvents(mixed $data): ZM\Event\EventDispatcher +``` + +### 描述 + +作者很懒,什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| data | mixed | 分发事件数据包 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\Event\EventDispatcher | | + + ## dispatchAPIResponse ```php diff --git a/docs/api/ZM/MySQL/MySQLStatement.md b/docs/api/ZM/MySQL/MySQLStatement.md index 7b972737..2ed5de8e 100644 --- a/docs/api/ZM/MySQL/MySQLStatement.md +++ b/docs/api/ZM/MySQL/MySQLStatement.md @@ -1 +1,17 @@ -# ZM\MySQL\MySQLStatement \ No newline at end of file +# ZM\MySQL\MySQLStatement + +## current + +```php +public function current(): mixed +``` + +### 描述 + +作者很懒,什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/MySQL/MySQLWrapper.md b/docs/api/ZM/MySQL/MySQLWrapper.md index 50f7b169..c6f346c5 100644 --- a/docs/api/ZM/MySQL/MySQLWrapper.md +++ b/docs/api/ZM/MySQL/MySQLWrapper.md @@ -54,7 +54,7 @@ wrapper method ## setAutoCommit ```php -public function setAutoCommit(mixed $autoCommit): mixed +public function setAutoCommit(bool $auto_commit): mixed ``` ### 描述 @@ -65,7 +65,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| autoCommit | mixed | | +| auto_commit | bool | | ### 返回 @@ -169,7 +169,7 @@ wrapper method ## delete ```php -public function delete(mixed $table, array $criteria, array $types): int +public function delete(string $table, array $criteria, array $types): int ``` ### 描述 @@ -180,7 +180,7 @@ public function delete(mixed $table, array $criteria, array $types): int | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| table | mixed | | +| table | string | 表 | | criteria | array | | | types | array | | @@ -194,7 +194,7 @@ public function delete(mixed $table, array $criteria, array $types): int ## setTransactionIsolation ```php -public function setTransactionIsolation(mixed $level): int +public function setTransactionIsolation(int $level): int ``` ### 描述 @@ -205,7 +205,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| level | mixed | | +| level | int | Sets the transaction isolation level | ### 返回 @@ -234,7 +234,7 @@ wrapper method ## update ```php -public function update(mixed $table, array $data, array $criteria, array $types): int +public function update(string $table, array $data, array $criteria, array $types): int ``` ### 描述 @@ -245,7 +245,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| table | mixed | | +| table | string | 表名 | | data | array | | | criteria | array | | | types | array | | @@ -260,7 +260,7 @@ wrapper method ## insert ```php -public function insert(mixed $table, array $data, array $types): int +public function insert(string $table, array $data, array $types): int ``` ### 描述 @@ -271,7 +271,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| table | mixed | | +| table | string | 表名 | | data | array | | | types | array | | @@ -285,7 +285,7 @@ wrapper method ## quoteIdentifier ```php -public function quoteIdentifier(mixed $str): string +public function quoteIdentifier(string $str): string ``` ### 描述 @@ -296,7 +296,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| str | mixed | | +| str | string | The name to be quoted | ### 返回 @@ -308,7 +308,7 @@ wrapper method ## quote ```php -public function quote(mixed $value, int $type): mixed +public function quote(mixed $value, null|int|string|Type $type): mixed ``` ### 描述 @@ -320,7 +320,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | | value | mixed | | -| type | int | | +| type | null|int|string|Type | | ### 返回 @@ -329,333 +329,6 @@ wrapper method | mixed | | -## fetchAllNumeric - -```php -public function fetchAllNumeric(string $query, array $params, array $types): array -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociative - -```php -public function fetchAllAssociative(string $query, array $params, array $types): array -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllKeyValue - -```php -public function fetchAllKeyValue(string $query, array $params, array $types): array -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchAllAssociativeIndexed - -```php -public function fetchAllAssociativeIndexed(string $query, array $params, array $types): array -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## fetchFirstColumn - -```php -public function fetchFirstColumn(string $query, array $params, array $types): array -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| array | | - - -## iterateNumeric - -```php -public function iterateNumeric(string $query, array $params, array $types): Traversable -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociative - -```php -public function iterateAssociative(string $query, array $params, array $types): Traversable -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateKeyValue - -```php -public function iterateKeyValue(string $query, array $params, array $types): Traversable -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateAssociativeIndexed - -```php -public function iterateAssociativeIndexed(string $query, array $params, array $types): Traversable -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## iterateColumn - -```php -public function iterateColumn(string $query, array $params, array $types): Traversable -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| query | string | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Traversable | | - - -## executeQuery - -```php -public function executeQuery(mixed $sql, array $types, array $params, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\MySQL\MySQLStatementWrapper -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| types | array | | -| params | array | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\MySQL\MySQLStatementWrapper | | - - -## executeCacheQuery - -```php -public function executeCacheQuery(mixed $sql, mixed $params, mixed $types, Doctrine\DBAL\Cache\QueryCacheProfile $qcp): ZM\MySQL\MySQLStatementWrapper -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| params | mixed | | -| types | mixed | | -| qcp | Doctrine\DBAL\Cache\QueryCacheProfile | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| ZM\MySQL\MySQLStatementWrapper | | - - -## executeStatement - -```php -public function executeStatement(mixed $sql, array $params, array $types): int -``` - -### 描述 - -wrapper method - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| sql | mixed | | -| params | array | | -| types | array | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| int | | - - ## getTransactionNestingLevel ```php @@ -676,7 +349,7 @@ wrapper method ## lastInsertId ```php -public function lastInsertId(null $name): string +public function lastInsertId(null|string $name): false|int|string ``` ### 描述 @@ -687,13 +360,13 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| name | null | | +| name | null|string | name of the sequence object from which the ID should be returned | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| string | | +| false|int|string | a string representation of the last inserted ID | ## transactional @@ -722,7 +395,7 @@ overwrite method to $this->connection->transactional() ## setNestTransactionsWithSavepoints ```php -public function setNestTransactionsWithSavepoints(mixed $nestTransactionsWithSavepoints): mixed +public function setNestTransactionsWithSavepoints(bool $nest_transactions_with_savepoints): mixed ``` ### 描述 @@ -733,7 +406,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| nestTransactionsWithSavepoints | mixed | | +| nest_transactions_with_savepoints | bool | | ### 返回 @@ -813,7 +486,7 @@ wrapper method ## createSavepoint ```php -public function createSavepoint(mixed $savepoint): mixed +public function createSavepoint(string $savepoint): mixed ``` ### 描述 @@ -824,7 +497,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| savepoint | mixed | | +| savepoint | string | the name of the savepoint to create | ### 返回 @@ -836,7 +509,7 @@ wrapper method ## releaseSavepoint ```php -public function releaseSavepoint(mixed $savepoint): mixed +public function releaseSavepoint(string $savepoint): mixed ``` ### 描述 @@ -847,7 +520,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| savepoint | mixed | | +| savepoint | string | the name of the savepoint to release | ### 返回 @@ -859,7 +532,7 @@ wrapper method ## rollbackSavepoint ```php -public function rollbackSavepoint(mixed $savepoint): mixed +public function rollbackSavepoint(string $savepoint): mixed ``` ### 描述 @@ -870,7 +543,7 @@ wrapper method | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| savepoint | mixed | | +| savepoint | string | the name of the savepoint to rollback to | ### 返回 diff --git a/docs/api/ZM/Store/LightCache.md b/docs/api/ZM/Store/LightCache.md index 8e9b95d0..5f4f6587 100644 --- a/docs/api/ZM/Store/LightCache.md +++ b/docs/api/ZM/Store/LightCache.md @@ -3,7 +3,7 @@ ## init ```php -public function init(mixed $config): bool|mixed +public function init(array $config): bool|mixed ``` ### 描述 @@ -14,13 +14,13 @@ public function init(mixed $config): bool|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| config | mixed | | +| config | array | 配置 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| bool|mixed | | +| bool|mixed | 返回失败(false)或创建SwooleTable成功结果 | ## get diff --git a/docs/api/ZM/Store/LightCacheInside.md b/docs/api/ZM/Store/LightCacheInside.md index 6a787ba4..8529418c 100644 --- a/docs/api/ZM/Store/LightCacheInside.md +++ b/docs/api/ZM/Store/LightCacheInside.md @@ -27,7 +27,7 @@ public function get(string $table, string $key): null|mixed ## set ```php -public function set(array|int|string $value, string $table, string $key): mixed +public function set(array|int|string $value, string $table, string $key): bool ``` ### 描述 @@ -46,13 +46,13 @@ public function set(array|int|string $value, string $table, string $key): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| bool | | ## createTable ```php -public function createTable(mixed $name, mixed $size, mixed $str_size, int $conflict_proportion): mixed +public function createTable(float|int $conflict_proportion, string $name, int $size, int $str_size): mixed ``` ### 描述 @@ -63,10 +63,10 @@ public function createTable(mixed $name, mixed $size, mixed $str_size, int $conf | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| name | mixed | | -| size | mixed | | -| str_size | mixed | | -| conflict_proportion | int | | +| conflict_proportion | float|int | | +| name | string | | +| size | int | | +| str_size | int | | ### 返回 diff --git a/docs/api/ZM/Store/ZMAtomic.md b/docs/api/ZM/Store/ZMAtomic.md index c1036303..70b1c874 100644 --- a/docs/api/ZM/Store/ZMAtomic.md +++ b/docs/api/ZM/Store/ZMAtomic.md @@ -1,28 +1,5 @@ # ZM\Store\ZMAtomic -## get - -```php -public function get(mixed $name): Swoole\Atomic -``` - -### 描述 - -作者很懒,什么也没有说 - -### 参数 - -| 名称 | 类型 | 描述 | -| -------- | ---- | ----------- | -| name | mixed | | - -### 返回 - -| 类型 | 描述 | -| ---- | ----------- | -| Swoole\Atomic | | - - ## init ```php diff --git a/docs/api/ZM/Utils/DataProvider.md b/docs/api/ZM/Utils/DataProvider.md index eaf2d081..e4ee4501 100644 --- a/docs/api/ZM/Utils/DataProvider.md +++ b/docs/api/ZM/Utils/DataProvider.md @@ -111,7 +111,7 @@ public function getDataFolder(string $second): null|array|false|mixed|string ## saveToJson ```php -public function saveToJson(mixed $filename, mixed $file_array): false|int +public function saveToJson(string $filename, array|int|Iterator|JsonSerializable|string|Traversable $file_array): false|int ``` ### 描述 @@ -122,20 +122,20 @@ public function saveToJson(mixed $filename, mixed $file_array): false|int | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| filename | mixed | | -| file_array | mixed | | +| filename | string | 文件名 | +| file_array | array|int|Iterator|JsonSerializable|string|Traversable | 文件内容数组 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| false|int | | +| false|int | 返回文件大小或false | ## loadFromJson ```php -public function loadFromJson(mixed $filename): null|mixed +public function loadFromJson(string $filename): null|mixed ``` ### 描述 @@ -146,19 +146,19 @@ public function loadFromJson(mixed $filename): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| filename | mixed | | +| filename | string | 文件名 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| null|mixed | | +| null|mixed | 返回文件内容数据或null | ## scanDirFiles ```php -public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive): array|false +public function scanDirFiles(string $dir, bool $recursive, bool|string $relative): array|false ``` ### 描述 @@ -169,9 +169,9 @@ public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive) | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| dir | mixed | | -| relative | bool|string | | -| recursive | bool | | +| dir | string | 目录 | +| recursive | bool | 是否递归扫描子目录 | +| relative | bool|string | 是否返回相对目录,如果为true则返回相对目录,如果为false则返回绝对目录 | ### 返回 @@ -183,7 +183,7 @@ public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive) ## isRelativePath ```php -public function isRelativePath(mixed $path): bool +public function isRelativePath(string $path): bool ``` ### 描述 @@ -194,10 +194,10 @@ public function isRelativePath(mixed $path): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| path | mixed | | +| path | string | 路径 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| bool | | +| bool | 返回结果 | diff --git a/docs/api/ZM/Utils/HttpUtil.md b/docs/api/ZM/Utils/HttpUtil.md index ed1fc778..b7a4802e 100644 --- a/docs/api/ZM/Utils/HttpUtil.md +++ b/docs/api/ZM/Utils/HttpUtil.md @@ -30,7 +30,7 @@ public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $nod ## handleStaticPage ```php -public function handleStaticPage(mixed $uri, Response|\Swoole\Http\Response $response, array $settings): bool +public function handleStaticPage(Response|\Swoole\Http\Response $response, string $uri, array $settings): bool ``` ### 描述 @@ -41,8 +41,8 @@ public function handleStaticPage(mixed $uri, Response|\Swoole\Http\Response $res | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| uri | mixed | | | response | Response|\Swoole\Http\Response | | +| uri | string | | | settings | array | | ### 返回 diff --git a/docs/api/ZM/Utils/Manager/ModuleManager.md b/docs/api/ZM/Utils/Manager/ModuleManager.md index 1046a4d9..924ecd06 100644 --- a/docs/api/ZM/Utils/Manager/ModuleManager.md +++ b/docs/api/ZM/Utils/Manager/ModuleManager.md @@ -44,7 +44,7 @@ public function packModule(array $module, string $target): bool ## unpackModule ```php -public function unpackModule(mixed $module, array $options): array|false +public function unpackModule(array|Iterator $module, array $options): array|false ``` ### 描述 @@ -55,11 +55,11 @@ public function unpackModule(mixed $module, array $options): array|false | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| module | mixed | | +| module | array|Iterator | 模块信息 | | options | array | | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|false | | +| array|false | 返回解包的信息或false | diff --git a/docs/api/ZM/Utils/Manager/WorkerManager.md b/docs/api/ZM/Utils/Manager/WorkerManager.md index 384d21e8..34a38c33 100644 --- a/docs/api/ZM/Utils/Manager/WorkerManager.md +++ b/docs/api/ZM/Utils/Manager/WorkerManager.md @@ -3,7 +3,7 @@ ## workerAction ```php -public function workerAction(mixed $src_worker_id, mixed $data): mixed +public function workerAction(int $src_worker_id, array $data): mixed ``` ### 描述 @@ -14,8 +14,8 @@ Worker 进程间通信触发的动作类型函数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| src_worker_id | mixed | | -| data | mixed | | +| src_worker_id | int | 源 Worker 进程 ID | +| data | array | 数据 | ### 返回 @@ -27,7 +27,7 @@ Worker 进程间通信触发的动作类型函数 ## sendActionToWorker ```php -public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data): mixed +public function sendActionToWorker(int $worker_id, string $action, mixed $data): mixed ``` ### 描述 @@ -38,9 +38,9 @@ public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data) | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| worker_id | mixed | | -| action | mixed | | -| data | mixed | | +| worker_id | int | 进程ID | +| action | string | 动作 | +| data | mixed | 参数 | ### 返回 diff --git a/docs/api/ZM/Utils/MessageUtil.md b/docs/api/ZM/Utils/MessageUtil.md index 99ffc232..ab28782d 100644 --- a/docs/api/ZM/Utils/MessageUtil.md +++ b/docs/api/ZM/Utils/MessageUtil.md @@ -3,7 +3,7 @@ ## downloadCQImage ```php -public function downloadCQImage(mixed $msg, string $path): array|false +public function downloadCQImage(array|string $msg, null|string $path): array|false ``` ### 描述 @@ -14,20 +14,20 @@ public function downloadCQImage(mixed $msg, string $path): array|false | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| path | string | | +| msg | array|string | 消息或消息数组 | +| path | null|string | 保存路径 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array|false | | +| array|false | 返回图片信息或失败返回false | ## containsImage ```php -public function containsImage(mixed $msg): bool +public function containsImage(array|string $msg): bool ``` ### 描述 @@ -38,7 +38,7 @@ public function containsImage(mixed $msg): bool | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | +| msg | array|string | 消息或消息数组 | ### 返回 @@ -50,7 +50,7 @@ public function containsImage(mixed $msg): bool ## getImageCQFromLocal ```php -public function getImageCQFromLocal(mixed $file, int $type): string +public function getImageCQFromLocal(string $file, int $type): string ``` ### 描述 @@ -64,8 +64,8 @@ type == 2 : 返回图片的 http://xxx CQ 码(默认为 /images/ 路径就是 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| file | mixed | | -| type | int | | +| file | string | 文件数据 | +| type | int | 文件类型(0,1,2可选,默认为0) | ### 返回 @@ -77,7 +77,7 @@ type == 2 : 返回图片的 http://xxx CQ 码(默认为 /images/ 路径就是 ## splitCommand ```php -public function splitCommand(mixed $msg): array|string[] +public function splitCommand(string $msg): array|string[] ``` ### 描述 @@ -88,7 +88,7 @@ public function splitCommand(mixed $msg): array|string[] | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | +| msg | string | 消息内容 | ### 返回 @@ -100,19 +100,19 @@ public function splitCommand(mixed $msg): array|string[] ## matchCommand ```php -public function matchCommand(mixed $msg, mixed $obj): ZM\Entity\MatchResult +public function matchCommand(array|string $msg, array|Iterator $obj): ZM\Entity\MatchResult ``` ### 描述 -作者很懒,什么也没有说 +根据CQCommand的规则匹配消息,获取是否匹配到对应的注解事件 ### 参数 | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| obj | mixed | | +| msg | array|string | 消息内容 | +| obj | array|Iterator | 数据对象 | ### 返回 @@ -124,7 +124,7 @@ public function matchCommand(mixed $msg, mixed $obj): ZM\Entity\MatchResult ## addShortCommand ```php -public function addShortCommand(mixed $command, string $reply): mixed +public function addShortCommand(string $command, string $reply): mixed ``` ### 描述 @@ -135,8 +135,8 @@ public function addShortCommand(mixed $command, string $reply): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| command | mixed | | -| reply | string | | +| command | string | 命令内容 | +| reply | string | 回复内容 | ### 返回 @@ -148,7 +148,7 @@ public function addShortCommand(mixed $command, string $reply): mixed ## strToArray ```php -public function strToArray(mixed $msg, false $trim_text, bool $ignore_space): array +public function strToArray(string $msg, bool $ignore_space, bool $trim_text): array ``` ### 描述 @@ -159,15 +159,15 @@ public function strToArray(mixed $msg, false $trim_text, bool $ignore_space): ar | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| msg | mixed | | -| trim_text | false | | -| ignore_space | bool | | +| msg | string | 消息内容 | +| ignore_space | bool | 是否忽略空行 | +| trim_text | bool | 是否去除空格 | ### 返回 | 类型 | 描述 | | ---- | ----------- | -| array | | +| array | 返回数组 | ## arrayToStr diff --git a/docs/api/ZM/Utils/SignalListener.md b/docs/api/ZM/Utils/SignalListener.md index 9899144c..eba3013e 100644 --- a/docs/api/ZM/Utils/SignalListener.md +++ b/docs/api/ZM/Utils/SignalListener.md @@ -43,7 +43,7 @@ public function signalManager(): mixed ## signalWorker ```php -public function signalWorker(mixed $worker_id, Swoole\Server $server): mixed +public function signalWorker(int $worker_id, Swoole\Server $server): mixed ``` ### 描述 @@ -54,7 +54,7 @@ public function signalWorker(mixed $worker_id, Swoole\Server $server): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| worker_id | mixed | | +| worker_id | int | 当前进程的ID | | server | Swoole\Server | | ### 返回 diff --git a/docs/api/ZM/Utils/Terminal.md b/docs/api/ZM/Utils/Terminal.md index 7f3e73e3..3c0cedd7 100644 --- a/docs/api/ZM/Utils/Terminal.md +++ b/docs/api/ZM/Utils/Terminal.md @@ -77,7 +77,7 @@ public function testlog(): mixed ## call ```php -public function call(mixed $it): mixed +public function call(array $it): mixed ``` ### 描述 @@ -88,7 +88,7 @@ public function call(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| it | mixed | | +| it | array | | ### 返回 @@ -100,7 +100,7 @@ public function call(mixed $it): mixed ## level ```php -public function level(mixed $it): mixed +public function level(array $it): mixed ``` ### 描述 @@ -111,7 +111,7 @@ public function level(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| it | mixed | | +| it | array | | ### 返回 @@ -123,7 +123,7 @@ public function level(mixed $it): mixed ## bc ```php -public function bc(mixed $it): mixed +public function bc(array $it): mixed ``` ### 描述 @@ -134,7 +134,7 @@ public function bc(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| it | mixed | | +| it | array | | ### 返回 @@ -146,7 +146,7 @@ public function bc(mixed $it): mixed ## echoI ```php -public function echoI(mixed $it): mixed +public function echoI(array $it): mixed ``` ### 描述 @@ -157,7 +157,7 @@ public function echoI(mixed $it): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| it | mixed | | +| it | array | | ### 返回 diff --git a/docs/api/ZM/Utils/ZMUtil.md b/docs/api/ZM/Utils/ZMUtil.md index 5d0c3e54..2e4984b2 100644 --- a/docs/api/ZM/Utils/ZMUtil.md +++ b/docs/api/ZM/Utils/ZMUtil.md @@ -60,7 +60,7 @@ public function getReloadableFiles(): string[]|string[][] ## getClassesPsr4 ```php -public function getClassesPsr4(mixed $dir, mixed $base_namespace, null|mixed $rule, bool $return_path_value): string[] +public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $rule, bool $return_path_value): string[] ``` ### 描述 @@ -71,10 +71,10 @@ public function getClassesPsr4(mixed $dir, mixed $base_namespace, null|mixed $ru | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| dir | mixed | | -| base_namespace | mixed | | -| rule | null|mixed | | -| return_path_value | bool | | +| dir | string | 目录 | +| base_namespace | string | 基础命名空间 | +| rule | null|mixed | 规则 | +| return_path_value | bool | 是否返回文件路径 | ### 返回