Joomla! API

下载
启动

InstallerAdapter

实现 ContainerAwareInterface, DatabaseAwareInterface

安装程序的抽象适配器。

抽象的
自

3.4
包

Joomla CMS

方法

__construct

构造函数

__construct(\Joomla\CMS\Installer\Installer parent, \Joomla\Database\DatabaseDriver db, mixed||string|int options = []) :
自

3.4

参数

父

Installer父对象

db

DatabaseDriver数据库对象

选项

array<string|int, mixed>配置选项

响应

混合的

__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

响应

布尔值

checkExistingExtension

检查扩展是否已存在于数据库中的方法

checkExistingExtension() :
自

3.4
抛出

RuntimeException

响应

空

checkExtensionInFilesystem

检查扩展是否在文件系统中存在的方法，如果存在，则将路由标记为更新

checkExtensionInFilesystem() :
自

3.4
抛出

RuntimeException

响应

空

copyBaseFiles

从 <files> 标签和清单文件中复制扩展的基本文件的方法

copyBaseFiles() :
抽象的
自

3.4
抛出

RuntimeException

响应

空

createExtensionRoot

在必要时创建扩展根路径的方法

createExtensionRoot() :
自

3.4
抛出

RuntimeException

响应

空

discover_install

扩展的通用 discover_install 方法

discover_install() :
自

3.4

响应

bool成功时为真

doDatabaseTransactions

处理安装程序数据库事务的方法

doDatabaseTransactions() :
自

3.4
抛出

RuntimeException

响应

bool成功时为真

doLoadLanguage

加载语言文件

doLoadLanguage( extension,  source,  base = JPATH_ADMINISTRATOR) :
自

3.4

参数

扩展

string扩展的名称

来源

string扩展的路径

基地

string扩展语言的基本路径

响应

空

finaliseInstall

完成安装处理的方法

finaliseInstall() :
抽象的
自

4.0.0
抛出

RuntimeException

响应

空

finaliseUninstall

完成卸载处理的方法

finaliseUninstall() :
抽象的
自

4.0.0
抛出

RuntimeException

响应

布尔值

getDiscoverInstallSupported

检查适配器是否支持 discover_install

getDiscoverInstallSupported() :
自

3.4

响应

布尔值

getElement

从清单中获取过滤后的扩展元素

getElement( element = null) :
自

3.4

参数

元素

string要转换的可选元素名称

响应

string过滤后的元素

getManifest

获取清单对象。

getManifest() : \SimpleXMLElement
自

3.4

响应

SimpleXMLElement清单对象

getName

从清单中获取过滤后的组件名称

getName() :
自

3.4

响应

string过滤后的名称

getParent

检索父安装程序

getParent() : \Joomla\CMS\Installer\Installer
自

4.0.0

响应

安装程序

getRoute

获取正在使用的安装路由

getRoute() :
自

3.4

响应

string安装路由

getScriptClassName

获取安装适配器脚本的类名。

getScriptClassName() :
自

3.4

响应

string类名。

install

扩展的通用安装方法

install() : bool|int
自

3.4

响应

bool|int成功时的扩展 ID，失败时为布尔值 false

parseOptionalTags

解析清单中可选标签的方法

parseOptionalTags() :
自

3.1

响应

空

parseQueries

解析 <sql> 标签中指定的查询的方法

parseQueries() :
自

3.4
抛出

RuntimeException

响应

空

prepareDiscoverInstall

为 discover_install 任务准备适配器

prepareDiscoverInstall() :
自

3.4

响应

空

removeExtensionFiles

删除此扩展的文件

removeExtensionFiles() :
抽象的
自

4.0.0
抛出

RuntimeException

响应

空

setManifest

设置清单对象。

setManifest( manifest) : \Joomla\CMS\Installer\InstallerAdapter
自

3.4

参数

清单

object清单对象

响应

InstallerAdapter支持链接的此类实例

setRoute

设置正在使用的安装路由

setRoute( route) : \Joomla\CMS\Installer\InstallerAdapter
自

3.4

参数

路由

string正在使用的安装路由

响应

InstallerAdapter支持链接的此类实例

setupInstallPaths

执行任何预检查并为扩展设置安装路径的方法

setupInstallPaths() :
抽象的
自

3.4

响应

空

setupScriptfile

为使用它的那些适配器设置清单脚本文件。

setupScriptfile() :
自

3.4

响应

空

setupUninstall

执行任何预检查并设置卸载作业的方法

setupUninstall() :
抽象的
自

4.0.0

响应

空

setupUpdates

为适配器设置更新例程的方法

setupUpdates() :
自

3.4

响应

空

storeExtension

将扩展存储到数据库中的方法

storeExtension() :
抽象的
自

3.4
抛出

RuntimeException

响应

空

triggerManifestScript

执行自定义安装脚本方法

triggerManifestScript( method) :
自

3.4
抛出

RuntimeException

参数

方法

string要执行的安装方法

响应

bool成功时为真

uninstall

扩展的通用更新方法

uninstall( id) :
自

4.0.0

参数

ID

int扩展 ID

响应

bool成功时为真

update

扩展的通用更新方法

update() : bool|int
自

3.4

响应

bool|int成功时的扩展 ID，失败时为布尔值 false

属性

changelogurl

扩展的变更日志 URL

自

4.0.0

类型

字符串

currentExtensionId

如果存在，则为当前安装扩展的 ID

自

3.4

类型

整数

元素

扩展的唯一标识符（例如 mod_login）

自

3.4

类型

字符串

扩展

扩展对象。

自

3.4

类型

扩展

extensionMessage

由自定义脚本呈现的消息

自

3.4

类型

字符串

清单

XML 清单文件的副本。

使此对象公开允许扩展在自定义脚本中自定义清单。

自

3.4

类型

SimpleXMLElement

manifest_script

清单中 scriptfile 声明所引用的 PHP 文件的路径。

自

3.4

类型

字符串

名称

扩展的名称

自

3.4

类型

字符串

父

与该适配器一起使用的安装程序

自

4.0.0

类型

安装程序

路由

安装功能路由

自

3.4

类型

字符串

supportsDiscoverInstall

适配器是否支持发现安装的标志

适配器应覆盖此选项并将值设置为 false，如果发现安装不受支持

自

3.4

类型

布尔值

类型

正在使用的适配器类型

自

3.4

类型

字符串
  • \ Joomla
  • \ CMS
  • \ Installer
  • \ InstallerAdapter