FileAdapter
扩展 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 |
参数
- 名称
string
元素的名称
响应
mixed
如果设置了元素,则为元素的值,否则为 null
canUninstallPackageChild
检查包扩展是否允许单独卸载其子扩展
canUninstallPackageChild( packageId) :
自 |
3.7.0 |
---|---|
注意 |
此方法默认设置为 true,以模拟 3.6 及更早版本的行为,这些版本不支持此查找 |
参数
- packageId
int
要检查的包的扩展 ID
响应
bool
checkExistingExtension
检查扩展是否已存在于数据库中的方法
checkExistingExtension() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
checkExtensionInFilesystem
检查扩展是否存在于文件系统中的方法,如果存在,则将路由标记为更新
checkExtensionInFilesystem() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
copyBaseFiles
从 <files>
标签和清单文件复制扩展基本文件的方法
copyBaseFiles() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
createExtensionRoot
如果需要,创建扩展根路径的方法
createExtensionRoot() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
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 |
---|
参数
- 扩展
string
扩展的名称- 源
string
扩展的路径- 基本
string
扩展语言的基本路径
响应
void
extensionExistsInSystem
用于检查扩展是否已安装的函数
extensionExistsInSystem( extension = null) :
自 |
3.1 |
---|
参数
- 扩展
string
要安装的扩展的元素名称
响应
bool
如果扩展存在,则为 True
finaliseInstall
完成安装处理的方法
finaliseInstall() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
finaliseUninstall
完成卸载处理的方法
finaliseUninstall() :
自 |
4.0.0 |
---|---|
抛出 |
|
响应
bool
getDiscoverInstallSupported
检查适配器是否支持 discover_install
getDiscoverInstallSupported() :
自 |
3.4 |
---|
响应
bool
getElement
从清单中获取过滤后的扩展元素
getElement( element = null) :
自 |
3.4 |
---|
参数
- 元素
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) :
自 |
3.1 |
---|
参数
- 路径
string
查找语言文件的路径。
响应
void
parseOptionalTags
解析清单中可选标签的方法
parseOptionalTags() :
自 |
3.4 |
---|
响应
void
parseQueries
解析 <sql>
标签中指定的查询的方法
parseQueries() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
populateFilesAndFolderList
用于填充文件和文件夹列表的函数
populateFilesAndFolderList() :
自 |
3.1 |
---|
响应
bool
无
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() :
自 |
3.4 |
---|---|
抛出 |
|
响应
void
triggerManifestScript
执行自定义安装脚本方法
triggerManifestScript( method) :
自 |
3.4 |
---|---|
抛出 |
|
参数
- 方法
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
元素
扩展的唯一标识符(例如 mod_login)
自 |
3.4 |
---|
类型
string
extensionMessage
自定义脚本呈现的消息
自 |
3.4 |
---|
类型
string
清单
XML 清单文件的副本。
使此对象公开允许扩展在自定义脚本中自定义清单。
自 |
3.4 |
---|
类型
SimpleXMLElement
manifest_script
清单中 scriptfile 声明所引用的 PHP 文件的路径。
自 |
3.4 |
---|
类型
string
名称
扩展的名称
自 |
3.4 |
---|
类型
string
路由
安装功能路由
自 |
3.4 |
---|
类型
string
supportsDiscoverInstall
适配器是否支持发现安装的标志
适配器应覆盖此项,如果发现安装不受支持,则设置为 false
自 |
3.4 |
---|
类型
bool
类型
正在使用的适配器类型
自 |
3.4 |
---|
类型
string
scriptElement
<scriptfile>
扩展清单的元素
自 |
3.1 |
---|
类型
object
folderList
已处理文件夹的列表
自 |
3.4 |
---|
类型
array<string|int, mixed>
fileList
已处理文件的列表
自 |
3.4 |
---|
类型
array<string|int, mixed>