mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-23 00:25:35 +08:00
update api docs
This commit is contained in:
committed by
github-actions[bot]
parent
208ccd6642
commit
463ee0cced
@@ -21,3 +21,20 @@ public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser):
|
|||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| void | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## sortAnnotationList
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function sortAnnotationList(): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ public function __construct(bool $with_internal_parsers): mixed
|
|||||||
## addSpecialParser
|
## addSpecialParser
|
||||||
|
|
||||||
```php
|
```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
|
## parseAll
|
||||||
@@ -105,31 +105,6 @@ public function addRegisterPath(string $path, string $indoor_name): mixed
|
|||||||
| mixed | |
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
## sortByLevel
|
|
||||||
|
|
||||||
```php
|
|
||||||
public function sortByLevel(array $events, string $class_name, string $prefix): mixed
|
|
||||||
```
|
|
||||||
|
|
||||||
### 描述
|
|
||||||
|
|
||||||
作者很懒,什么也没有说
|
|
||||||
|
|
||||||
### 参数
|
|
||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
|
||||||
| -------- | ---- | ----------- |
|
|
||||||
| events | array | |
|
|
||||||
| class_name | string | |
|
|
||||||
| prefix | string | |
|
|
||||||
|
|
||||||
### 返回
|
|
||||||
|
|
||||||
| 类型 | 描述 |
|
|
||||||
| ---- | ----------- |
|
|
||||||
| mixed | |
|
|
||||||
|
|
||||||
|
|
||||||
## getUsedTime
|
## getUsedTime
|
||||||
|
|
||||||
```php
|
```php
|
||||||
@@ -167,7 +142,7 @@ public function getAnnotationMap(): array
|
|||||||
## addRouteAnnotation
|
## addRouteAnnotation
|
||||||
|
|
||||||
```php
|
```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 | |
|
| vss | ZM\Annotation\Http\Route | |
|
||||||
|
| same_method_annotations | array | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| void | |
|
| mixed | |
|
||||||
|
|||||||
@@ -23,6 +23,29 @@ public function onWebSocketOpen(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent
|
|||||||
| void | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## onWebSocketClose
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function onWebSocketClose(OneBot\Driver\Event\WebSocket\WebSocketCloseEvent $event): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| event | OneBot\Driver\Event\WebSocket\WebSocketCloseEvent | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
## getInstance
|
## getInstance
|
||||||
|
|
||||||
```php
|
```php
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## onWorkerStart999
|
## onWorkerStart999
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function onWorkerStart999(): mixed
|
public function onWorkerStart999(): void
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -14,7 +14,7 @@ public function onWorkerStart999(): mixed
|
|||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| mixed | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
## onWorkerStop999
|
## onWorkerStop999
|
||||||
@@ -54,7 +54,7 @@ public function initUserPlugins(): mixed
|
|||||||
## dispatchInit
|
## dispatchInit
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function dispatchInit(): mixed
|
public function dispatchInit(): void
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -65,13 +65,13 @@ public function dispatchInit(): mixed
|
|||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| mixed | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
## initConnectionPool
|
## initConnectionPool
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function initConnectionPool(): mixed
|
public function initConnectionPool(): void
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -82,7 +82,7 @@ public function initConnectionPool(): mixed
|
|||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| mixed | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
## getInstance
|
## getInstance
|
||||||
|
|||||||
@@ -1,5 +1,69 @@
|
|||||||
# ZM\Plugin\OneBot12Adapter
|
# 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
|
## handleWSReverseInput
|
||||||
|
|
||||||
```php
|
```php
|
||||||
|
|||||||
@@ -1,5 +1,28 @@
|
|||||||
# ZM\Plugin\PluginManager
|
# ZM\Plugin\PluginManager
|
||||||
|
|
||||||
|
## addPluginsFromDir
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function addPluginsFromDir(string $dir): int
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| dir | string | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| int | |
|
||||||
|
|
||||||
|
|
||||||
## addPlugin
|
## addPlugin
|
||||||
|
|
||||||
```php
|
```php
|
||||||
|
|||||||
Reference in New Issue
Block a user