InstallerScript
扩展使用的基本安装脚本，提供用于常见行为的辅助方法。
| 自 |
3.6 |
|---|---|
| 包 |
Joomla CMS |
方法
addDashboardMenu
创建仪表盘菜单模块
addDashboardMenu( dashboard, preset) :
| 抛出 |
|
|---|---|
| 自 |
4.0.0 |
参数
- 仪表盘
string仪表盘的名称- 预设
string菜单预设的名称
响应
void
getInstances
获取 #__modules 表中每个模块的实例
getInstances( isModule) : mixed||string|int
| 自 |
3.6 |
|---|
参数
- isModule
bool如果扩展是模块，则为 true，因为模块可以有多个实例
响应
array<string|int, mixed>扩展的 ID 数组
getItemArray
构建一个标准的选择查询，以在本脚本中生成更好的 DRY 代码。
getItemArray( element, table, column, identifier) : mixed||string|int
这应该生成一个唯一的单元格，该单元格使用 json 编码 - 然后将返回一个包含该数据关联数组。
| 自 |
3.6 |
|---|
参数
- 元素
string要从查询中获取的元素- 表
string要搜索数据的表- 列
string要搜索的数据库列- 标识符
mixed整数 ID 或字符串
响应
array<string|int, mixed>包含来自单元格数据的关联数组
getParam
获取扩展表中扩展行的参数值
getParam( name, id) :
| 自 |
3.6 |
|---|
参数
- 名称
string要检索的参数的名称- id
int参数表中条目的 ID
响应
string所需的参数
moveCliFiles
将 CLI 脚本移动到 CMS 中的 CLI 文件夹
moveCliFiles() :
| 自 |
3.6 |
|---|
响应
void
preflight
在开始扩展安装/更新/删除过程之前调用的函数
preflight( type, \Joomla\CMS\Installer\InstallerAdapter parent) :
removeFiles
从给定数组中删除文件和文件夹
removeFiles() :
| 自 |
3.6 |
|---|
响应
void
setParams
在扩展表中扩展行的参数值。请注意，必须分别调用此方法来删除和编辑。注意，如果编辑被调用为类型，则如果参数不存在，则会创建它。
setParams(mixed||string|int paramArray = null, type = 'edit', id) :
| 自 |
3.6 |
|---|
参数
- paramArray
array<string|int, mixed>要添加/编辑/删除的参数数组- 类型
string要对参数进行的更改类型（编辑/删除）- id
int相关表中条目的 ID
响应
bool成功时为 true
属性
发布
扩展的版本号。
| 自 |
3.6 |
|---|
类型
string
paramTable
存储参数的表。
| 自 |
3.6 |
|---|
类型
string
扩展
扩展名。这应该在安装脚本中设置。
| 自 |
3.6 |
|---|
类型
string
deleteFiles
要删除的文件列表
| 自 |
3.6 |
|---|
类型
array<string|int, mixed>
deleteFolders
要删除的文件夹列表
| 自 |
3.6 |
|---|
类型
array<string|int, mixed>
cliScriptFiles
要复制到 cli 目录的 CLI 脚本文件列表
| 自 |
3.6 |
|---|
类型
array<string|int, mixed>
minimumPhp
安装扩展所需的最低 PHP 版本
| 自 |
3.6 |
|---|
类型
string
minimumJoomla
安装扩展所需的最低 Joomla! 版本
| 自 |
3.6 |
|---|
类型
string
allowDowngrades
允许降级您的扩展
自担风险使用，因为如果有功能变化，人们可能希望降级。
| 自 |
3.6 |
|---|
类型
bool