mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-21 07:35:34 +08:00
add api docs (#80)
This commit is contained in:
22
docs/api/ZM/Event/EventDispatcher.md
Normal file
22
docs/api/ZM/Event/EventDispatcher.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ZM\Event\EventDispatcher
|
||||
|
||||
## interrupt
|
||||
|
||||
```php
|
||||
public function interrupt(mixed $return_var): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| return_var | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
39
docs/api/ZM/Event/EventManager.md
Normal file
39
docs/api/ZM/Event/EventManager.md
Normal 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 | |
|
||||
34
docs/api/ZM/Event/EventTracer.md
Normal file
34
docs/api/ZM/Event/EventTracer.md
Normal 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 | |
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnBeforeReload.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnBeforeReload
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnClose.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnClose.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnClose
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnManagerStart.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnManagerStart.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnManagerStart
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnManagerStop.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnManagerStop.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnManagerStop
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnMessage.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnMessage.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnMessage
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnOpen.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnOpen.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnOpen
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnPipeMessage.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnPipeMessage
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnRequest.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnRequest.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnRequest
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnShutdown.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnShutdown.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnShutdown
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnStart.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnStart.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnStart
|
||||
23
docs/api/ZM/Event/SwooleEvent/OnTask.md
Normal file
23
docs/api/ZM/Event/SwooleEvent/OnTask.md
Normal 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 | |
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnWorkerExit.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnWorkerExit
|
||||
17
docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md
Normal file
17
docs/api/ZM/Event/SwooleEvent/OnWorkerStart.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ZM\Event\SwooleEvent\OnWorkerStart
|
||||
|
||||
## loadAnnotations
|
||||
|
||||
```php
|
||||
public function loadAnnotations(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md
Normal file
1
docs/api/ZM/Event/SwooleEvent/OnWorkerStop.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Event\SwooleEvent\OnWorkerStop
|
||||
Reference in New Issue
Block a user