mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-22 16:15:34 +08:00
update api docs
This commit is contained in:
@@ -1 +1 @@
|
|||||||
module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/Framework","ZM/ConsoleApplication","ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11","ZM/API/CQ","ZM/API/OneBotV11"]},{"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/Module","collapsable":true,"children":["ZM/Command/Module/ModuleListCommand","ZM/Command/Module/ModulePackCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/Table","ZM/DB/SelectBody"]},{"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/ModuleBase","ZM/Module/ModuleUnpacker","ZM/Module/QQBot","ZM/Module/ModulePacker"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCacheInside","ZM/Store/LightCache","ZM/Store/ZMAtomic"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ZMUtil","ZM/Utils/DataProvider","ZM/Utils/HttpUtil","ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}]
|
module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/Framework","ZM/ConsoleApplication","ZM/ZMServer"]},{"title":"ZM/API","collapsable":true,"children":["ZM/API/TuringAPI","ZM/API/GoCqhttpAPIV11","ZM/API/CQ","ZM/API/OneBotV11"]},{"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/Module","collapsable":true,"children":["ZM/Command/Module/ModuleListCommand","ZM/Command/Module/ModulePackCommand"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/DB","collapsable":true,"children":["ZM/DB/InsertBody","ZM/DB/DB","ZM/DB/DeleteBody","ZM/DB/UpdateBody","ZM/DB/Table","ZM/DB/SelectBody"]},{"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/ModuleBase","ZM/Module/ModuleUnpacker","ZM/Module/QQBot","ZM/Module/ModulePacker"]},{"title":"ZM/MySQL","collapsable":true,"children":["ZM/MySQL/MySQLConnection","ZM/MySQL/MySQLQueryBuilder","ZM/MySQL/MySQLStatement","ZM/MySQL/MySQLPool","ZM/MySQL/MySQLStatementWrapper","ZM/MySQL/MySQLWrapper"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/LightCacheInside","ZM/Store/LightCache","ZM/Store/ZMAtomic"]},{"title":"ZM/Store/Redis","collapsable":true,"children":["ZM/Store/Redis/ZMRedis"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ZMUtil","ZM/Utils/DataProvider","ZM/Utils/HttpUtil","ZM/Utils/SignalListener","ZM/Utils/MessageUtil","ZM/Utils/Terminal","ZM/Utils/CoMessage"]},{"title":"ZM/Utils/Manager","collapsable":true,"children":["ZM/Utils/Manager/CronManager","ZM/Utils/Manager/ModuleManager","ZM/Utils/Manager/WorkerManager"]}]
|
||||||
@@ -573,7 +573,7 @@ public function removeCQ(string $msg): string
|
|||||||
## getCQ
|
## getCQ
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function getCQ(string $msg, bool $is_object): array|CQObject
|
public function getCQ(string $msg, bool $is_object): null|array|CQObject
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -591,7 +591,7 @@ public function getCQ(string $msg, bool $is_object): array|CQObject
|
|||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| array|CQObject | 返回的CQ码(数组或对象) |
|
| null|array|CQObject | 返回的CQ码(数组或对象) |
|
||||||
|
|
||||||
|
|
||||||
## getAllCQ
|
## getAllCQ
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ public function count(): int
|
|||||||
## fetchAll
|
## fetchAll
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function fetchAll(int $fetch_mode): mixed
|
public function fetchAll(mixed $fetch_mode): mixed
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -48,7 +48,7 @@ public function fetchAll(int $fetch_mode): mixed
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| fetch_mode | int | |
|
| fetch_mode | mixed | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ public function fetchFirst(): null|mixed
|
|||||||
## value
|
## value
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function value(null $key): null|mixed
|
public function value(null|mixed $key): null|mixed
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -88,7 +88,7 @@ public function value(null $key): null|mixed
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| key | null | |
|
| key | null|mixed | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ public function getProcessState(mixed $id_or_name, int $type): false|int|mixed
|
|||||||
## removeProcessState
|
## removeProcessState
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function removeProcessState(null $id_or_name, int $type): mixed
|
public function removeProcessState(null|int|string $id_or_name, int $type): mixed
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -63,7 +63,7 @@ public function removeProcessState(null $id_or_name, int $type): mixed
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| id_or_name | null | |
|
| id_or_name | null|int|string | |
|
||||||
| type | int | |
|
| type | int | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|||||||
@@ -1 +1,93 @@
|
|||||||
# ZM\MySQL\MySQLConnection
|
# ZM\MySQL\MySQLConnection
|
||||||
|
|
||||||
|
## prepare
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function prepare(mixed $sql, mixed $options): mixed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| sql | mixed | |
|
||||||
|
| options | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
|
## query
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function query(mixed $args): mixed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| args | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
|
## exec
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function exec(mixed $sql): mixed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| sql | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
|
## lastInsertId
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function lastInsertId(null|mixed $name): mixed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| name | null|mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| mixed | |
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ public function getReloadableFiles(): string[]|string[][]
|
|||||||
## getClassesPsr4
|
## getClassesPsr4
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $rule, bool $return_path_value): string[]
|
public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $rule, bool|string $return_path_value): string[]
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -74,7 +74,7 @@ public function getClassesPsr4(string $dir, string $base_namespace, null|mixed $
|
|||||||
| dir | string | 目录 |
|
| dir | string | 目录 |
|
||||||
| base_namespace | string | 基础命名空间 |
|
| base_namespace | string | 基础命名空间 |
|
||||||
| rule | null|mixed | 规则 |
|
| rule | null|mixed | 规则 |
|
||||||
| return_path_value | bool | 是否返回文件路径 |
|
| return_path_value | bool|string | 是否返回文件路径,返回文件路径的话传入字符串 |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user