From 2fedfe5b18c8824087dc2c7a890dd61e83cbff0c Mon Sep 17 00:00:00 2001 From: Github Build Bot Date: Mon, 11 Apr 2022 14:03:47 +0000 Subject: [PATCH] update api docs --- docs/.vuepress/api.js | 2 +- .../ZM/API/Proxies/Bot/AbstractBotProxy.md | 117 ++++++++++++++++++ docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md | 24 ++++ docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md | 24 ++++ docs/api/ZM/API/ZMRobot.md | 47 ++++++- 5 files changed, 212 insertions(+), 2 deletions(-) create mode 100644 docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md create mode 100644 docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md create mode 100644 docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index 7f19be77..a360f8f6 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/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 +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ConsoleApplication","ZM/ZMServer","ZM/Framework"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/OneBotV11","ZM/API/GoCqhttpAPIV11","ZM/API/ZMRobot","ZM/API/CQ","ZM/API/TuringAPI"]},{"title":"ZM/API/Proxies/Bot","collapsable":true,"children":["ZM/API/Proxies/Bot/AllGroupsProxy","ZM/API/Proxies/Bot/AllBotsProxy","ZM/API/Proxies/Bot/AbstractBotProxy"]},{"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/ModulePackCommand","ZM/Command/Module/ModuleListCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/UpdateBody","ZM/DB/DeleteBody","ZM/DB/DB","ZM/DB/SelectBody","ZM/DB/InsertBody","ZM/DB/Table"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventDispatcher","ZM/Event/EventManager","ZM/Event/EventTracer"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnTask","ZM/Event/SwooleEvent/OnWorkerStart"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModuleUnpacker","ZM/Module/QQBot","ZM/Module/ModuleBase","ZM/Module/ModulePacker"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLStatementWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCacheInside","ZM/Store/ZMAtomic","ZM/Store/LightCache"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/Terminal","ZM/Utils/ZMUtil","ZM/Utils/SignalListener","ZM/Utils/CoMessage","ZM/Utils/MessageUtil","ZM/Utils/DataProvider","ZM/Utils/HttpUtil"]},{"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/Proxies/Bot/AbstractBotProxy.md b/docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md new file mode 100644 index 00000000..a4147b2f --- /dev/null +++ b/docs/api/ZM/API/Proxies/Bot/AbstractBotProxy.md @@ -0,0 +1,117 @@ +# ZM\API\Proxies\Bot\AbstractBotProxy + +## __construct + +```php +public function __construct(AbstractBotProxy|ZMRobot $bot): mixed +``` + +### 描述 + +构造函数 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| bot | AbstractBotProxy|ZMRobot | 调用此代理的机器人实例 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## __call + +```php +public function __call(string $name, array $arguments): mixed +``` + +### 描述 + +在传入的机器人实例上调用方法 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 方法名 | +| arguments | array | 参数 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## __get + +```php +public function __get(string $name): mixed +``` + +### 描述 + +获取传入的机器人实例的属性 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 属性名 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## __set + +```php +public function __set(string $name, mixed $value): mixed +``` + +### 描述 + +设置传入的机器人实例的属性 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 属性名 | +| value | mixed | 属性值 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | | + + +## __isset + +```php +public function __isset(string $name): bool +``` + +### 描述 + +判断传入的机器人实例的属性是否存在 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 属性名 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| bool | | diff --git a/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md b/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md new file mode 100644 index 00000000..70a53db9 --- /dev/null +++ b/docs/api/ZM/API/Proxies/Bot/AllBotsProxy.md @@ -0,0 +1,24 @@ +# ZM\API\Proxies\Bot\AllBotsProxy + +## __call + +```php +public function __call(string $name, array $arguments): array +``` + +### 描述 + +在所有机器人实例上调用方法 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 方法名 | +| arguments | array | 参数 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | 返回一个包含所有执行结果的数组，键名为机器人ID | diff --git a/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md b/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md new file mode 100644 index 00000000..21d7c563 --- /dev/null +++ b/docs/api/ZM/API/Proxies/Bot/AllGroupsProxy.md @@ -0,0 +1,24 @@ +# ZM\API\Proxies\Bot\AllGroupsProxy + +## __call + +```php +public function __call(string $name, array $arguments): array +``` + +### 描述 + +在传入的机器人实例上调用方法 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| name | string | 方法名 | +| arguments | array | 参数 | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| array | 返回一个包含所有执行结果的数组，键名为群号 | diff --git a/docs/api/ZM/API/ZMRobot.md b/docs/api/ZM/API/ZMRobot.md index ae8c7946..0d5f7b1d 100644 --- a/docs/api/ZM/API/ZMRobot.md +++ b/docs/api/ZM/API/ZMRobot.md @@ -1 +1,46 @@ -# ZM\API\ZMRobot \ No newline at end of file +# ZM\API\ZMRobot + +## all + +```php +public function all(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllBotsProxy +``` + +### 描述 + +获取一个会在所有机器人实例上执行的代理 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| proxy | ZM\API\Proxies\Bot\AbstractBotProxy | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\API\Proxies\Bot\AllBotsProxy | | + + +## allGroups + +```php +public function allGroups(ZM\API\Proxies\Bot\AbstractBotProxy $proxy): ZM\API\Proxies\Bot\AllGroupsProxy +``` + +### 描述 + +获取一个会在所有群上执行的代理 + +### 参数 + +| 名称 | 类型 | 描述 | +| -------- | ---- | ----------- | +| proxy | ZM\API\Proxies\Bot\AbstractBotProxy | | + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| ZM\API\Proxies\Bot\AllGroupsProxy | |