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

构造函数

__construct( basepath = __DIR__,  classprefix = 'JoomlaCMSInstallerAdapter',  adapterfolder = 'Adapter') :

自	3.1

参数

basepath: string适配器的基本路径
classprefix: string适配器的类前缀
adapterfolder: string要附加到基本路径的文件夹名称

响应

混合

安装中止方法

abort( msg = null,  type = null) :

自	3.1

参数

msg: string安装程序发出的中止消息
type: string如果已定义，则为包类型

响应

bool如果成功，则为 True

如果以其他方式安装已发现的扩展，则清理这些扩展

cleanDiscoveredExtension( type,  element,  folder = '',  client) :

自	3.1

参数

type: string扩展类型（组件等）
element: string唯一的元素标识符（例如 com_content）
folder: string扩展的文件夹（插件；例如 system）
client: int客户端应用程序（管理员或网站）

响应

object查询结果

Copyfiles

copyFiles(mixed||string|int files,  overwrite = null) :

自	3.1

参数

files: array<string|int, mixed>包含文件名数组
overwrite: bool如果可以替换现有文件，则为 True

响应

bool成功则为 True

将安装清单文件复制到给定客户端中的扩展文件夹

copyManifest( cid = 1) :

自	3.1

参数

cid: int要复制 installfile 的位置 [可选：默认值为 1（管理员）]

响应

bool成功则为 True，错误则为 False

如果尚未分配，则设置默认值

