插件增强库
写入日志
writeLog($content, $module = '', $logfilename = '', $level = 2)
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| content | string | false | 日志内容 |
| module | string | true | 模块名称 |
| logfilename | string | true | 日志文件名 (留空为当前插件包名, 不需要加 .log) |
| level | int | true | 日志级别 (1 DEBUG, 2 INFO, 3 WARN, 4 ERROR, 5 FATAL) |
无返回值
读取配置文件
getConfig($configFile = '')
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| configFile | string | true | 配置文件名 (留空为当前插件包名, 不需要加拓展名) |
返回值
array JSON 解码后的配置文件内容，如果配置文件为空或不存在则返回空数组。
写入配置文件
saveConfig($configFile = '', $config, $jsonEncodeFlags = JSON_UNESCAPED_UNICODE)
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| configFile | string | true | 配置文件名 (留空为当前插件包名, 不需要加拓展名) |
| config | array | false | 配置内容 (要求能被 JSON 编码) |
| jsonEncodeFlags | int | true | json_encode flags |
返回值
bool 成功为 true, 失败为 false
获取前置插件类
提示
只需要使用前置插件中的常量或静态函数时，可以使用此函数获取插件类而无需实例化。使用 :: 静态调用即可。 例如 plugin_getFrontClass('top.nkxingxh.examplePlugin')::func()
plugin_getFrontClass(string $package)
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| package | string | false | 要实例化插件类的插件包名 |
返回值
- 成功
string插件类名 - 失败
bool该插件不是一个前置插件返回 false - 失败
null插件不存在
实例化前置插件对象
plugin_loadFrontObject(string $package, ...$init_args)
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| package | string | false | 要实例化插件类的插件包名 |
| init_args | any | true | 这些参数将传给插件类的构造函数用于初始化 |
返回值
- 成功
object插件对象 - 失败
bool该插件不是一个前置插件返回 false - 失败
null插件不存在
获取插件列表
pluginsList(bool $provide_infos = false): ?array
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| provide_infos | bool | true | 是否提供插件信息 (插件名、作者等)。默认只提供插件包名与版本 |
返回值
- 成功
array插件列表 - 失败
null未加载插件或框架异常
判断插件是否成功加载
plugin_isLoaded(string $package): ?bool
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| package | string | false | 目标插件包名 |
返回值
- 成功
bool插件成功加载返回 true - 失败
bool插件未启用或加载失败返回 false - 失败
null插件不存在
获取插件信息
plugin_getInfo(string $package): ?array
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| package | string | false | 目标插件包名 |
返回值
- 成功
array插件信息 - 失败
null插件不存在
获取当前插件包名
提示
这个函数一般是供本框架的函数判断当前插件所用，在插件开发中请直接使用 self::_pluginPackage 来获取当前插件包名。
plugin_whoami(bool $backtrace = MIRAIEZ_PLUGINS_WHOAMI_BACKTRACE)
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| backtrace | bool | true | 是否使用 debug_backtrace 获取堆栈以取得准确的插件包名 |
注意
不使用 debug_backtrace 方法时，将无法准确取得被其他插件调用的前置插件的包名。 例如在插件 A 中实例化插件 B，插件 B 的方法 F() 中使用了 plugin_whoami()，此时在插件 A 中调用插件 B 的 F() 方法，该方法中的 plugin_whoami() 获取到的将是插件 A 的包名
性能
使用 debug_backtrace 的方法获取当前插件包名，可以避免上述情况，但是所需时间约为不使用 debug_backtrace 方法的 6 倍。 在 E5-2698 V3 的机器上，运行 1000000 次所需时间分别为 3.0328s 与 0.4818s
返回值
- 成功
object插件对象 - 失败
bool该插件不是一个前置插件返回 false - 失败
null插件不存在