From bcaaf88edb4ecc3285de31b9352f99bceb667663 Mon Sep 17 00:00:00 2001 From: Github Build Bot Date: Sat, 2 Apr 2022 18:25:06 +0000 Subject: [PATCH] update api docs --- docs/.vuepress/api.js | 2 +- docs/api/ZM/API/CQ.md | 4 +- docs/api/ZM/DB/SelectBody.md | 8 +-- docs/api/ZM/Framework.md | 4 +- docs/api/ZM/MySQL/MySQLConnection.md | 94 +++++++++++++++++++++++++++- docs/api/ZM/Utils/ZMUtil.md | 4 +- 6 files changed, 104 insertions(+), 12 deletions(-) diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 6bcc06b1..7f19be77 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/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 +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/MySQLConnection","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/CQ.md b/docs/api/ZM/API/CQ.md index 3859cd98..531a3369 100644 --- a/docs/api/ZM/API/CQ.md +++ b/docs/api/ZM/API/CQ.md @@ -573,7 +573,7 @@ public function removeCQ(string $msg): string ## getCQ ```php -public function getCQ(string $msg, bool $is_object): array|CQObject +public function getCQ(string $msg, bool $is_object): null|array|CQObject ``` ### 描述 @@ -591,7 +591,7 @@ public function getCQ(string $msg, bool $is_object): array|CQObject | 类型 | 描述 | | ---- | ----------- | -| array|CQObject | 返回的CQ码（数组或对象） | +| null|array|CQObject | 返回的CQ码（数组或对象） | ## getAllCQ diff --git a/docs/api/ZM/DB/SelectBody.md b/docs/api/ZM/DB/SelectBody.md index 439d68b7..f21c67dc 100644 --- a/docs/api/ZM/DB/SelectBody.md +++ b/docs/api/ZM/DB/SelectBody.md @@ -37,7 +37,7 @@ public function count(): int ## fetchAll ```php -public function fetchAll(int $fetch_mode): mixed +public function fetchAll(mixed $fetch_mode): mixed ``` ### 描述 @@ -48,7 +48,7 @@ public function fetchAll(int $fetch_mode): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| fetch_mode | int | | +| fetch_mode | mixed | | ### 返回 @@ -77,7 +77,7 @@ public function fetchFirst(): null|mixed ## value ```php -public function value(null $key): null|mixed +public function value(null|mixed $key): null|mixed ``` ### 描述 @@ -88,7 +88,7 @@ public function value(null $key): null|mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| key | null | | +| key | null|mixed | | ### 返回 diff --git a/docs/api/ZM/Framework.md b/docs/api/ZM/Framework.md index a2547214..f4c1b71e 100644 --- a/docs/api/ZM/Framework.md +++ b/docs/api/ZM/Framework.md @@ -52,7 +52,7 @@ public function getProcessState(mixed $id_or_name, int $type): false|int|mixed ## removeProcessState ```php -public function removeProcessState(null $id_or_name, int $type): mixed +public function removeProcessState(null|int|string $id_or_name, int $type): mixed ``` ### 描述 @@ -63,7 +63,7 @@ public function removeProcessState(null $id_or_name, int $type): mixed | 名称 | 类型 | 描述 | | -------- | ---- | ----------- | -| id_or_name | null | | +| id_or_name | null|int|string | | | type | int | | ### 返回 diff --git a/docs/api/ZM/MySQL/MySQLConnection.md b/docs/api/ZM/MySQL/MySQLConnection.md index d97731bd..5c155058 100644 --- a/docs/api/ZM/MySQL/MySQLConnection.md +++ b/docs/api/ZM/MySQL/MySQLConnection.md @@ -1 +1,93 @@ -# ZM\MySQL\MySQLConnection \ No newline at end of file +# ZM\MySQL\MySQLConnection + +## prepare + +```php +public function prepare(mixed $sql, mixed $options): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| sql | mixed | | +| options | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## query + +```php +public function query(mixed $args): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| args | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## exec + +```php +public function exec(mixed $sql): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| sql | mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## lastInsertId + +```php +public function lastInsertId(null|mixed $name): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | null|mixed | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | diff --git a/docs/api/ZM/Utils/ZMUtil.md b/docs/api/ZM/Utils/ZMUtil.md index 2e4984b2..2c7c12f3 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(string $dir, string $base_namespace, null|mixed $rule, bool $return_path_value): string[] +public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $rule, bool|string $return_path_value): string[] ``` ### 描述 @@ -74,7 +74,7 @@ public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $ | dir | string | 目录 | | base_namespace | string | 基础命名空间 | | rule | null|mixed | 规则 | -| return_path_value | bool | 是否返回文件路径 | +| return_path_value | bool|string | 是否返回文件路径，返回文件路径的话传入字符串 | ### 返回