mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-21 23:55:35 +08:00
add api docs (#80)
This commit is contained in:
1
docs/api/ZM/Annotation/AnnotationBase.md
Normal file
1
docs/api/ZM/Annotation/AnnotationBase.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\AnnotationBase
|
||||
98
docs/api/ZM/Annotation/AnnotationParser.md
Normal file
98
docs/api/ZM/Annotation/AnnotationParser.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# ZM\Annotation\AnnotationParser
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
AnnotationParser constructor.
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## registerMods
|
||||
|
||||
```php
|
||||
public function registerMods(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
注册各个模块类的注解和模块level的排序
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## addRegisterPath
|
||||
|
||||
```php
|
||||
public function addRegisterPath(mixed $path, mixed $indoor_name): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| path | mixed | |
|
||||
| indoor_name | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## sortByLevel
|
||||
|
||||
```php
|
||||
public function sortByLevel(mixed $events, string $class_name, string $prefix): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| events | mixed | |
|
||||
| class_name | string | |
|
||||
| prefix | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## verifyMiddlewares
|
||||
|
||||
```php
|
||||
public function verifyMiddlewares(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Annotation/CQ/CQAPIResponse.md
Normal file
1
docs/api/ZM/Annotation/CQ/CQAPIResponse.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\CQ\CQAPIResponse
|
||||
39
docs/api/ZM/Annotation/CQ/CQAfter.md
Normal file
39
docs/api/ZM/Annotation/CQ/CQAfter.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ZM\Annotation\CQ\CQAfter
|
||||
|
||||
## getLevel
|
||||
|
||||
```php
|
||||
public function getLevel(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(mixed $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
39
docs/api/ZM/Annotation/CQ/CQBefore.md
Normal file
39
docs/api/ZM/Annotation/CQ/CQBefore.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ZM\Annotation\CQ\CQBefore
|
||||
|
||||
## getLevel
|
||||
|
||||
```php
|
||||
public function getLevel(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(mixed $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
22
docs/api/ZM/Annotation/CQ/CQCommand.md
Normal file
22
docs/api/ZM/Annotation/CQ/CQCommand.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ZM\Annotation\CQ\CQCommand
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(int $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Annotation/CQ/CQMessage.md
Normal file
1
docs/api/ZM/Annotation/CQ/CQMessage.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\CQ\CQMessage
|
||||
39
docs/api/ZM/Annotation/CQ/CQMetaEvent.md
Normal file
39
docs/api/ZM/Annotation/CQ/CQMetaEvent.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ZM\Annotation\CQ\CQMetaEvent
|
||||
|
||||
## getLevel
|
||||
|
||||
```php
|
||||
public function getLevel(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(int $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
22
docs/api/ZM/Annotation/CQ/CQNotice.md
Normal file
22
docs/api/ZM/Annotation/CQ/CQNotice.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ZM\Annotation\CQ\CQNotice
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(int $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
22
docs/api/ZM/Annotation/CQ/CQRequest.md
Normal file
22
docs/api/ZM/Annotation/CQ/CQRequest.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ZM\Annotation\CQ\CQRequest
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(int $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Annotation/Command/TerminalCommand.md
Normal file
1
docs/api/ZM/Annotation/Command/TerminalCommand.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Command\TerminalCommand
|
||||
61
docs/api/ZM/Annotation/Cron/Cron.md
Normal file
61
docs/api/ZM/Annotation/Cron/Cron.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# ZM\Annotation\Cron\Cron
|
||||
|
||||
## setStatus
|
||||
|
||||
```php
|
||||
public function setStatus(int $status): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| status | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
|
||||
|
||||
## getRecordNextTime
|
||||
|
||||
```php
|
||||
public function getRecordNextTime(): int
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int | |
|
||||
|
||||
|
||||
## setRecordNextTime
|
||||
|
||||
```php
|
||||
public function setRecordNextTime(int $record_next_time): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| record_next_time | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
1
docs/api/ZM/Annotation/Http/Controller.md
Normal file
1
docs/api/ZM/Annotation/Http/Controller.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\Controller
|
||||
1
docs/api/ZM/Annotation/Http/HandleAfter.md
Normal file
1
docs/api/ZM/Annotation/Http/HandleAfter.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\HandleAfter
|
||||
1
docs/api/ZM/Annotation/Http/HandleBefore.md
Normal file
1
docs/api/ZM/Annotation/Http/HandleBefore.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\HandleBefore
|
||||
1
docs/api/ZM/Annotation/Http/HandleException.md
Normal file
1
docs/api/ZM/Annotation/Http/HandleException.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\HandleException
|
||||
1
docs/api/ZM/Annotation/Http/Middleware.md
Normal file
1
docs/api/ZM/Annotation/Http/Middleware.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\Middleware
|
||||
1
docs/api/ZM/Annotation/Http/MiddlewareClass.md
Normal file
1
docs/api/ZM/Annotation/Http/MiddlewareClass.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\MiddlewareClass
|
||||
1
docs/api/ZM/Annotation/Http/RequestMapping.md
Normal file
1
docs/api/ZM/Annotation/Http/RequestMapping.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\RequestMapping
|
||||
1
docs/api/ZM/Annotation/Http/RequestMethod.md
Normal file
1
docs/api/ZM/Annotation/Http/RequestMethod.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Http\RequestMethod
|
||||
1
docs/api/ZM/Annotation/Module/Closed.md
Normal file
1
docs/api/ZM/Annotation/Module/Closed.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Module\Closed
|
||||
1
docs/api/ZM/Annotation/Swoole/OnCloseEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnCloseEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnCloseEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnManagerStartEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnManagerStartEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnMessageEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnMessageEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnMessageEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnOpenEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnOpenEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnOpenEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnPipeMessageEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnPipeMessageEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnRequestEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnRequestEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnRequestEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnSave.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnSave.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnSave
|
||||
1
docs/api/ZM/Annotation/Swoole/OnSetup.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnSetup.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnSetup
|
||||
1
docs/api/ZM/Annotation/Swoole/OnStart.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnStart.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnStart
|
||||
1
docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnSwooleEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnSwooleEvent
|
||||
22
docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md
Normal file
22
docs/api/ZM/Annotation/Swoole/OnSwooleEventBase.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ZM\Annotation\Swoole\OnSwooleEventBase
|
||||
|
||||
## setLevel
|
||||
|
||||
```php
|
||||
public function setLevel(int $level): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| level | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
17
docs/api/ZM/Annotation/Swoole/OnTask.md
Normal file
17
docs/api/ZM/Annotation/Swoole/OnTask.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ZM\Annotation\Swoole\OnTask
|
||||
|
||||
## getRule
|
||||
|
||||
```php
|
||||
public function getRule(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Annotation/Swoole/OnTaskEvent.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnTaskEvent.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnTaskEvent
|
||||
1
docs/api/ZM/Annotation/Swoole/OnTick.md
Normal file
1
docs/api/ZM/Annotation/Swoole/OnTick.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\OnTick
|
||||
1
docs/api/ZM/Annotation/Swoole/SwooleHandler.md
Normal file
1
docs/api/ZM/Annotation/Swoole/SwooleHandler.md
Normal file
@@ -0,0 +1 @@
|
||||
# ZM\Annotation\Swoole\SwooleHandler
|
||||
Reference in New Issue
Block a user