add api docs (#80)

This commit is contained in:
sunxyw
2022-03-27 16:42:36 +08:00
committed by GitHub
parent 5ddc514545
commit 4fbe2aa5af
147 changed files with 6425 additions and 1 deletions

View File

@@ -0,0 +1,22 @@
# ZM\Event\EventDispatcher
## interrupt
```php
public function interrupt(mixed $return_var): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| return_var | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1,39 @@
# ZM\Event\EventManager
## loadEventByParser
```php
public function loadEventByParser(ZM\Annotation\AnnotationParser $parser): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| parser | ZM\Annotation\AnnotationParser | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## registerTimerTick
```php
public function registerTimerTick(): mixed
```
### 描述
注册所有计时器给每个进程
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1,34 @@
# ZM\Event\EventTracer
## getCurrentEvent
```php
public function getCurrentEvent(): null|AnnotationBase
```
### 描述
获取当前注解事件的注解类如CQCommand对象
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| null|AnnotationBase | |
## getCurrentEventMiddlewares
```php
public function getCurrentEventMiddlewares(): null|array|mixed
```
### 描述
获取当前注解事件的中间件列表
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| null|array|mixed | |

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnBeforeReload

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnClose

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnManagerStart

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnManagerStop

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnMessage

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnOpen

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnPipeMessage

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnRequest

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnShutdown

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnStart

View File

@@ -0,0 +1,23 @@
# ZM\Event\SwooleEvent\OnTask
## onCall
```php
public function onCall(Swoole\Server $server, Swoole\Server\Task $task): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| server | Swoole\Server | |
| task | Swoole\Server\Task | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnWorkerExit

View File

@@ -0,0 +1,17 @@
# ZM\Event\SwooleEvent\OnWorkerStart
## loadAnnotations
```php
public function loadAnnotations(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1 @@
# ZM\Event\SwooleEvent\OnWorkerStop