def( property,  default = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除不应再使用定义动态属性

参数

property: string属性的名称。
default: mixed默认值。

响应

混合

扩展发现方法

discover() : \Joomla\CMS\Installer\InstallerExtension||string|int

要求每个适配器查找扩展

自	3.1

响应

array<string|int, InstallerExtension>

已发现的包安装方法

discover_install( eid = null) :

自	3.1

参数

eid: int扩展 ID

响应

bool如果成功，则为 True

比较两个“文件”条目以查找已删除的文件/文件夹

findDeletedFiles(mixed||string|int oldFiles, mixed||string|int newFiles) : mixed||string|int

自	3.1

参数

oldFiles: array<string|int, mixed>旧文件的 \SimpleXMLElement 对象数组
newFiles: array<string|int, mixed>新文件的 \SimpleXMLElement 对象数组

响应

array<string|int, mixed>包含 findDeletedFiles[files] 中已删除的文件和文件夹以及 findDeletedFiles[folders] 中的相应文件夹的数组

尝试找到包清单文件

findManifest() :

自	3.1

响应

bool成功则为 True，错误则为 False

生成清单缓存

generateManifestCache() :

自	3.1

响应

string序列化清单数据

返回对象的属性或属性未设置时的默认值。

get( property,  default = null) :

继承已弃用

自	1.7.0
请参阅	CMSObject::getProperties()
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的获取器函数

参数

property: string属性的名称。
default: mixed默认值。

响应

mixed属性的值。

返回一个适配器。

getAdapter( name, mixed||string|int options = []) : static|bool

继承

自	1.6

参数

name: string要返回的适配器名称
options: array<string|int, mixed>适配器选项

响应

static|bool类型为“name”的适配器或 false

获取可用安装适配器的列表。

getAdapters(mixed||string|int options = [], mixed||string|int custom = []) : string||string|int

自	3.4

参数

options: array<string|int, mixed>要注入到适配器中的选项数组
custom: array<string|int, mixed>自定义安装适配器的数组

响应

array<string|int, string>可用安装适配器的类名数组。

获取数据库连接器对象

getDbo() : \Joomla\Database\DatabaseDriver

继承

自	1.6

响应

DatabaseDriver数据库连接器对象

获取最新的错误消息。

getError( i = null,  toString = true) :

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除将被删除而不会被替换捕获抛出的异常，而不是使用 getError

参数

i: int选项错误索引。
toString: bool指示异常对象是否应返回其错误消息。

响应

string错误消息

返回所有错误（如果有）。

getErrors() : mixed||string|int

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除将被删除而不会被替换捕获抛出的异常，而不是使用 getErrors

响应

array<string|int, mixed>错误消息数组。

返回全局安装程序对象，仅在该对象不存在时才创建它。

getInstance( basepath = __DIR__,  classprefix = 'JoomlaCMSInstallerAdapter',  adapterfolder = 'Adapter') : \Joomla\CMS\Installer\Installer

静态

自	3.1

参数

basepath: string适配器的基本路径
classprefix: string适配器的类前缀
adapterfolder: string要附加到基本路径的文件夹名称

响应

Installer安装程序对象

获取安装清单对象

getManifest() : \SimpleXMLElement

自	3.1

响应

SimpleXMLElement清单对象

解析扩展参数、构建其默认参数的 JSON 字符串并返回 JSON 字符串的方法。

getParams() :

自	3.1
注意	此方法必须始终返回符合 JSON 规范的字符串

响应

string参数值的 JSON 字符串

按名称获取安装程序路径

getPath( name,  default = null) :

自	3.1

参数

name: string路径名称
default: string默认值

响应

string路径

返回对象属性的关联数组。

getProperties( public = true) : mixed||string|int

继承已弃用

自	1.7.0
请参阅	CMSObject::get()
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的获取器函数

参数

公共: bool如果为 true，则仅返回公共属性。

响应

array<string|int, mixed>

获取重定向位置

getRedirectUrl() :

自	3.1

响应

string重定向位置（或 null）

包安装方法

install( path = null) :

自	3.1

参数

path: string指向包源文件夹的路径

响应

bool如果成功，则为 True

XML 文件是否为有效的 Joomla 安装清单文件。

isManifest( file) : \SimpleXMLElement|null

自	3.1

参数

file: string要检查的 xmlfile 路径

响应

SimpleXMLElement|null\SimpleXMLElement 或 null（如果文件解析失败）

获取允许覆盖开关

isOverwrite() :

自	3.1

响应

bool允许覆盖开关

获取此安装程序是否正在卸载作为包一部分的扩展

isPackageUninstall() :

自	3.7.0

响应

bool

获取升级开关

isUpgrade() :

自	3.1

响应

bool

加载适配器实例的方法

loadAdapter( adapter, mixed||string|int options = []) : \Joomla\CMS\Installer\InstallerAdapter

自	3.4
抛出	`InvalidArgumentException`

参数

adapter: string适配器名称
options: array<string|int, mixed>适配器选项

响应

InstallerAdapter

加载所有适配器。

loadAllAdapters(mixed||string|int options = []) :

继承

自	1.6

参数

options: array<string|int, mixed>适配器选项

响应

void

将 MD5SUMS 文件加载到关联数组中

loadMD5Sum( filename) : mixed||string|int

自	3.1

参数

filename: string要加载的文件名

响应

array<string|int, mixed>包含文件名作为索引以及 MD5 作为值的关联数组

解析安装清单的 files 元素并采取适当操作的方法。

parseFiles(\SimpleXMLElement element,  cid, mixed||string|int oldFiles = null, mixed||string|int oldMD5 = null) :

自	3.1

参数

element: SimpleXMLElement要处理的 XML 节点
cid: int要安装到的应用程序的应用程序 ID
oldFiles: array<string|int, mixed>旧文件的列表（SimpleXMLElement）
oldMD5: array<string|int, mixed>旧 MD5 校验和列表（按文件名索引，值为 MD5）

响应

bool成功则为 True

解析安装清单的 languages 元素并采取适当操作的方法。

parseLanguages(\SimpleXMLElement element,  cid) :

自	3.1

参数

element: SimpleXMLElement要处理的 XML 节点
cid: int要安装到的应用程序的应用程序 ID

响应

bool成功则为 True

解析安装清单的 media 元素并采取适当操作的方法。

parseMedia(\SimpleXMLElement element,  cid) :

自	3.1

参数

element: SimpleXMLElement要处理的 XML 节点
cid: int要安装到的应用程序的应用程序 ID

响应

bool成功则为 True

向后兼容的方法，用于解析安装清单文件的 queries 元素并采取适当操作。

parseQueries(\SimpleXMLElement element) :

自	3.1

参数

element: SimpleXMLElement要处理的 XML 节点

响应

mixed已处理的查询数或错误时的 False

处理项更新的方法

parseSchemaUpdates(\SimpleXMLElement schema,  eid) : bool|int

自	3.1

参数

schema: SimpleXMLElement要处理的 XML 节点
eid: int扩展标识符

响应

bool|int已执行的 SQL 更新数；失败则为 false。

从安装清单文件中提取独立安装 sql 文件名称的方法。

parseSQLFiles( element) :

自	3.1

参数

element: object要处理的 XML 节点

响应

mixed已处理的查询数或错误时的 False

解析 XML 安装清单文件。

parseXMLInstallFile( path) : mixed||string|int

静态

XML 根标签应为“install”，但语言使用元文件除外。

自	3.0.0

参数

path: string指向 XML 文件的完整路径。

响应

array<string|int, mixed>XML 元数据。

将步骤推送到安装程序堆栈以回滚步骤

pushStep(mixed||string|int step) :

自	3.1

参数

step: array<string|int, mixed>安装程序步骤

响应

void

刷新存储在 #__extensions 中的清单缓存

refreshManifestCache( eid) :

自	3.1

参数

eid: int扩展 ID

响应

bool

解析安装清单的 files 元素并删除已安装的文件的方法

removeFiles( element,  cid) :

自	3.1

参数

element: object要处理的 XML 节点
cid: int要从中删除的应用程序的应用程序 ID

响应

bool成功则为 True

修改对象的属性（如果该属性不存在，则创建该属性）。

set( property,  value = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的设置器函数

参数

property: string属性的名称。
value: mixed要设置的属性的值。

响应

mixed属性的先前值。

按名称设置适配器

setAdapter( name,  &adapter = null, mixed||string|int options = []) :

继承

自	1.6

参数

name: string适配器名称
adapter: object适配器对象
options: array<string|int, mixed>适配器选项

响应

bool如果成功，则为 True

添加错误消息。

setError( error) :

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除将被删除而不会被替换抛出异常，而不是使用 setError

参数

error: string错误消息。

响应

void

设置允许覆盖开关

setOverwrite( state = false) :

自	3.1

参数

state: bool覆盖开关状态

响应

bool如果设置了状态，则为 True，否则为 False

设置此安装程序是否正在卸载作为包一部分的扩展

setPackageUninstall( uninstall) :

自	3.7.0

参数

uninstall: bool如果包触发了卸载，则为真，否则为假

响应

void

按名称设置安装程序路径

setPath( name,  value) :

自	3.1

参数

name: string路径名称
value: string路径

响应

void

根据命名数组/哈希设置对象属性。

setProperties( properties) :

继承已弃用

自	1.7.0
请参阅	CMSObject::set()
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的设置器函数

参数

属性: mixed关联数组或其他对象。

响应

bool

设置重定向位置

setRedirectUrl( newurl) :

自	3.1

参数

newurl: string新的重定向位置

响应

void

通过查看扩展的最新更新来设置扩展的模式版本

setSchemaVersion(\SimpleXMLElement schema,  eid) :

自	3.1

参数

schema: SimpleXMLElement模式标签
eid: int扩展 ID

响应

void

设置升级开关

setUpgrade( state = false) :

自	3.1

参数

state: bool升级开关状态

响应

bool如果升级为真，否则为假

准备安装：此方法设置安装目录，查找并检查安装文件，并验证安装类型。

setupInstall( route = 'install',  returnAdapter = false) : bool|\Joomla\CMS\Installer\InstallerAdapter

自	3.1

参数

路线: string正在遵循的安装路线
returnAdapter: bool返回实例化适配器的标志

响应

bool|InstallerAdapter如果明确请求，则为 InstallerAdapter 对象，否则为布尔值

将多个查询的字符串拆分为单个查询的数组。

splitSql(string|null sql) : mixed||string|int

静态

这与 DatabaseDriver::splitSql 不同。它支持特殊的 CAN FAIL 注释标记，该标记指示 SQL 语句可能会在安装期间失败，而不会引发错误。

自	4.2.0

参数

sql: string|null要拆分为单个查询的输入 SQL 字符串。

响应

array<string|int, mixed>

包卸载方法

uninstall( type,  identifier) :

自	3.1

参数

type: string包类型
标识符: mixed适配器的包标识符

响应

bool如果成功，则为 True

包更新方法

update( path = null) :

自	3.1

参数

path: string指向包源文件夹的路径

响应

bool如果成功，则为 True

使用最新版本更新模式表

updateSchemaTable( eid,  version,  update = false) :

自	4.2.0

参数

eid: int扩展 ID。
版本: string最新的模式版本 ID。
update: bool我应该对现有记录运行更新还是插入新记录？

响应

void

注释标记，指示更新 SQL 查询可能会失败而不会触发更新错误。

价值	'/ CAN FAIL /'
自	4.2.0

CAN_FAIL_MARKER 字符串的长度

价值	16
自	4.2.0

错误消息或异常对象的数组。

继承已弃用

自	1.7.0
已弃用	3.1.4 JError 已弃用

类型

array<string|int, mixed>

适配器的关联数组

继承

自	1.6

类型

array<string|int, static>

适配器文件夹

继承

自	1.6

类型

string

适配器类前缀

继承

自	1.6

类型

string

适配器实例的基路径

继承

自	1.6

类型

string

数据库连接器对象

继承

自	1.6

类型

DatabaseDriver

安装程序所需的路径数组

自	3.1

类型

array<string|int, mixed>

如果包是升级，则为真

自	3.1

类型

bool

清单触发器类

自	3.1

类型

object

如果可以覆盖现有文件，则为真

自	3.0.0

类型

bool

安装步骤堆栈

用于安装回滚

自	3.1

类型

array<string|int, mixed>

扩展表条目

自	3.1

类型

扩展

安装/卸载脚本的输出

自	3.1

类型

string

安装清单 XML 对象

自	3.1

类型

object

显示的扩展消息

自	3.1

类型

string

如果此扩展的重定向 URL（如果无重定向，则可以为空）

自	3.1

类型

string

卸载过程是否由卸载包触发

自	3.7.0

类型

bool

在更新站点重建期间备份 extra_query

自	3.9.26

类型

string

JInstaller 实例容器。

静态

自	3.4

类型

array<string|int, Installer>