PackageAdapter

扩展自 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数据库对象

options

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

响应

混合

__get

db 变量的代理。

__get( name) : 
继承的 已弃用

4.2.0

已弃用

4.3 将在 6.0 中删除,使用 getDatabase() 代替直接访问 _db

参数

name

string元素的名称

响应

mixed元素的值(如果已设置),否则为 null

_getExtensionId

获取扩展 ID。

_getExtensionId( type,  id,  client,  group) : 

3.1

参数

type

string扩展类型。

id

string扩展的名称(元素字段)。

client

int应用程序 ID(0:Joomla CMS 网站;1:Joomla CMS 管理员)。

group

string扩展组(主要用于插件)。

响应

int

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_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

参数

extension

string扩展的名称

source

string扩展的路径

base

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

参数

element

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( path) : 

3.1

参数

path

string语言的路径。

响应

void

onExtensionAfterInstall

onExtensionAfterInstall 事件的处理程序

onExtensionAfterInstall(\Joomla\Event\Event event) : 

3.7.0

参数

event

Event事件

响应

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

参数

manifest

object清单对象

响应

InstallerAdapter此类的实例,以支持链接

setRoute

设置正在使用的安装路由

setRoute( route) : \Joomla\CMS\Installer\InstallerAdapter
继承的

3.4

参数

route

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

参数

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

extension

扩展对象。

继承的

3.4

类型

扩展

extensionMessage

由自定义脚本呈现的消息

继承的

3.4

类型

string

manifest

XML 清单文件的副本。

继承的

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

3.4

类型

SimpleXMLElement

manifest_script

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

继承的

3.4

类型

string

name

扩展的名称

继承的

3.4

类型

string

父级

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

继承的

4.0.0

类型

安装程序

route

安装函数路由

继承的

3.4

类型

string

supportsDiscoverInstall

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

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

3.4

类型

bool

type

正在使用的适配器类型

继承的

3.4

类型

string

installedIds

每个安装的扩展的扩展 ID 数组

3.7.0

类型

array<string|int, mixed>

results

每个安装的扩展的结果

3.1

类型

array<string|int, mixed>