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 +1,23 @@
# ZM\Annotation\AnnotationBase
# ZM\Annotation\AnnotationBase
## on
```php
public function on(mixed $method): ZM\Annotation\AnnotationBase
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| method | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| ZM\Annotation\AnnotationBase | |

View File

@@ -0,0 +1,174 @@
# ZM\Annotation\AnnotationHandler
## __construct
```php
public function __construct(string $annotation_class): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| annotation_class | string | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## interrupt
```php
public function interrupt(mixed $return_var): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| return_var | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## setRuleCallback
```php
public function setRuleCallback(callable $rule): ZM\Annotation\AnnotationHandler
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| rule | callable | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| ZM\Annotation\AnnotationHandler | |
## setReturnCallback
```php
public function setReturnCallback(callable $return): ZM\Annotation\AnnotationHandler
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| return | callable | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| ZM\Annotation\AnnotationHandler | |
## handleAll
```php
public function handleAll(mixed $params): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| params | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## handle
```php
public function handle(ZM\Annotation\AnnotationBase $v, callable $rule_callback, mixed $args): bool
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| v | ZM\Annotation\AnnotationBase | |
| rule_callback | callable | |
| args | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| bool | |
## getStatus
```php
public function getStatus(): int
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| int | |
## getReturnVal
```php
public function getReturnVal(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1,23 @@
# ZM\Annotation\AnnotationMap
## loadAnnotationByParser
```php
public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| parser | ZM\Annotation\AnnotationParser | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -3,12 +3,18 @@
## __construct
```php
public function __construct(): mixed
public function __construct(bool $with_internal_parsers): mixed
```
### 描述
AnnotationParser constructor.
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| with_internal_parsers | bool | |
### 返回
@@ -17,15 +23,22 @@ AnnotationParser constructor.
| mixed | |
## registerMods
## addSpecialParser
```php
public function registerMods(): mixed
public function addSpecialParser(string $class_name, callable $callback): mixed
```
### 描述
注册各个模块类的注解和模块level的排序
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| class_name | string | |
| callback | callable | |
### 返回
@@ -34,6 +47,40 @@ public function registerMods(): mixed
| mixed | |
## parseAll
```php
public function parseAll(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## generateAnnotationList
```php
public function generateAnnotationList(): array
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| array | |
## addRegisterPath
```php
@@ -48,8 +95,8 @@ public function addRegisterPath(string $path, string $indoor_name): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| path | string | 注册解析注解的路径 |
| indoor_name | string | 起始命名空间的名称 |
| path | string | |
| indoor_name | string | |
### 返回
@@ -72,9 +119,9 @@ public function sortByLevel(array $events, string $class_name, string $prefix):
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| events | array | 需要排序的 |
| class_name | string | 排序的类名 |
| prefix | string | 前缀 |
| events | array | |
| class_name | string | |
| prefix | string | |
### 返回
@@ -83,10 +130,10 @@ public function sortByLevel(array $events, string $class_name, string $prefix):
| mixed | |
## verifyMiddlewares
## getUsedTime
```php
public function verifyMiddlewares(): mixed
public function getUsedTime(): float
```
### 描述
@@ -95,6 +142,46 @@ public function verifyMiddlewares(): mixed
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| float | |
## getAnnotationMap
```php
public function getAnnotationMap(): array
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| array | |
## addRouteAnnotation
```php
public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| vss | ZM\Annotation\Http\Route | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |