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

88
docs/api/ZM/DB/DB.md Normal file
View 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 | |

View 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 | |

View 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 | |

View 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
View File

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

View 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 | |