update api docs

This commit is contained in:
crazywhalecc
2022-08-22 07:39:44 +00:00
committed by github-actions[bot]
parent 53c1c0103c
commit e83a169fd6
35 changed files with 3069 additions and 527 deletions

View File

@@ -1,9 +1,9 @@
# ZM\Event\EventDispatcher
## interrupt
## getInstance
```php
public function interrupt(mixed $return_var): mixed
public function getInstance(mixed $args): object
```
### 描述
@@ -14,10 +14,10 @@ public function interrupt(mixed $return_var): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| return_var | mixed | |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
| object | |

View File

@@ -0,0 +1,117 @@
# ZM\Event\EventProvider
## addEventListener
```php
public function addEventListener(mixed $event, callable $callback, int $level): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | mixed | |
| callback | callable | |
| level | int | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getEventListeners
```php
public function getEventListeners(string $event_name): array
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event_name | string | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| array | |
## getListenersForEvent
```php
public function getListenersForEvent(object $event): iterable
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | object | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| iterable | |
## sortEvents
```php
public function sortEvents(mixed $name): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| name | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |

View File

@@ -0,0 +1,69 @@
# ZM\Event\Listener\HttpEventListener
## onRequest999
```php
public function onRequest999(OneBot\Driver\Event\Http\HttpRequestEvent $event): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\Http\HttpRequestEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## onRequest1
```php
public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| event | OneBot\Driver\Event\Http\HttpRequestEvent | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |

View File

@@ -0,0 +1,57 @@
# ZM\Event\Listener\ManagerEventListener
## onManagerStart
```php
public function onManagerStart(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## onManagerStop
```php
public function onManagerStop(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |

View File

@@ -0,0 +1,40 @@
# ZM\Event\Listener\MasterEventListener
## onMasterStop
```php
public function onMasterStop(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |

View File

@@ -0,0 +1,57 @@
# ZM\Event\Listener\SignalListener
## signalWorker
```php
public function signalWorker(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## processKillerPrompt
```php
public function processKillerPrompt(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |

View File

@@ -0,0 +1,108 @@
# ZM\Event\Listener\WorkerEventListener
## onWorkerStart999
```php
public function onWorkerStart999(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## onWorkerStop999
```php
public function onWorkerStop999(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## initUserPlugins
```php
public function initUserPlugins(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## dispatchInit
```php
public function dispatchInit(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## initConnectionPool
```php
public function initConnectionPool(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(mixed $args): object
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| object | |