mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-25 01:25:34 +08:00
update api docs
This commit is contained in:
committed by
github-actions[bot]
parent
2727b056eb
commit
6e78f2caf2
@@ -1,26 +1,9 @@
|
|||||||
# ZM\Config\ZMConfig
|
# ZM\Config\ZMConfig
|
||||||
|
|
||||||
## restoreDirectory
|
## __construct
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function restoreDirectory(): mixed
|
public function __construct(array $config_paths, string $environment): mixed
|
||||||
```
|
|
||||||
|
|
||||||
### 描述
|
|
||||||
|
|
||||||
作者很懒,什么也没有说
|
|
||||||
|
|
||||||
### 返回
|
|
||||||
|
|
||||||
| 类型 | 描述 |
|
|
||||||
| ---- | ----------- |
|
|
||||||
| mixed | |
|
|
||||||
|
|
||||||
|
|
||||||
## get
|
|
||||||
|
|
||||||
```php
|
|
||||||
public function get(string $name, mixed $additional_key): mixed
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -31,8 +14,8 @@ public function get(string $name, mixed $additional_key): mixed
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| name | string | |
|
| config_paths | array | |
|
||||||
| additional_key | mixed | |
|
| environment | string | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
@@ -41,10 +24,10 @@ public function get(string $name, mixed $additional_key): mixed
|
|||||||
| mixed | |
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
## smartPatch
|
## addConfigPath
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function smartPatch(mixed $data, mixed $patch): mixed
|
public function addConfigPath(string $path): void
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -55,54 +38,7 @@ public function smartPatch(mixed $data, mixed $patch): mixed
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| data | mixed | |
|
| path | string | |
|
||||||
| patch | mixed | |
|
|
||||||
|
|
||||||
### 返回
|
|
||||||
|
|
||||||
| 类型 | 描述 |
|
|
||||||
| ---- | ----------- |
|
|
||||||
| mixed | |
|
|
||||||
|
|
||||||
|
|
||||||
## loadConfig
|
|
||||||
|
|
||||||
```php
|
|
||||||
public function loadConfig(string $name): mixed
|
|
||||||
```
|
|
||||||
|
|
||||||
### 描述
|
|
||||||
|
|
||||||
作者很懒,什么也没有说
|
|
||||||
|
|
||||||
### 参数
|
|
||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
|
||||||
| -------- | ---- | ----------- |
|
|
||||||
| name | string | |
|
|
||||||
|
|
||||||
### 返回
|
|
||||||
|
|
||||||
| 类型 | 描述 |
|
|
||||||
| ---- | ----------- |
|
|
||||||
| mixed | |
|
|
||||||
|
|
||||||
|
|
||||||
## parseList
|
|
||||||
|
|
||||||
```php
|
|
||||||
public function parseList(string $name): void
|
|
||||||
```
|
|
||||||
|
|
||||||
### 描述
|
|
||||||
|
|
||||||
作者很懒,什么也没有说
|
|
||||||
|
|
||||||
### 参数
|
|
||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
|
||||||
| -------- | ---- | ----------- |
|
|
||||||
| name | string | |
|
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
@@ -111,10 +47,10 @@ public function parseList(string $name): void
|
|||||||
| void | |
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
## readConfigFromFile
|
## setEnvironment
|
||||||
|
|
||||||
```php
|
```php
|
||||||
public function readConfigFromFile(mixed $filename, mixed $ext_name): array
|
public function setEnvironment(string $environment): void
|
||||||
```
|
```
|
||||||
|
|
||||||
### 描述
|
### 描述
|
||||||
@@ -125,11 +61,248 @@ public function readConfigFromFile(mixed $filename, mixed $ext_name): array
|
|||||||
|
|
||||||
| 名称 | 类型 | 描述 |
|
| 名称 | 类型 | 描述 |
|
||||||
| -------- | ---- | ----------- |
|
| -------- | ---- | ----------- |
|
||||||
| filename | mixed | |
|
| environment | string | |
|
||||||
| ext_name | mixed | |
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## loadFiles
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function loadFiles(): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## merge
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function merge(string $key, array $config): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| key | string | |
|
||||||
|
| config | array | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## get
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function get(string $key, mixed $default): mixed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| key | string | |
|
||||||
|
| default | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| mixed | |
|
||||||
|
|
||||||
|
|
||||||
|
## set
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function set(mixed $key, mixed $value): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| key | mixed | |
|
||||||
|
| value | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## getHolder
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function getHolder(): OneBot\V12\Config\Config
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| OneBot\V12\Config\Config | |
|
||||||
|
|
||||||
|
|
||||||
|
## reload
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function reload(): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## getFileMeta
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function getFileMeta(string $name): array
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| name | string | |
|
||||||
|
|
||||||
### 返回
|
### 返回
|
||||||
|
|
||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| array | |
|
| array | |
|
||||||
|
|
||||||
|
|
||||||
|
## getFileLoadType
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function getFileLoadType(string $name): string
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| name | string | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| string | |
|
||||||
|
|
||||||
|
|
||||||
|
## shouldLoadFile
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function shouldLoadFile(string $path): bool
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| path | string | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| bool | |
|
||||||
|
|
||||||
|
|
||||||
|
## loadConfigFromPath
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function loadConfigFromPath(string $path): void
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| path | string | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| void | |
|
||||||
|
|
||||||
|
|
||||||
|
## getInstance
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function getInstance(mixed $args): object
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| args | mixed | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| object | |
|
||||||
|
|||||||
@@ -90,3 +90,27 @@ public function getCallReflector(mixed $callback): ReflectionFunctionAbstract
|
|||||||
| 类型 | 描述 |
|
| 类型 | 描述 |
|
||||||
| ---- | ----------- |
|
| ---- | ----------- |
|
||||||
| ReflectionFunctionAbstract | |
|
| ReflectionFunctionAbstract | |
|
||||||
|
|
||||||
|
|
||||||
|
## getMethod
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function getMethod(string $class, string $method): ReflectionMethod
|
||||||
|
```
|
||||||
|
|
||||||
|
### 描述
|
||||||
|
|
||||||
|
作者很懒,什么也没有说
|
||||||
|
|
||||||
|
### 参数
|
||||||
|
|
||||||
|
| 名称 | 类型 | 描述 |
|
||||||
|
| -------- | ---- | ----------- |
|
||||||
|
| class | string | |
|
||||||
|
| method | string | |
|
||||||
|
|
||||||
|
### 返回
|
||||||
|
|
||||||
|
| 类型 | 描述 |
|
||||||
|
| ---- | ----------- |
|
||||||
|
| ReflectionMethod | |
|
||||||
|
|||||||
Reference in New Issue
Block a user