zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-03-17 20:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

update api docs

Browse Source
This commit is contained in:
crazywhalecc 2022-12-19 06:01:59 +00:00 committed by github-actions[bot]
parent 208ccd6642
commit 463ee0cced
6 changed files with 138 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/api/ZM/Annotation/AnnotationMap.md
View File

@ -21,3 +21,20 @@ public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser):
| 类型 | 描述 |
| ---- | ----------- |
| void | |
## sortAnnotationList
```php
public function sortAnnotationList(): void
```
### 描述
作者很懒，什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |

34
docs/api/ZM/Annotation/AnnotationParser.md
View File

@ -26,7 +26,7 @@ public function __construct(bool $with_internal_parsers): mixed
## addSpecialParser
```php
public function addSpecialParser(string $class_name, callable $callback): mixed
public function addSpecialParser(string $class_name, callable $callback): void
```
### 描述
@ -44,7 +44,7 @@ public function addSpecialParser(string $class_name, callable $callback): mixed
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| void | |
## parseAll
@ -105,31 +105,6 @@ public function addRegisterPath(string $path, string $indoor_name): mixed
| mixed | |
## sortByLevel
```php
public function sortByLevel(array $events, string $class_name, string $prefix): mixed
```
### 描述
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| events | array | |
| class_name | string | |
| prefix | string | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getUsedTime
```php
@ -167,7 +142,7 @@ public function getAnnotationMap(): array
## addRouteAnnotation
```php
public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): void
public function addRouteAnnotation(ZM\Annotation\Http\Route $vss, array $same_method_annotations): mixed
```
### 描述
@ -179,9 +154,10 @@ public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): void
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| vss | ZM\Annotation\Http\Route | |
| same_method_annotations | array | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |
| mixed | |

23
docs/api/ZM/Event/Listener/WSEventListener.md
View File

@ -23,6 +23,29 @@ public function onWebSocketOpen(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent
| void | |
## onWebSocketClose
```php
public function onWebSocketClose(OneBot\Driver\Event\WebSocket\WebSocketCloseEvent $event): void
```
### 描述
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\WebSocket\WebSocketCloseEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| void | |
## getInstance
```php

12
docs/api/ZM/Event/Listener/WorkerEventListener.md
View File

@ -3,7 +3,7 @@
## onWorkerStart999
```php
public function onWorkerStart999(): mixed
public function onWorkerStart999(): void
```
### 描述
@ -14,7 +14,7 @@ public function onWorkerStart999(): mixed
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| void | |
## onWorkerStop999
@ -54,7 +54,7 @@ public function initUserPlugins(): mixed
## dispatchInit
```php
public function dispatchInit(): mixed
public function dispatchInit(): void
```
### 描述
@ -65,13 +65,13 @@ public function dispatchInit(): mixed
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| void | |
## initConnectionPool
```php
public function initConnectionPool(): mixed
public function initConnectionPool(): void
```
### 描述
@ -82,7 +82,7 @@ public function initConnectionPool(): mixed
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| void | |
## getInstance

64
docs/api/ZM/Plugin/OneBot12Adapter.md
View File

@ -1,5 +1,69 @@
# ZM\Plugin\OneBot12Adapter
## parseBotCommand
```php
public function parseBotCommand(ZM\Annotation\OneBot\BotCommand $command, array $same_method_annotations): bool
```
### 描述
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| command | ZM\Annotation\OneBot\BotCommand | |
| same_method_annotations | array | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| bool | |
## parseCommandArgument
```php
public function parseCommandArgument(): bool
```
### 描述
作者很懒，什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| bool | |
## handleUnknownWSReverseInput
```php
public function handleUnknownWSReverseInput(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): mixed
```
### 描述
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## handleWSReverseInput
```php

23
docs/api/ZM/Plugin/PluginManager.md
View File

@ -1,5 +1,28 @@
# ZM\Plugin\PluginManager
## addPluginsFromDir
```php
public function addPluginsFromDir(string $dir): int
```
### 描述
作者很懒，什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| dir | string | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| int | |
## addPlugin
```php