zhamao-framework/docs/api/ZM/Utils/DataProvider.md

199 lines
2.9 KiB
Markdown
Raw Normal View History

2022-03-27 16:42:36 +08:00
# ZM\Utils\DataProvider
## getResourceFolder
```php
public function getResourceFolder(): string
```
### 描述
返回资源目录
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| string | |
## getWorkingDir
```php
public function getWorkingDir(): false|string
```
### 描述
返回工作目录,不带最右边文件夹的斜杠(/
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| false|string | |
## getFrameworkRootDir
```php
public function getFrameworkRootDir(): false|string
```
### 描述
获取框架所在根目录
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| false|string | |
## getSourceRootDir
```php
public function getSourceRootDir(): false|string
```
### 描述
获取源码根目录除Phar模式外均与工作目录相同
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| false|string | |
## getFrameworkLink
```php
public function getFrameworkLink(): null|array|false|mixed
```
### 描述
获取框架反代链接
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| null|array|false|mixed | |
## getDataFolder
```php
public function getDataFolder(string $second): null|array|false|mixed|string
```
### 描述
获取zm_data数据目录如果二级目录不为空则自动创建目录并返回
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| second | string | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| null|array|false|mixed|string | |
## saveToJson
```php
public function saveToJson(mixed $filename, mixed $file_array): false|int
```
### 描述
将变量保存在zm_data下的数据目录传入数组
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| filename | mixed | |
| file_array | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| false|int | |
## loadFromJson
```php
public function loadFromJson(mixed $filename): null|mixed
```
### 描述
从json加载变量到内存
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| filename | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| null|mixed | |
## scanDirFiles
```php
public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive): array|false
```
### 描述
递归或非递归扫描目录,可返回相对目录的文件列表或绝对目录的文件列表
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| dir | mixed | |
| relative | bool|string | |
| recursive | bool | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| array|false | |
## isRelativePath
```php
public function isRelativePath(mixed $path): bool
```
### 描述
检查路径是否为相对路径(根据第一个字符是否为"/"来判断)
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| path | mixed | |
### 返回
| 类型 | 描述 |
| ---- | ----------- |
| bool | |