LibraryAdapter

继承自 InstallerAdapter

库安装程序

3.1

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

响应

bool

checkExistingExtension

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

checkExistingExtension() : 
继承

3.4

抛出

RuntimeException

响应

void

checkExtensionInFilesystem

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

checkExtensionInFilesystem() : 

3.4

抛出

RuntimeException

响应

void

copyBaseFiles

将扩展的基本文件从 <files> 标记和清单文件复制到文件系统的方法

copyBaseFiles() : 

3.4

抛出

RuntimeException

响应

void

createExtensionRoot

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

createExtensionRoot() : 
继承

3.4

抛出

RuntimeException

响应

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

抛出

RuntimeException

响应

bool成功时为 True

doLoadLanguage

加载语言文件

doLoadLanguage( extension,  source,  base = JPATH_ADMINISTRATOR) : 
继承

3.4

参数

扩展

string扩展的名称

来源

string扩展的路径

string扩展语言的基本路径

响应

void

finaliseInstall

完成安装处理的方法

finaliseInstall() : 

3.4

抛出

RuntimeException

响应

void

finaliseUninstall

完成卸载处理的方法

finaliseUninstall() : 

4.0.0

抛出

RuntimeException

响应

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已过滤的名称

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

loadLanguage

自定义 loadLanguage 方法

loadLanguage( path = null) : 

3.1

参数

路径

string查找语言文件的路径。

响应

void

parseOptionalTags

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

parseOptionalTags() : 

3.4

响应

void

parseQueries

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

parseQueries() : 
继承

3.4

抛出

RuntimeException

响应

void

prepareDiscoverInstall

为 discover_install 任务准备适配器

prepareDiscoverInstall() : 

3.4

响应

void

refreshManifestCache

刷新扩展表缓存

refreshManifestCache() : 

3.1

响应

bool操作的结果,如果已更新,则为 true,失败时为 false

removeExtensionFiles

删除此扩展的文件

removeExtensionFiles() : 

4.0.0

抛出

RuntimeException

响应

void

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

抛出

RuntimeException

响应

void

setupScriptfile

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

setupScriptfile() : 
继承

3.4

响应

void

setupUninstall

对扩展进行任何预检查并设置卸载作业的方法

setupUninstall() : 

4.0.0

响应

void

setupUpdates

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

setupUpdates() : 
继承

3.4

响应

void

storeExtension

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

storeExtension() : 

3.4

抛出

RuntimeException

响应

void

triggerManifestScript

执行自定义安装脚本方法

triggerManifestScript( method) : 
继承

3.4

抛出

RuntimeException

参数

方法

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

扩展

扩展对象。

继承

3.4

类型

扩展

extensionMessage

自定义脚本呈现的消息

继承

3.4

类型

string

清单

XML 清单文件的副本。

继承

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

3.4

类型

SimpleXMLElement

manifest_script

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

继承

3.4

类型

string

名称

扩展的名称

继承

3.4

类型

string

父级

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

继承

4.0.0

类型

安装程序

路由

安装函数路由

继承

3.4

类型

string

supportsDiscoverInstall

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

继承

适配器应该覆盖此项,如果发现安装不受支持,则设置为 false

3.4

类型

bool

类型

正在使用的适配器类型

继承

3.4

类型

string