ComponentAdapter
扩展自 InstallerAdapter组件安装程序
| 自 |
3.1 |
|---|---|
| 软件包 |
Joomla CMS |
方法
__construct
构造函数
__construct(\Joomla\CMS\Installer\Installer parent, \Joomla\Database\DatabaseDriver db, mixed||string|int options = []) :
__get
db 变量的代理。
__get( name) :
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除 使用 getDatabase() 而不是直接访问 _db |
参数
- name
string元素的名称
响应
mixed如果设置了元素的值，否则为 null
_buildAdminMenus
用于构建组件菜单数据库条目的方法
_buildAdminMenus(int|null componentId = null) :
| 自 |
3.1 |
|---|
参数
- componentId
int|null我正在为其构建菜单的组件 ID
响应
bool如果成功则为 True
_createAdminMenuItem
在数据库中创建菜单项。如果该项已存在，则尝试将其删除并重新创建。
_createAdminMenuItem(mixed||string|int &data, parentId) : bool|int
| 抛出 |
|
|---|---|
| 自 |
3.1 |
参数
- data
array<string|int, mixed>要创建的菜单项数据- parentId
int父菜单项 ID
响应
bool|int成功时为菜单项 ID，失败时为 false
_removeAdminMenus
用于删除对组件的管理员菜单引用的方法
_removeAdminMenus( id) :
| 抛出 |
|
|---|---|
| 自 |
3.1 |
参数
- id
int将删除其管理员菜单的扩展的 ID
响应
bool如果成功则为 True。
_updateMenus
如果组件之前已被卸载，则用于更新组件菜单数据库条目的方法。
_updateMenus(int|null componentId, clientId = null) :
| 自 |
3.7.0 |
|---|
参数
- componentId
int|null组件 ID。- clientId
int客户端 ID
响应
bool如果成功则为 True
_updateSiteMenus
如果组件之前已被卸载，则用于更新组件菜单数据库条目的方法。
_updateSiteMenus(int|null componentId = null) :
注意：这不会更新管理员菜单。使用 _updateMenus() 来更新管理员菜单以及其他菜单。
| 自 |
3.4.2 |
|---|
参数
- componentId
int|null组件 ID。
响应
bool如果成功则为 True
canUninstallPackageChild
检查软件包扩展是否允许单独卸载其子扩展
canUninstallPackageChild( packageId) :
| 自 |
3.7.0 |
|---|---|
| 注意 |
此方法默认为 true 以模拟 3.6 及更早版本的行为，这些版本不支持此查找 |
参数
- packageId
int要检查的软件包的扩展 ID
响应
bool
checkExistingExtension
用于检查扩展是否已存在于数据库中的方法
checkExistingExtension() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
checkExtensionInFilesystem
用于检查扩展是否存在于文件系统中的方法
checkExtensionInFilesystem() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
bool
copyBaseFiles
用于从 <files> 标记和清单文件中复制扩展的基本文件的方法
copyBaseFiles() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
createExtensionRoot
用于在必要时创建扩展根路径的方法
createExtensionRoot() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
discover
发现未注册的扩展。
discover() : mixed||string|int
| 自 |
3.1 |
|---|
响应
array<string|int, mixed>扩展列表。
discover_install
扩展的通用 discover_install 方法
discover_install() :
| 自 |
3.4 |
|---|
响应
bool成功时为 True
doDatabaseTransactions
用于处理安装程序的数据库事务的方法
doDatabaseTransactions() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
bool成功时为 True
doLoadLanguage
加载语言文件
doLoadLanguage( extension, source, base = JPATH_ADMINISTRATOR) :
| 自 |
3.4 |
|---|
参数
- extension
string扩展的名称- source
string扩展的路径- base
string扩展语言的基本路径
响应
void
finaliseInstall
用于完成安装处理的方法
finaliseInstall() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
finaliseUninstall
用于完成卸载处理的方法
finaliseUninstall() :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
响应
bool
getDiscoverInstallSupported
检查适配器是否支持 discover_install
getDiscoverInstallSupported() :
| 自 |
3.4 |
|---|
响应
bool
getElement
从清单中获取已过滤的扩展元素
getElement( element = null) :
| 自 |
3.4 |
|---|
参数
- element
string要转换的可选元素名称
响应
string已过滤的元素
getManifest
获取清单对象。
getManifest() : \SimpleXMLElement
| 自 |
3.4 |
|---|
响应
SimpleXMLElement清单对象
getName
从清单中获取已过滤的组件名称
getName() :
| 自 |
3.4 |
|---|
响应
string已过滤的名称
getRoute
获取正在遵循的安装路径
getRoute() :
| 自 |
3.4 |
|---|
响应
string安装路径
getScriptClassName
获取安装适配器脚本的类名。
getScriptClassName() :
| 自 |
3.4 |
|---|
响应
string类名。
install
扩展的通用安装方法
install() : bool|int
| 自 |
3.4 |
|---|
响应
bool|int成功时为扩展 ID，失败时为布尔值 false
loadLanguage
自定义 loadLanguage 方法
loadLanguage( path = null) :
| 自 |
3.1 |
|---|
参数
- path
string语言文件所在的路径。
响应
void
parseOptionalTags
用于解析清单中可选标记的方法
parseOptionalTags() :
| 自 |
3.4 |
|---|
响应
void
parseQueries
用于解析在 <sql> 标记中指定的查询的方法
parseQueries() :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
响应
void
prepareDiscoverInstall
为 discover_install 任务准备适配器
prepareDiscoverInstall() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
refreshManifestCache
刷新扩展表缓存
refreshManifestCache() :
| 自 |
3.1 |
|---|
响应
bool操作结果，如果更新则为 true，失败则为 false
removeExtensionFiles
删除此扩展的文件
removeExtensionFiles() :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
响应
void
setManifest
设置清单对象。
setManifest( manifest) : \Joomla\CMS\Installer\InstallerAdapter
setRoute
设置正在遵循的安装路径
setRoute( route) : \Joomla\CMS\Installer\InstallerAdapter
setupInstallPaths
用于执行任何预检查并为扩展设置安装路径的方法
setupInstallPaths() :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
响应
void
setupScriptfile
为使用它的适配器设置清单脚本文件。
setupScriptfile() :
| 自 |
3.4 |
|---|
响应
void
setupUninstall
用于执行任何预检查并设置卸载作业的方法
setupUninstall() :
| 自 |
4.0.0 |
|---|
响应
void
setupUpdates
用于为适配器设置更新例程的方法
setupUpdates() :
| 自 |
3.4 |
|---|
响应
void
storeExtension
用于将扩展存储到数据库中的方法
storeExtension( deleteExisting = false) :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
参数
- deleteExisting
bool我是否应该尝试删除相同组件的现有记录？
响应
void
triggerManifestScript
执行自定义安装脚本方法
triggerManifestScript( method) :
| 自 |
3.4 |
|---|---|
| 抛出 |
|
参数
- method
string要执行的安装方法
响应
bool成功时为 True
uninstall
扩展的通用更新方法
uninstall( id) :
| 自 |
4.0.0 |
|---|
参数
- id
int扩展 ID
响应
bool成功时为 True
update
扩展的通用更新方法
update() : bool|int
| 自 |
3.4 |
|---|
响应
bool|int成功时为扩展 ID，失败时为布尔值 false
属性
changelogurl
扩展的更改日志 URL
| 自 |
4.0.0 |
|---|
类型
string
currentExtensionId
如果存在，则为当前已安装扩展的 ID
| 自 |
3.4 |
|---|
类型
int
element
扩展的唯一标识符（例如 mod_login）
| 自 |
3.4 |
|---|
类型
string
extensionMessage
自定义脚本呈现的消息
| 自 |
3.4 |
|---|
类型
string
manifest
XML 清单文件的副本。
公开此对象允许扩展在自定义脚本中自定义清单。
| 自 |
3.4 |
|---|
类型
SimpleXMLElement
manifest_script
清单中 scriptfile 声明引用的 PHP 文件的路径。
| 自 |
3.1 |
|---|
类型
string
name
扩展的名称
| 自 |
3.4 |
|---|
类型
string
route
安装函数路由
| 自 |
3.4 |
|---|
类型
string
supportsDiscoverInstall
适配器是否支持发现安装的标志
如果 discover install 不受支持，则适配器应覆盖此标志并将其设置为 false
| 自 |
3.4 |
|---|
类型
bool
type
正在使用的适配器类型
| 自 |
3.4 |
|---|
类型
string
oldAdminFiles
已安装的 Joomla! CMS 管理员的当前文件列表，并从更新区域中的磁盘上的清单中读取，以处理执行差异并删除旧文件列表中存在但在新文件列表中不存在的文件。
| 自 |
3.1 |
|---|
类型
array<string|int, mixed>
oldApiFiles
已安装的 Joomla! CMS API 的当前文件列表，并从更新区域中的磁盘上的清单中读取，以处理执行差异并删除旧文件列表中存在但在新文件列表中不存在的文件。
| 自 |
4.0.0 |
|---|
类型
array<string|int, mixed>
oldFiles
已安装的当前文件列表，并从更新区域中的磁盘上的清单中读取，以处理执行差异并删除旧文件列表中存在但在新文件列表中不存在的文件。
| 自 |
3.1 |
|---|
类型
array<string|int, mixed>
install_script
对于旧版安装，这是清单中 scriptfile 声明引用的 PHP 文件的路径。
| 自 |
3.1 |
|---|
类型
string