每个插件下面都会自动生成一个插件信息文件(info.php)。
插件信息配置文件(info.php)返回的是一个数据,数据结构如下:
| 参数名 | 含义 | 数据类型 | 必填项 |
| --- | --- | --- | --- |
| name | 插件名 | string | 是 |
| title | 插件标题 | string | 是 |
| identifier | 插件唯一标识 | string | 是 |
| icon | 插件图标 | string | 是 |
| intro | 插件简介 | string | 否 |
| author | 插件作者 | string | 否 |
| author_url | 作者URL | string | 否 |
| version | 插件版本号 | string | 是 |
| db_prefix | 插件表前缀 | string | 是 |
| config | 插件配置 | array | 否 |
模块参数详解如下:
## [name] 插件名
可使用字母(小写)、数字、下划线组成,建议尽量不要使用数字和下划线。
例:login
## [title] 插件标题
该标题会在后台左侧的导航插件列表下面显示。
例:第三方登录插件
## [identifier] 插件唯一标识
区分不同开发者不同插件的唯一标识,格式:插件名.开发者标识(只能为字母、数字、下划线).plugins,如果您的插件有上云的话,插件标识由云端自动生成。后续会详细说明。
例:login.hisiphp.plugins
## [icon] 模块图标
插件图标,主要用于后台插件管理展示,图标尺寸要求200px * 200px,格式为PNG
## [intro] 模块简介
对插件进行简单的描述,以便使用者能快速的了解该插件的功能信息。
## [author] 模块作者
指插件开发者的名称(姓名或昵称均可)
## [author_url] 作者URL
开发者的网站地址,必须是完整的网站链接地址。
例:http://www.hisiphp.com
## [version] 模块版本号
>[info] 格式 1.0.0
插件版本号一定要按照要求填写,插件升级的时候,将以此版本号做为对比。
版本号格式采用三段式:主版本号.次版本号.修订版本号。例:1.0.0
主版本号【位数变化:1-99】:当插件出现大更新或者很大的改动,比如整体架构发生变化。此版本号会变化。
次版本号【位数变化:0-999】:当插件功能有新增或删除,此版本号会变化,如果仅仅是补充原有功能时,此版本号不变化。
修订版本号【位数变化:0-999】:一般是 Bug 修复或是一些小的变动,功能上没有大的变化,修复一个严重的bug即发布一个修订版。
## [db_prefix] 表前缀
例如:数据表名”hisiphp_login_oauth“,我们将他拆解为3段来理解:”hisiphp_“为表前缀,”login“为插件名,”oauth“为具体的数据表名。拆解后的”hisiphp_“就是我们要得到表前缀。
填写了表前缀后,系统在安装当前插件时,会自动将此表前缀替换成当前系统所设置的表前缀。
>[danger] 特别提醒:表前缀必须要跟插件目录下面的sql/install.sql文件里面的表前缀一样。
## [config] 插件配置
针对当前模块需要一些自定义配置的话,则需要填写此参数。
>[info]格式:['sort' => '排序','title' => '标题','name' => '名称','type' => '类型','options' => '选项','value' => '默认值', 'tips' => '提示']
各参数设置实例可参考:管理后台->系统->系统功能->配置管理->添加
| 参数 | 含义 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- | --- |
| sort | 排序 | int | 是 | 无 |
| title | 标题 | string | 是 | 2-12个字符 |
| name | 字段名称 | string | 是 | 可由字母、数字、下划线组成 |
| type | 表单类型 | string | 是 | 下文单独介绍 |
| options | 表单选项 | string | 否 | 下文单独介绍 |
| value | 默认值 | string/int | 否 | 下文单独介绍 |
| tips | 提示 | string | 否 | 关于此配置的提示信息或使用说明,支持HTML标签 |
>[info]参数名:type,此参数可选值如下:
input,textarea,array,switch,radio,checkbox
select,hidden,image,file,date,datetime,time
>[info]参数名:options,此参数仅适用于表单类型[type]为单选按钮(radio)、多选按钮(checkbox)、下拉框(select)、开关(switch),具体使用方式如下:
~~~
[radio]单选按钮参考格式:
0:男票
1:女票
~~~
~~~
[checkbox]多选按钮参考格式:
1:唱歌
2:跳舞
3:旅游
4:文学
~~~
~~~
[select]下拉框参考格式:
1:北京
2:上海
3:广州
4:深圳
~~~
~~~
[switch]开关参考格式:
0:关闭
1:开启
~~~
>[info]参数名:value,表单默认值。
配置类型为单选按钮(radio)、多选按钮(checkbox)、下拉框(select)、开关(switch)时请按如下格式填写,其他类型直接填写字符串即可。
键值:键名
插件配置示例代码如下:
~~~
'config' => [
[
'sort' => '100',
'title' => 'AppID',
'name' => 'app_id',
'type' => 'input',
'options' => '',
'value' => '',
'tips' => '开放平台APP ID',
], [
'sort' => '101',
'title' => 'AppSecret',
'name' => 'app_secret',
'type' => 'input',
'options' => '',
'value' => '',
'tips' => '开放平台APP Secret',
],
],
~~~
配置后的效果如下:
![](https://box.kancloud.cn/dec133d33cba069b049d6e680b98dfbc_1948x1018.png)
插件配置参数已加好,那么如何调用插件配置呢?
插件调用方法与ThinkPHP的配置调用方式一样,同样使用config函数调用。
>[info] 格式:config('plugins_插件名.配置名[name]')
示例:config('plugins_login.app_id')