Joomla! CMS 5.1.x API » \Joomla\CMS\Installer\Adapter\ModuleAdapter

构造函数

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

继承

自版本	3.4

参数

父级: Installer父级对象
db: DatabaseDriver数据库对象
options: array<string|int, mixed>配置选项

返回值

混合类型

db 变量的代理。

__get( name) :

继承已弃用

自版本	4.2.0
已弃用	4.3 将在 6.0 中移除。请使用 getDatabase() 而不是直接访问 _db

参数

name: string元素的名称

返回值

mixed如果设置了元素的值，则为该值，否则为 null

自定义回滚方法

回滚菜单项

_rollback_menu(mixed||string|int arg) :

自版本	3.1

参数

arg: array<string|int, mixed>要回滚的安装步骤

返回值

bool成功时为 True

自定义回滚方法

回滚模块项

_rollback_module(mixed||string|int arg) :

自版本	3.1

参数

arg: array<string|int, mixed>要回滚的安装步骤

返回值

bool成功时为 True

检查软件包扩展是否允许单独卸载其子扩展

canUninstallPackageChild( packageId) :

继承

自版本	3.7.0
注意	此方法默认为 true 以模拟 3.6 及更早版本的行为，这些版本不支持此查找

参数

packageId: int要检查的软件包的扩展 ID

返回值

bool

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

checkExistingExtension() :

自版本	3.4
抛出	`RuntimeException`

返回值

void

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

checkExtensionInFilesystem() :

继承

自版本	3.4
抛出	`RuntimeException`

返回值

void

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

copyBaseFiles() :

自版本	3.4
抛出	`RuntimeException`

返回值

void

如有必要，创建扩展根路径的方法

createExtensionRoot() :

继承

自版本	3.4
抛出	`RuntimeException`

返回值

void

自定义发现方法

discover() : mixed||string|int

自版本	3.1

返回值

array<string|int, mixed>可用扩展的扩展列表

扩展的通用 discover_install 方法

discover_install() :

继承

自版本	3.4

返回值

bool成功时为 True

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

doDatabaseTransactions() :

继承

自版本	3.4
抛出	`RuntimeException`

返回值

bool成功时为 True

加载语言文件

doLoadLanguage( extension,  source,  base = JPATH_ADMINISTRATOR) :

继承

自版本	3.4

参数

extension: string扩展的名称
source: string扩展的路径
base: string扩展语言的基本路径

返回值

void

完成安装处理的方法

finaliseInstall() :

自版本	3.4
抛出	`RuntimeException`

返回值

void

完成卸载处理的方法

finaliseUninstall() :

自版本	4.0.0
抛出	`RuntimeException`

返回值

bool

检查适配器是否支持 discover_install

getDiscoverInstallSupported() :

继承

自版本	3.4

返回值

bool

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

getElement( element = null) : string|null

自版本	3.4

参数

element: string要转换的可选元素名称

返回值

string|null已过滤的元素

获取清单对象。

getManifest() : \SimpleXMLElement

继承

自版本	3.4

返回值

SimpleXMLElement清单对象

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

getName() :

继承

自版本	3.4

返回值

string已过滤的名称

检索父安装程序

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

继承

自版本	4.0.0

返回值

Installer

获取正在使用的安装路由

getRoute() :

继承

自版本	3.4

返回值

string安装路由

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

getScriptClassName() :

继承

自版本	3.4

返回值

string类名。

扩展的通用安装方法

install() : bool|int

继承

自版本	3.4

返回值

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

自定义 loadLanguage 方法

loadLanguage( path = null) :

自版本	3.4

参数

path: string我们找到语言文件的路径

返回值

void

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

parseOptionalTags() :

自版本	3.4

返回值

void

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

parseQueries() :

继承

自版本	3.4
抛出	`RuntimeException`

返回值

void

为 discover_install 任务准备适配器

prepareDiscoverInstall() :

自版本	3.4

返回值

void

刷新扩展表缓存

refreshManifestCache() :

自版本	3.1

返回值

bool操作结果，如果已更新则为 true，失败则为 false。

删除此扩展的文件

removeExtensionFiles() :

自版本	4.0.0
抛出	`RuntimeException`

返回值

void

设置清单对象。

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

继承

自版本	3.4

参数

manifest: object清单对象

返回值

InstallerAdapter支持链式调用的此类的实例

设置正在使用的安装路由

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

继承

自版本	3.4

参数

route: string正在使用的安装路由

返回值

InstallerAdapter支持链式调用的此类的实例

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

setupInstallPaths() :

自版本	3.4
抛出	`RuntimeException`

返回值

void

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

setupScriptfile() :

继承

自版本	3.4

返回值

void

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

setupUninstall() :

自版本	4.0.0

返回值

void

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

setupUpdates() :

继承

自版本	3.4

返回值

void

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

storeExtension() :

自版本	3.4
抛出	`RuntimeException`

返回值

void

执行自定义安装脚本方法

triggerManifestScript( method) :

继承

自版本	3.4
抛出	`RuntimeException`

参数

method: string要执行的安装方法

返回值

bool成功时为 True

扩展的通用更新方法

uninstall( id) :

继承

自版本	4.0.0

参数

id: int扩展 ID

返回值

bool成功时为 True

扩展的通用更新方法

update() : bool|int

继承

自版本	3.4

返回值

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

扩展的更改日志 URL

继承

自版本	4.0.0

类型

string

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

继承

自版本	3.4

类型

int

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

继承

自版本	3.4

类型

string

扩展对象。

继承

自版本	3.4

类型

Extension

自定义脚本呈现的消息

继承

自版本	3.4

类型

string

XML 清单文件的副本。

继承

将此对象设为公共允许扩展在自定义脚本中自定义清单。

自版本	3.4

类型

SimpleXMLElement

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

继承

自版本	3.4

类型

string

扩展的名称

继承

自版本	3.4

类型

string

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

继承

自版本	4.0.0

类型

Installer

安装函数路由

继承

自版本	3.4

类型

string

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

继承

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

自版本	3.4

类型

bool

正在使用的适配器类型

继承

自版本	3.4

类型

string

安装客户端 ID

自版本	3.4

类型

int

<scriptfile> 扩展清单的元素

自版本	3.1

类型

object