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 @@
# ZM\Module\InstantModule

View File

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

View File

@@ -0,0 +1,151 @@
# ZM\Module\ModulePacker
## __construct
```php
public function __construct(array $module): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| module | array | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## setOutputPath
```php
public function setOutputPath(mixed $path): mixed
```
### 描述
设置输出文件夹
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| path | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## setOverride
```php
public function setOverride(bool $override): mixed
```
### 描述
设置是否覆盖
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| override | bool | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getName
```php
public function getName(): mixed
```
### 描述
获取模块名字
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getFileName
```php
public function getFileName(): string
```
### 描述
获取打包的文件名绝对路径
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| string | |
## pack
```php
public function pack(): mixed
```
### 描述
打包模块
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## addLightCacheStore
```php
public function addLightCacheStore(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## addZMDataFiles
```php
public function addZMDataFiles(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

View File

@@ -0,0 +1,120 @@
# ZM\Module\ModuleUnpacker
## unpack
```php
public function unpack(mixed $ignore_depends, bool $override_light_cache, bool $override_data_files, bool $override_source): array
```
### 描述
解包模块
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| ignore_depends | mixed | |
| override_light_cache | bool | |
| override_data_files | bool | |
| override_source | bool | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| array | |
## checkConfig
```php
public function checkConfig(): mixed
```
### 描述
检查模块配置文件是否正确地放在phar包的位置中
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## checkDepends
```php
public function checkDepends(mixed $ignore_depends): mixed
```
### 描述
检查模块依赖关系
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| ignore_depends | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## checkLightCacheStore
```php
public function checkLightCacheStore(): mixed
```
### 描述
检查 light-cache-store 项是否合规
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## checkZMDataStore
```php
public function checkZMDataStore(): mixed
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## copyZMDataStore
```php
public function copyZMDataStore(mixed $override_data): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| override_data | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |

107
docs/api/ZM/Module/QQBot.md Normal file
View File

@@ -0,0 +1,107 @@
# ZM\Module\QQBot
## handle
```php
public function handle(mixed $data, int $level): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| data | mixed | |
| level | int | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## dispatchBeforeEvents
```php
public function dispatchBeforeEvents(mixed $data, mixed $time): ZM\Event\EventDispatcher
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| data | mixed | |
| time | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| ZM\Event\EventDispatcher | |
## dispatchEvents
```php
public function dispatchEvents(mixed $data): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| data | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## dispatchAPIResponse
```php
public function dispatchAPIResponse(mixed $req): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| req | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| mixed | |
## getInstance
```php
public function getInstance(): self
```
### 描述
作者很懒,什么也没有说
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| self | |