mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-03-17 20:54:52 +08:00
add api docs (#80)
This commit is contained in:
sunxyw
GitHub
parent
5ddc514545
commit
4fbe2aa5af
2
.gitignore
vendored
2
.gitignore
vendored
@ -31,4 +31,4 @@ cghooks.lock
|
||||
# Vuepress 相关文件
|
||||
/node_modules/
|
||||
/docs/.vuepress/dist/
|
||||
package-lock.json
|
||||
package-lock.json
|
||||
|
||||
1
docs/.vuepress/api.js
Normal file
1
docs/.vuepress/api.js
Normal file
@ -0,0 +1 @@
|
||||
module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMServer","ZM/ConsoleApplication","ZM/Framework"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/CQ","ZM/API/OneBotV11","ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationParser"]},{"title":"ZM/Annotation/Swoole","collapsable":true,"children":["ZM/Annotation/Swoole/OnSwooleEventBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/CheckConfigCommand"]},{"title":"ZM/Command/Generate","collapsable":true,"children":["ZM/Command/Generate/APIDocsGenerateCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/Table","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/DB","ZM/DB/SelectBody","ZM/DB/InsertBody"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventManager","ZM/Event/EventTracer","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/SwooleEvent","collapsable":true,"children":["ZM/Event/SwooleEvent/OnWorkerStart","ZM/Event/SwooleEvent/OnTask"]},{"title":"ZM/Http","collapsable":true,"children":["ZM/Http/Response"]},{"title":"ZM/Module","collapsable":true,"children":["ZM/Module/ModuleUnpacker","ZM/Module/ModulePacker","ZM/Module/ModuleBase","ZM/Module/QQBot"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLWrapper","ZM/MySQL/MySQLPool"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCache","ZM/Store/ZMAtomic","ZM/Store/LightCacheInside"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/Terminal","ZM/Utils/MessageUtil","ZM/Utils/DataProvider","ZM/Utils/SignalListener","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}]
|
||||
@ -1,3 +1,5 @@
|
||||
const apiConfig = require('./api')
|
||||
|
||||
module.exports = {
|
||||
title: '炸毛框架',
|
||||
description: '一个聊天机器人 + Web 框架',
|
||||
@ -161,6 +163,7 @@ module.exports = {
|
||||
]
|
||||
},
|
||||
],
|
||||
'/api/': apiConfig,
|
||||
'/faq/': [
|
||||
'',
|
||||
'to-v2',
|
||||
|
||||
463
docs/api/ZM/API/CQ.md
Normal file
463
docs/api/ZM/API/CQ.md
Normal file
@ -0,0 +1,463 @@
|
||||
# ZM\API\CQ
|
||||
|
||||
## at
|
||||
|
||||
```php
|
||||
public function at(mixed $qq): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
at一下QQ用户（仅在QQ群支持at全体）
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| qq | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## face
|
||||
|
||||
```php
|
||||
public function face(mixed $id): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送QQ原生表情
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## image
|
||||
|
||||
```php
|
||||
public function image(mixed $file, bool $cache, bool $flash, bool $proxy, int $timeout): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送图片
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| file | mixed | |
|
||||
| cache | bool | |
|
||||
| flash | bool | |
|
||||
| proxy | bool | |
|
||||
| timeout | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## record
|
||||
|
||||
```php
|
||||
public function record(mixed $file, bool $magic, bool $cache, bool $proxy, int $timeout): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送语音
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| file | mixed | |
|
||||
| magic | bool | |
|
||||
| cache | bool | |
|
||||
| proxy | bool | |
|
||||
| timeout | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## video
|
||||
|
||||
```php
|
||||
public function video(mixed $file, bool $cache, bool $proxy, int $timeout): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送短视频
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| file | mixed | |
|
||||
| cache | bool | |
|
||||
| proxy | bool | |
|
||||
| timeout | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## rps
|
||||
|
||||
```php
|
||||
public function rps(): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送投掷骰子（只能在单条回复中单独使用）
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## dice
|
||||
|
||||
```php
|
||||
public function dice(): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送掷骰子表情（只能在单条回复中单独使用）
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## shake
|
||||
|
||||
```php
|
||||
public function shake(): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
戳一戳（原窗口抖动，仅支持好友消息使用）
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## poke
|
||||
|
||||
```php
|
||||
public function poke(mixed $type, mixed $id, string $name): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送新的戳一戳
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| type | mixed | |
|
||||
| id | mixed | |
|
||||
| name | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## anonymous
|
||||
|
||||
```php
|
||||
public function anonymous(int $ignore): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送匿名消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| ignore | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## share
|
||||
|
||||
```php
|
||||
public function share(mixed $url, mixed $title, null $content, null $image): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送链接分享（只能在单条回复中单独使用）
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| url | mixed | |
|
||||
| title | mixed | |
|
||||
| content | null | |
|
||||
| image | null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## contact
|
||||
|
||||
```php
|
||||
public function contact(mixed $type, mixed $id): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送好友或群推荐名片
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| type | mixed | |
|
||||
| id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## location
|
||||
|
||||
```php
|
||||
public function location(mixed $lat, mixed $lon, string $title, string $content): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送位置
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| lat | mixed | |
|
||||
| lon | mixed | |
|
||||
| title | string | |
|
||||
| content | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## music
|
||||
|
||||
```php
|
||||
public function music(mixed $type, mixed $id_or_url, null $audio, null $title, null $content, null $image): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送音乐分享（只能在单条回复中单独使用）
|
||||
qq、163、xiami为内置分享，需要先通过搜索功能获取id后使用
|
||||
custom为自定义分享
|
||||
当为自定义分享时：
|
||||
$id_or_url 为音乐卡片点进去打开的链接（一般是音乐介绍界面啦什么的）
|
||||
$audio 为音乐（如mp3文件）的HTTP链接地址（不可为空）
|
||||
$title 为音乐卡片的标题，建议12字以内（不可为空）
|
||||
$content 为音乐卡片的简介（可忽略）
|
||||
$image 为音乐卡片的图片链接地址（可忽略）
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| type | mixed | |
|
||||
| id_or_url | mixed | |
|
||||
| audio | null | |
|
||||
| title | null | |
|
||||
| content | null | |
|
||||
| image | null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## decode
|
||||
|
||||
```php
|
||||
public function decode(mixed $msg, mixed $is_content): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
反转义字符串中的CQ码敏感符号
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| is_content | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## escape
|
||||
|
||||
```php
|
||||
public function escape(mixed $msg, mixed $is_content): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
转义CQ码的特殊字符，同encode
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| is_content | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## encode
|
||||
|
||||
```php
|
||||
public function encode(mixed $msg, mixed $is_content): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
转义CQ码的特殊字符
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| is_content | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## removeCQ
|
||||
|
||||
```php
|
||||
public function removeCQ(mixed $msg): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
移除消息中所有的CQ码并返回移除CQ码后的消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## getCQ
|
||||
|
||||
```php
|
||||
public function getCQ(mixed $msg, mixed $is_object): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取消息中第一个CQ码
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| is_object | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## getAllCQ
|
||||
|
||||
```php
|
||||
public function getAllCQ(mixed $msg, mixed $is_object): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取消息中所有的CQ码
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| is_object | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
174
docs/api/ZM/API/GoCqhttpAPIV11.md
Normal file
174
docs/api/ZM/API/GoCqhttpAPIV11.md
Normal file
@ -0,0 +1,174 @@
|
||||
# ZM\API\GoCqhttpAPIV11
|
||||
|
||||
## getGuildServiceProfile
|
||||
|
||||
```php
|
||||
public function getGuildServiceProfile(): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取频道系统内BOT的资料
|
||||
响应字段：nickname, tiny_id, avatar_url
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## getGuildList
|
||||
|
||||
```php
|
||||
public function getGuildList(): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取频道列表
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## getGuildMetaByGuest
|
||||
|
||||
```php
|
||||
public function getGuildMetaByGuest(mixed $guild_id): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
通过访客获取频道元数据
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| guild_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## getGuildChannelList
|
||||
|
||||
```php
|
||||
public function getGuildChannelList(mixed $guild_id, false $no_cache): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取子频道列表
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| guild_id | mixed | |
|
||||
| no_cache | false | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## getGuildMembers
|
||||
|
||||
```php
|
||||
public function getGuildMembers(mixed $guild_id): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取频道成员列表
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| guild_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## sendGuildChannelMsg
|
||||
|
||||
```php
|
||||
public function sendGuildChannelMsg(mixed $guild_id, mixed $channel_id, mixed $message): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送信息到子频道
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| guild_id | mixed | |
|
||||
| channel_id | mixed | |
|
||||
| message | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## processAPI
|
||||
|
||||
```php
|
||||
public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| connection | mixed | |
|
||||
| reply | mixed | |
|
||||
| function | |null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## processHttpAPI
|
||||
|
||||
```php
|
||||
public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| connection | mixed | |
|
||||
| reply | mixed | |
|
||||
| function | null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
932
docs/api/ZM/API/OneBotV11.md
Normal file
932
docs/api/ZM/API/OneBotV11.md
Normal file
@ -0,0 +1,932 @@
|
||||
# ZM\API\OneBotV11
|
||||
|
||||
## get
|
||||
|
||||
```php
|
||||
public function get(mixed $robot_id): ZMRobot
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| robot_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| ZMRobot | |
|
||||
|
||||
|
||||
## getRandom
|
||||
|
||||
```php
|
||||
public function getRandom(): ZMRobot
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| ZMRobot | |
|
||||
|
||||
|
||||
## getAllRobot
|
||||
|
||||
```php
|
||||
public function getAllRobot(): ZMRobot[]
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| ZMRobot[] | |
|
||||
|
||||
|
||||
## sendPrivateMsg
|
||||
|
||||
```php
|
||||
public function sendPrivateMsg(mixed $user_id, mixed $message, bool $auto_escape): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送私聊消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| user_id | mixed | |
|
||||
| message | mixed | |
|
||||
| auto_escape | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## sendGroupMsg
|
||||
|
||||
```php
|
||||
public function sendGroupMsg(mixed $group_id, mixed $message, bool $auto_escape): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送群消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| message | mixed | |
|
||||
| auto_escape | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## sendMsg
|
||||
|
||||
```php
|
||||
public function sendMsg(mixed $message_type, mixed $target_id, mixed $message, bool $auto_escape): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| message_type | mixed | |
|
||||
| target_id | mixed | |
|
||||
| message | mixed | |
|
||||
| auto_escape | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## deleteMsg
|
||||
|
||||
```php
|
||||
public function deleteMsg(mixed $message_id): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
撤回消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| message_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getMsg
|
||||
|
||||
```php
|
||||
public function getMsg(mixed $message_id): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| message_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getForwardMsg
|
||||
|
||||
```php
|
||||
public function getForwardMsg(mixed $id): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取合并转发消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## sendLike
|
||||
|
||||
```php
|
||||
public function sendLike(mixed $user_id, int $times): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
发送好友赞
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| user_id | mixed | |
|
||||
| times | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupKick
|
||||
|
||||
```php
|
||||
public function setGroupKick(mixed $group_id, mixed $user_id, bool $reject_add_request): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组踢人
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| reject_add_request | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupBan
|
||||
|
||||
```php
|
||||
public function setGroupBan(mixed $group_id, mixed $user_id, int $duration): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组单人禁言
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| duration | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupAnonymousBan
|
||||
|
||||
```php
|
||||
public function setGroupAnonymousBan(mixed $group_id, mixed $anonymous_or_flag, int $duration): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组匿名用户禁言
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| anonymous_or_flag | mixed | |
|
||||
| duration | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupWholeBan
|
||||
|
||||
```php
|
||||
public function setGroupWholeBan(mixed $group_id, bool $enable): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组全员禁言
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| enable | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupAdmin
|
||||
|
||||
```php
|
||||
public function setGroupAdmin(mixed $group_id, mixed $user_id, bool $enable): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组设置管理员
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| enable | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupAnonymous
|
||||
|
||||
```php
|
||||
public function setGroupAnonymous(mixed $group_id, bool $enable): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
群组匿名
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| enable | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupCard
|
||||
|
||||
```php
|
||||
public function setGroupCard(mixed $group_id, mixed $user_id, string $card): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
设置群名片（群备注）
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| card | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupName
|
||||
|
||||
```php
|
||||
public function setGroupName(mixed $group_id, mixed $group_name): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
设置群名
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| group_name | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupLeave
|
||||
|
||||
```php
|
||||
public function setGroupLeave(mixed $group_id, bool $is_dismiss): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
退出群组
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| is_dismiss | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupSpecialTitle
|
||||
|
||||
```php
|
||||
public function setGroupSpecialTitle(mixed $group_id, mixed $user_id, string $special_title, int $duration): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
设置群组专属头衔
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| special_title | string | |
|
||||
| duration | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setFriendAddRequest
|
||||
|
||||
```php
|
||||
public function setFriendAddRequest(mixed $flag, bool $approve, string $remark): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
处理加好友请求
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| flag | mixed | |
|
||||
| approve | bool | |
|
||||
| remark | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setGroupAddRequest
|
||||
|
||||
```php
|
||||
public function setGroupAddRequest(mixed $flag, mixed $sub_type, bool $approve, string $reason): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
处理加群请求／邀请
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| flag | mixed | |
|
||||
| sub_type | mixed | |
|
||||
| approve | bool | |
|
||||
| reason | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getLoginInfo
|
||||
|
||||
```php
|
||||
public function getLoginInfo(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取登录号信息
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getStrangerInfo
|
||||
|
||||
```php
|
||||
public function getStrangerInfo(mixed $user_id, bool $no_cache): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取陌生人信息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| user_id | mixed | |
|
||||
| no_cache | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getFriendList
|
||||
|
||||
```php
|
||||
public function getFriendList(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取好友列表
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getGroupInfo
|
||||
|
||||
```php
|
||||
public function getGroupInfo(mixed $group_id, bool $no_cache): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取群信息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| no_cache | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getGroupList
|
||||
|
||||
```php
|
||||
public function getGroupList(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取群列表
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getGroupMemberInfo
|
||||
|
||||
```php
|
||||
public function getGroupMemberInfo(mixed $group_id, mixed $user_id, bool $no_cache): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取群成员信息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| user_id | mixed | |
|
||||
| no_cache | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getGroupMemberList
|
||||
|
||||
```php
|
||||
public function getGroupMemberList(mixed $group_id): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取群成员列表
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getGroupHonorInfo
|
||||
|
||||
```php
|
||||
public function getGroupHonorInfo(mixed $group_id, mixed $type): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取群荣誉信息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| group_id | mixed | |
|
||||
| type | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getCsrfToken
|
||||
|
||||
```php
|
||||
public function getCsrfToken(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取 CSRF Token
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getCredentials
|
||||
|
||||
```php
|
||||
public function getCredentials(string $domain): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取 QQ 相关接口凭证
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| domain | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getRecord
|
||||
|
||||
```php
|
||||
public function getRecord(mixed $file, mixed $out_format): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取语音
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| file | mixed | |
|
||||
| out_format | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getImage
|
||||
|
||||
```php
|
||||
public function getImage(mixed $file): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取图片
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| file | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## canSendImage
|
||||
|
||||
```php
|
||||
public function canSendImage(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
检查是否可以发送图片
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## canSendRecord
|
||||
|
||||
```php
|
||||
public function canSendRecord(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
检查是否可以发送语音
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getStatus
|
||||
|
||||
```php
|
||||
public function getStatus(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取运行状态
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getVersionInfo
|
||||
|
||||
```php
|
||||
public function getVersionInfo(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取版本信息
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## setRestart
|
||||
|
||||
```php
|
||||
public function setRestart(int $delay): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
重启 OneBot 实现
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| delay | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## cleanCache
|
||||
|
||||
```php
|
||||
public function cleanCache(): null|array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
清理缓存
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|array|bool | |
|
||||
|
||||
|
||||
## getExtendedAPI
|
||||
|
||||
```php
|
||||
public function getExtendedAPI(string $package_name): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取内置支持的扩展API对象
|
||||
现支持 go-cqhttp 的扩展API
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| package_name | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## processAPI
|
||||
|
||||
```php
|
||||
public function processAPI(mixed $connection, mixed $reply, |null $function): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| connection | mixed | |
|
||||
| reply | mixed | |
|
||||
| function | |null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## processHttpAPI
|
||||
|
||||
```php
|
||||
public function processHttpAPI(mixed $connection, mixed $reply, null $function): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| connection | mixed | |
|
||||
| reply | mixed | |
|
||||
| function | null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
24
docs/api/ZM/API/TuringAPI.md
Normal file
24
docs/api/ZM/API/TuringAPI.md
Normal file
@ -0,0 +1,24 @@
|
||||
# ZM\API\TuringAPI
|
||||
|
||||
## getTuringMsg
|
||||
|
||||
```php
|
||||
public function getTuringMsg(mixed $msg, mixed $user_id, mixed $api): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
请求图灵API，返回图灵的消息
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| user_id | mixed | |
|
||||
| api | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
1
docs/api/ZM/API/ZMRobot.md
Normal file
1
docs/api/ZM/API/ZMRobot.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\API\ZMRobot
|
||||
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
|
||||
1
docs/api/ZM/Command/BuildCommand.md
Normal file
1
docs/api/ZM/Command/BuildCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\BuildCommand
|
||||
24
docs/api/ZM/Command/CheckConfigCommand.md
Normal file
24
docs/api/ZM/Command/CheckConfigCommand.md
Normal file
@ -0,0 +1,24 @@
|
||||
# ZM\Command\CheckConfigCommand
|
||||
|
||||
## check
|
||||
|
||||
```php
|
||||
public function check(mixed $remote, mixed $local, Symfony\Component\Console\Output\OutputInterface $out): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| remote | mixed | |
|
||||
| local | mixed | |
|
||||
| out | Symfony\Component\Console\Output\OutputInterface | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Command/Daemon/DaemonCommand.md
Normal file
1
docs/api/ZM/Command/Daemon/DaemonCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Daemon\DaemonCommand
|
||||
1
docs/api/ZM/Command/Daemon/DaemonReloadCommand.md
Normal file
1
docs/api/ZM/Command/Daemon/DaemonReloadCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Daemon\DaemonReloadCommand
|
||||
1
docs/api/ZM/Command/Daemon/DaemonStatusCommand.md
Normal file
1
docs/api/ZM/Command/Daemon/DaemonStatusCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Daemon\DaemonStatusCommand
|
||||
1
docs/api/ZM/Command/Daemon/DaemonStopCommand.md
Normal file
1
docs/api/ZM/Command/Daemon/DaemonStopCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Daemon\DaemonStopCommand
|
||||
91
docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md
Normal file
91
docs/api/ZM/Command/Generate/APIDocsGenerateCommand.md
Normal file
@ -0,0 +1,91 @@
|
||||
# ZM\Command\Generate\APIDocsGenerateCommand
|
||||
|
||||
## configure
|
||||
|
||||
```php
|
||||
public function configure(): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
Configures the current command.
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
|
||||
|
||||
## execute
|
||||
|
||||
```php
|
||||
public function execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output): int
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
Executes the current command.
|
||||
This method is not abstract because you can use this class
|
||||
as a concrete class. In this case, instead of defining the
|
||||
execute() method, you set the code to execute by passing
|
||||
a Closure to the setCode() method.
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| input | Symfony\Component\Console\Input\InputInterface | |
|
||||
| output | Symfony\Component\Console\Output\OutputInterface | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int | 0 if everything went fine, or an exit code * |
|
||||
|
||||
|
||||
## getClassMetas
|
||||
|
||||
```php
|
||||
public function getClassMetas(string $class_name, Jasny\PhpdocParser\PhpdocParser $parser): array
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
获取类的元数据
|
||||
包括类的注释、方法的注释、参数、返回值等
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| class_name | string | |
|
||||
| parser | Jasny\PhpdocParser\PhpdocParser | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array | |
|
||||
|
||||
|
||||
## convertMetaToMarkdown
|
||||
|
||||
```php
|
||||
public function convertMetaToMarkdown(string $method, array $meta): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
将方法的元数据转换为 Markdown 格式
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| method | string | 方法名 |
|
||||
| meta | array | 元数据 |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
1
docs/api/ZM/Command/Generate/SystemdGenerateCommand.md
Normal file
1
docs/api/ZM/Command/Generate/SystemdGenerateCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Generate\SystemdGenerateCommand
|
||||
1
docs/api/ZM/Command/InitCommand.md
Normal file
1
docs/api/ZM/Command/InitCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\InitCommand
|
||||
1
docs/api/ZM/Command/Module/ModuleListCommand.md
Normal file
1
docs/api/ZM/Command/Module/ModuleListCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Module\ModuleListCommand
|
||||
1
docs/api/ZM/Command/Module/ModulePackCommand.md
Normal file
1
docs/api/ZM/Command/Module/ModulePackCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Module\ModulePackCommand
|
||||
1
docs/api/ZM/Command/Module/ModuleUnpackCommand.md
Normal file
1
docs/api/ZM/Command/Module/ModuleUnpackCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Module\ModuleUnpackCommand
|
||||
1
docs/api/ZM/Command/PureHttpCommand.md
Normal file
1
docs/api/ZM/Command/PureHttpCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\PureHttpCommand
|
||||
1
docs/api/ZM/Command/RunServerCommand.md
Normal file
1
docs/api/ZM/Command/RunServerCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\RunServerCommand
|
||||
1
docs/api/ZM/Command/Server/ServerReloadCommand.md
Normal file
1
docs/api/ZM/Command/Server/ServerReloadCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Server\ServerReloadCommand
|
||||
1
docs/api/ZM/Command/Server/ServerStatusCommand.md
Normal file
1
docs/api/ZM/Command/Server/ServerStatusCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Server\ServerStatusCommand
|
||||
1
docs/api/ZM/Command/Server/ServerStopCommand.md
Normal file
1
docs/api/ZM/Command/Server/ServerStopCommand.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Command\Server\ServerStopCommand
|
||||
44
docs/api/ZM/ConsoleApplication.md
Normal file
44
docs/api/ZM/ConsoleApplication.md
Normal file
@ -0,0 +1,44 @@
|
||||
# ZM\ConsoleApplication
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(string $name): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| name | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## initEnv
|
||||
|
||||
```php
|
||||
public function initEnv(string $with_default_cmd): ZM\ConsoleApplication
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| with_default_cmd | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| ZM\ConsoleApplication | |
|
||||
210
docs/api/ZM/Context/Context.md
Normal file
210
docs/api/ZM/Context/Context.md
Normal file
@ -0,0 +1,210 @@
|
||||
# ZM\Context\Context
|
||||
|
||||
## getServer
|
||||
|
||||
```php
|
||||
public function getServer(): Server
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| Server | |
|
||||
|
||||
|
||||
## getData
|
||||
|
||||
```php
|
||||
public function getData(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## reply
|
||||
|
||||
```php
|
||||
public function reply(mixed $msg, bool $yield): array|bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
only can used by cq->message event function
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| yield | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| array|bool | |
|
||||
|
||||
|
||||
## finalReply
|
||||
|
||||
```php
|
||||
public function finalReply(mixed $msg, bool $yield): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| msg | mixed | |
|
||||
| yield | bool | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## waitMessage
|
||||
|
||||
```php
|
||||
public function waitMessage(string $prompt, int $timeout, string $timeout_prompt): string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| prompt | string | |
|
||||
| timeout | int | |
|
||||
| timeout_prompt | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| string | |
|
||||
|
||||
|
||||
## getArgs
|
||||
|
||||
```php
|
||||
public function getArgs(mixed $mode, mixed $prompt_msg): mixed|string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| mode | mixed | |
|
||||
| prompt_msg | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed|string | |
|
||||
|
||||
|
||||
## getNextArg
|
||||
|
||||
```php
|
||||
public function getNextArg(string $prompt_msg): int|mixed|string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| prompt_msg | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int|mixed|string | |
|
||||
|
||||
|
||||
## getFullArg
|
||||
|
||||
```php
|
||||
public function getFullArg(string $prompt_msg): int|mixed|string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| prompt_msg | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int|mixed|string | |
|
||||
|
||||
|
||||
## getNumArg
|
||||
|
||||
```php
|
||||
public function getNumArg(string $prompt_msg): int|mixed|string
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| prompt_msg | string | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int|mixed|string | |
|
||||
|
||||
|
||||
## cloneFromParent
|
||||
|
||||
```php
|
||||
public function cloneFromParent(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
88
docs/api/ZM/DB/DB.md
Normal file
88
docs/api/ZM/DB/DB.md
Normal file
@ -0,0 +1,88 @@
|
||||
# ZM\DB\DB
|
||||
|
||||
## initTableList
|
||||
|
||||
```php
|
||||
public function initTableList(mixed $db_name): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| db_name | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## table
|
||||
|
||||
```php
|
||||
public function table(mixed $table_name): ZM\DB\Table
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| table_name | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| ZM\DB\Table | |
|
||||
|
||||
|
||||
## statement
|
||||
|
||||
```php
|
||||
public function statement(mixed $line): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| line | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## unprepared
|
||||
|
||||
```php
|
||||
public function unprepared(mixed $line): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| line | mixed | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
39
docs/api/ZM/DB/DeleteBody.md
Normal file
39
docs/api/ZM/DB/DeleteBody.md
Normal file
@ -0,0 +1,39 @@
|
||||
# ZM\DB\DeleteBody
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(ZM\DB\Table $table): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
DeleteBody constructor.
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| table | ZM\DB\Table | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## save
|
||||
|
||||
```php
|
||||
public function save(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
40
docs/api/ZM/DB/InsertBody.md
Normal file
40
docs/api/ZM/DB/InsertBody.md
Normal file
@ -0,0 +1,40 @@
|
||||
# ZM\DB\InsertBody
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(mixed $row, ZM\DB\Table $table): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
InsertBody constructor.
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| row | mixed | |
|
||||
| table | ZM\DB\Table | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## save
|
||||
|
||||
```php
|
||||
public function save(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
134
docs/api/ZM/DB/SelectBody.md
Normal file
134
docs/api/ZM/DB/SelectBody.md
Normal file
@ -0,0 +1,134 @@
|
||||
# ZM\DB\SelectBody
|
||||
|
||||
## get
|
||||
|
||||
```php
|
||||
public function get(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## count
|
||||
|
||||
```php
|
||||
public function count(): int
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| int | |
|
||||
|
||||
|
||||
## fetchAll
|
||||
|
||||
```php
|
||||
public function fetchAll(int $fetch_mode): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| fetch_mode | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## fetchFirst
|
||||
|
||||
```php
|
||||
public function fetchFirst(): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## value
|
||||
|
||||
```php
|
||||
public function value(null $key): null|mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| key | null | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| null|mixed | |
|
||||
|
||||
|
||||
## execute
|
||||
|
||||
```php
|
||||
public function execute(int $fetch_mode): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| fetch_mode | int | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## getSelectThing
|
||||
|
||||
```php
|
||||
public function getSelectThing(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
17
docs/api/ZM/DB/Table.md
Normal file
17
docs/api/ZM/DB/Table.md
Normal file
@ -0,0 +1,17 @@
|
||||
# ZM\DB\Table
|
||||
|
||||
## getTableName
|
||||
|
||||
```php
|
||||
public function getTableName(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
40
docs/api/ZM/DB/UpdateBody.md
Normal file
40
docs/api/ZM/DB/UpdateBody.md
Normal file
@ -0,0 +1,40 @@
|
||||
# ZM\DB\UpdateBody
|
||||
|
||||
## __construct
|
||||
|
||||
```php
|
||||
public function __construct(ZM\DB\Table $table, array $set_value): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
UpdateBody constructor.
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| table | ZM\DB\Table | |
|
||||
| set_value | array | |
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
|
||||
|
||||
## save
|
||||
|
||||
```php
|
||||
public function save(): mixed
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒，什么也没有说
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
1
docs/api/ZM/Entity/CQObject.md
Normal file
1
docs/api/ZM/Entity/CQObject.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Entity\CQObject
|
||||
1
docs/api/ZM/Entity/MatchResult.md
Normal file
1
docs/api/ZM/Entity/MatchResult.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Entity\MatchResult
|
||||
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
|
||||
1
docs/api/ZM/Exception/AnnotationException.md
Normal file
1
docs/api/ZM/Exception/AnnotationException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\AnnotationException
|
||||
1
docs/api/ZM/Exception/DbException.md
Normal file
1
docs/api/ZM/Exception/DbException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\DbException
|
||||
1
docs/api/ZM/Exception/ExceptionHandler.md
Normal file
1
docs/api/ZM/Exception/ExceptionHandler.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\ExceptionHandler
|
||||
1
docs/api/ZM/Exception/InitException.md
Normal file
1
docs/api/ZM/Exception/InitException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\InitException
|
||||
1
docs/api/ZM/Exception/InterruptException.md
Normal file
1
docs/api/ZM/Exception/InterruptException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\InterruptException
|
||||
1
docs/api/ZM/Exception/InvalidArgumentException.md
Normal file
1
docs/api/ZM/Exception/InvalidArgumentException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\InvalidArgumentException
|
||||
1
docs/api/ZM/Exception/LightCacheException.md
Normal file
1
docs/api/ZM/Exception/LightCacheException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\LightCacheException
|
||||
1
docs/api/ZM/Exception/MethodNotFoundException.md
Normal file
1
docs/api/ZM/Exception/MethodNotFoundException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\MethodNotFoundException
|
||||
1
docs/api/ZM/Exception/ModulePackException.md
Normal file
1
docs/api/ZM/Exception/ModulePackException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\ModulePackException
|
||||
1
docs/api/ZM/Exception/NotInitializedException.md
Normal file
1
docs/api/ZM/Exception/NotInitializedException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\NotInitializedException
|
||||
1
docs/api/ZM/Exception/RedisException.md
Normal file
1
docs/api/ZM/Exception/RedisException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\RedisException
|
||||
1
docs/api/ZM/Exception/RobotNotFoundException.md
Normal file
1
docs/api/ZM/Exception/RobotNotFoundException.md
Normal file
@ -0,0 +1 @@
|
||||
# ZM\Exception\RobotNotFoundException
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user