CollectionAdapter
扩展 UpdateAdapter集合更新适配器类
| 自 |
1.7.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数
__construct(\Joomla\CMS\Adapter\Adapter parent, \Joomla\Database\DatabaseDriver db, mixed||string|int options = []) :
_endElement
关闭 XML 元素 注意：这是一个受保护的函数，但必须在外部公开作为回调
_endElement( parser, name) :
| 自 |
1.7.0 |
|---|
参数
- 解析器
object解析器对象- 名称
string正在关闭的元素的名称
响应
空
_getLastTag
获取对最后一个标签的引用
_getLastTag() :
| 自 |
1.7.0 |
|---|
响应
对象
_getParent
获取父标签
_getParent() :
| 自 |
1.7.0 |
|---|
响应
string父级
_getStackLocation
获取对当前直接父级的引用
_getStackLocation() :
| 自 |
1.7.0 |
|---|
响应
字符串
_startElement
打开 XML 元素
_startElement( parser, name, mixed||string|int attrs = []) :
| 自 |
1.7.0 |
|---|
参数
- 解析器
object解析器对象- 名称
string打开的元素的名称- 属性
array<string|int, mixed>元素的属性数组
响应
空
def
如果尚未分配，则设置默认值
def( property, default = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中删除 不应再使用定义动态属性 |
参数
- 属性
string属性的名称。- 默认
mixed默认值。
响应
混合
findUpdate
查找更新
findUpdate(mixed||string|int options) : array|bool
| 自 |
1.7.0 |
|---|
参数
- options
array<string|int, mixed>要使用的选项：update_site_id：要查看的更新网站的唯一 ID
响应
array<string|int, mixed>|bool发现的更新网站和更新。失败时为 false
get
返回对象的属性或未设置属性时的默认值。
get( property, default = null) :
| 自 |
1.7.0 |
|---|---|
| 查看 | CMSObject::getProperties() |
| 已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 getter 函数 |
参数
- 属性
string属性的名称。- 默认
mixed默认值。
响应
mixed属性的值。
getError
获取最新的错误消息。
getError( i = null, toString = true) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中删除 将不带替换地删除 捕获抛出的异常而不是 getError |
参数
- i
int可选错误索引。- toString
bool指示 Exception 对象是否应返回其错误消息。
响应
string错误消息
getErrors
返回所有错误（如果有）。
getErrors() : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中删除 将不带替换地删除 捕获抛出的异常而不是 getErrors |
响应
array<string|int, mixed>错误消息数组。
getProperties
返回对象属性的关联数组。
getProperties( public = true) : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 查看 | CMSObject::get() |
| 已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 getter 函数 |
参数
- 公共
bool如果为 true，则仅返回公共属性。
响应
array<string|int, mixed>
getUpdateSiteName
获取更新网站的名称。这用于记录。
getUpdateSiteName( updateSiteId) :
参数
- updateSiteId
int更新网站的数字 ID
响应
string更新网站的名称，如果未找到，则为空字符串
getUpdateSiteResponse
尝试从更新网站获取原始 HTTP 响应，希望包含更新 XML。
getUpdateSiteResponse(mixed||string|int options = []) : \Joomla\CMS\Http\Response|bool
| 抛出 |
|
|---|
参数
- options
array<string|int, mixed>更新选项，请参阅子类中的 findUpdate()
响应
Response|bool如果我们无法连接到站点，则为 false，否则为 HTTP 响应对象
set
修改对象的属性，如果属性不存在，则创建该属性。
set( property, value = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数 |
参数
- 属性
string属性的名称。- 价值
mixed要设置的属性的值。
响应
mixed属性的先前值。
setError
添加错误消息。
setError( error) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中删除 将不带替换地删除 抛出异常而不是使用 setError |
参数
- 错误
string错误消息。
响应
空
setProperties
根据命名数组/哈希设置对象属性。
setProperties( properties) :
| 自 |
1.7.0 |
|---|---|
| 查看 | CMSObject::set() |
| 已弃用 |
4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数 |
参数
- 属性
mixed关联数组或其他对象。
响应
布尔值
toggleUpdateSite
切换更新网站的启用状态。更新网站在从其 URL 获取更新信息之前被禁用，并在之后启用。如果 URL 获取因 PHP 致命错误（例如超时）而失败，则有故障的更新网站在下一次尝试加载更新信息时将保持禁用状态。
toggleUpdateSite( updateSiteId, enabled = true) :
参数
- updateSiteId
int要启用/禁用的更新网站的数字 ID- 已启用
bool为 true 时启用网站，为 false 时禁用网站
响应
空
属性
_errors
错误消息或 Exception 对象的数组。
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 JError 已弃用 |
类型
array<string|int, mixed>
父级
对象树
| 自 |
1.7.0 |
|---|
类型
array<string|int, mixed>
db
数据库
| 自 |
1.6 |
|---|
类型
DatabaseDriver
xmlParser
XML 解析器的资源句柄
| 自 |
3.0.0 |
|---|
类型
XMLParser
堆栈
元素调用堆栈
| 自 |
3.0.0 |
|---|
类型
array<string|int, mixed>
updateSiteId
更新网站的 ID
| 自 |
3.0.0 |
|---|
类型
整数
updatecols
要更新的扩展表中的列
| 自 |
3.0.0 |
|---|
类型
array<string|int, mixed>
appendExtension
我们是否应该尝试将 .xml 扩展名追加到更新网站的 URL？
类型
布尔值
updateSiteName
更新网站的名称（用于记录）
类型
字符串
_url
我们将从中获取更新信息的更新网站 URL
类型
字符串
minimum_stability
更新需要考虑的最低稳定性。可能的取值是：0 dev 开发快照、夜间构建、预发布版本等 1 alpha Alpha 版本（正在开发中，很可能存在问题） 2 beta Beta 版本（主要功能已到位，很可能存在阻止程序运行的错误） 3 rc 发布候选版本（几乎稳定，可能存在轻微错误） 4 stable 稳定版本（生产级代码）
基地
树的根
| 自 |
1.7.0 |
|---|
类型
对象
pop_parent
用于控制项目是否有子项
| 自 |
1.7.0 |
|---|
类型
整数
update_sites
发现的更新网站列表
类型
array<string|int, mixed>
更新
发现的更新列表
类型
array<string|int, mixed>