Joomla! CMS 5.1.x API » \Joomla\CMS\Table\Ucm

构造函数

__construct(\Joomla\Database\DatabaseDriver db, \Joomla\Event\DispatcherInterface dispatcher = null) :

自	3.1

参数

db: DatabaseDriver数据库连接器对象
dispatcher: DispatcherInterface|null此表的事件调度程序

响应

混合

计算资源默认名称的方法。

_getAssetName() :

继承

默认名称格式为 table_name.id，其中 id 是表主键的值。

自	1.7.0

响应

字符串

获取要在其中注册此资源的父资源的方法。

_getAssetParentId(\Joomla\CMS\Table\Table table = null,  id = null) :

继承

默认情况下，所有资源都注册到具有 ID 的 ROOT 节点，如果不存在，则默认为 1。扩展类可以定义要查找的表和 ID。如果资源不存在，它将被创建。

自	1.7.0

参数

table: Table资源父项的 Table 对象。
id: int要查找的 ID

响应

int

返回用于资源表标题的方法。

_getAssetTitle() :

继承

在跟踪资源时，为每个资源保留一个标题，以便在统一访问管理器中提供一些上下文。通常这会简单地返回 $this->title 或 $this->name 或用于行主名称的任何内容。如果未重写此方法，则使用资源名称。

自	1.7.0

响应

string在资源表中用作标题的字符串。

锁定数据库表以进行写入的方法。

_lock() :

继承

自	1.7.0
抛出	`RuntimeException`

响应

bool成功时为 True。

解锁数据库表以进行写入的方法。

_unlock() :

继承

自	1.7.0

响应

bool成功时为 True。

添加 Table 应在其中搜索表类文件的系统路径。

addIncludePath(array|string path = null) : mixed||string|int

继承静态弃用

自	1.7.0
弃用	4.3 将在 6.0 中删除应不再使用，因为表是通过 MvcFactory 加载的

参数

path: array<string|int, mixed>|string要添加的系统路径或系统路径数组。

响应

array<string|int, mixed>用于在其中查找 Table 类的系统路径数组。

将此表的主键附加到查询的方法。

appendPrimaryKeys(\Joomla\Database\DatabaseQuery query,  pk = null) :

继承

自	3.1.4

参数

query: DatabaseQuery要附加的查询对象。
pk: mixed可选主键参数。

响应

void

将关联数组或对象绑定到 Table 实例的方法。此方法仅绑定公开可访问的属性，并可选地采用要忽略的属性数组，这些属性在绑定时要忽略。

bind(array|object src, array|string ignore = []) :

继承

自	1.7.0
抛出	`InvalidArgumentException`

参数

src: array<string|int, mixed>|object要绑定到 Table 实例的关联数组或对象。
ignore: array<string|int, mixed>|string要忽略的属性的可选数组或空格分隔列表，在绑定时要忽略。

响应

bool成功时为 True。

对 Table 实例属性执行完整性检查的方法，以确保它们可以安全地存储在数据库中。

check() :

继承

子类应重写此方法，以确保在存储之前，它们存储在数据库中的数据是安全的，并且符合预期。

自	1.7.0

响应

bool如果实例是安全的，并且能够存储在数据库中，则为 True。

检查如果存在必要的属性/字段，则将行检入的方法。

checkIn( pk = null) :

继承

检查行检入将允许其他用户编辑该行。

自	1.7.0
抛出	`UnexpectedValueException`

参数

pk: mixed要检出的可选主键值。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

检查如果存在必要的属性/字段，则将行检出的方法。

checkOut( userId,  pk = null) :

继承

为了在编辑数据库中的行时防止竞争条件，如果字段 'checked_out' 和 'checked_out_time' 可用，则可以检出该行。当行被检出时，任何用户尝试存储行（而不是检出该行的用户）的尝试都应被保留，直到该行再次被检入。

自	1.7.0
抛出	`UnexpectedValueException`

参数

userId: int检出该行的用户 ID。
pk: mixed要检出的可选主键值。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

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

def( property,  default = null) :

继承弃用

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

参数

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

响应

混合

从数据库表中通过主键值删除行的方法。

delete( pk = null) :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

pk: mixed要删除的可选主键值。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

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

get( property,  default = null) :

继承弃用

自	1.7.0
参见	CMSObject::getProperties()
弃用	4.3.0 将在 6.0 中删除为属性创建适当的 getter 函数

参数

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

响应

mixed属性的值。

返回“特殊”列（例如排序、点击次数、发布等）的真实名称的方法。通过这种方式，您可以自由地遵循您的数据库命名约定，并使用内置的 \Joomla 函数。

getColumnAlias( column) :

继承

自	3.4

参数

column: string“特殊”列的名称（例如排序、点击次数）

响应

string标识特殊的字符串

获取 DatabaseDriver 对象的方法。

getDbo() : \Joomla\Database\DatabaseDriver

继承

自	1.7.0

响应

DatabaseDriver内部数据库驱动程序对象。

获取最新的错误消息。

getError( i = null,  toString = true) :

继承弃用

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

参数

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

响应

string错误消息

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

getErrors() : mixed||string|int

继承弃用

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

响应

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

从数据库表中获取列。

getFields( reload = false) :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

reload: bool重新加载缓存的标志

响应

mixed字段名称数组，如果发生错误，则为 false。

返回此记录的标识（主键）值

getId() :

继承

自	4.0.0

响应

混合

静态方法，用于在表包含路径中找到时获取 Table 类的实例。

getInstance( type,  prefix = 'JTable', mixed||string|int config = []) : \Joomla\CMS\Table\Table|bool

继承静态弃用

要添加用于搜索 Table 类的包含路径，请参见 Table::addIncludePath()。

自	1.7.0
弃用	4.3 将在 6.0 中删除使用 MvcFactory 代替示例：Factory::getApplication()->bootComponent('...')->getMVCFactory()->createTable($name, $prefix, $config);

参数

type: string要获取实例的 Table 类的类型（名称）。
prefix: stringTable 类名的可选前缀。
config: array<string|int, mixed>Table 对象的可选配置值数组。

响应

Table|bool如果找到，则为 Table 对象，如果失败，则为布尔值 false。

获取表的主键字段名称的方法。

getKeyName( multiple = false) :

继承

自	1.7.0

参数

multiple: bool如果为 True，则返回所有主键（作为数组），如果为 False，则仅返回第一个主键（作为字符串）。

响应

mixed主键字段名称数组或包含第一个主键字段的字符串。

获取由 SQL WHERE 子句定义的一组行的下一个排序值的方法。

getNextOrder( where = '') :

继承

这对于将新项目放置在表中的一组项目的最后很有用。

自	1.7.0
抛出	`UnexpectedValueException`

参数

where: string用于选择表的 MAX(ordering) 的 WHERE 子句。

响应

int下一个排序值。

使用传递的值作为默认值获取此表的主键值。

getPrimaryKey(mixed||string|int keys = []) : mixed||string|int

继承

自	3.1.4

参数

keys: array<string|int, mixed>要使用的可选主键值。

响应

array<string|int, mixed>主键名称和值的数组。

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

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

继承弃用

自	1.7.0
参见	CMSObject::get()
弃用	4.3.0 将在 6.0 中删除为属性创建适当的 getter 函数

参数

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

响应

array<string|int, mixed>

获取记录规则的方法。

getRules() : \Joomla\CMS\Access\Rules

继承

自	1.7.0

响应

Rules对象

获取类数据库表名称的方法。

getTableName() :

继承

自	1.7.0

响应

string正在建模的数据库表名称。

检查记录是否具有属性（如果存在，则应用列别名）

hasField( key) :

继承

自	3.9.11

参数

key: string要检查的键

响应

bool

验证主键是否已设置。

hasPrimaryKey() :

继承

自	3.1.4

响应

bool如果主键已设置，则为 True。

如果存在必要的属性/字段，则增加行点击次数的方法。

hit( pk = null) :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

pk: mixed要增加的可选主键值。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

确定行是否被检出，因此用户无法编辑该行的方法。

isCheckedOut( with,  against = null) :

继承

如果该行被同一用户检出，则认为该行未被检出——因为用户仍然可以编辑该行。

自	1.7.0

参数

with: int要执行匹配的用户 ID，如果项目被此用户检出，则该函数将返回 false。
against: int当该函数用作静态函数时，要执行匹配的用户 ID。

响应

bool如果被检出，则为 True。

通过主键从数据库加载一行，并将字段绑定到 Table 实例属性。

load( keys = null,  reset = true) :

继承

自

1.7.0

抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

keys: mixed可选的主键值，用于加载行，或要匹配的字段数组。如果未设置，则使用实例属性值。
reset: bool在加载新行之前重置默认值的布尔值。

响应

bool如果成功则为 True。如果未找到行，则为 False。

方法是在由 SQL WHERE 子句定义的一组行的排序顺序中移动一行。

move( delta, string|string[] where = '') :

继承

负数将行向上移动，正数将行向下移动。

自	1.7.0
抛出	`UnexpectedValueException`

参数

delta: int在排序顺序中移动行的方向和幅度。
where: string|array<string|int, string>用于限制行选择以压缩排序值的 WHERE 子句。

响应

bool成功时为 True。

方法是设置数据库表中一行或多行的发布状态。

publish( pks = null,  state = 1,  userId) :

继承

该方法尊重其他用户签出的行，并在调整后尝试签入它可以签入的行。

自	1.7.0

参数

pks: mixed要更新的主键值数组（可选）。如果未设置，则使用实例属性值。
state: int发布状态。例如 [0 = 未发布，1 = 已发布]
userId: int执行操作的用户的用户 ID。

响应

bool成功时为 True；如果 $pks 为空，则为 False。

方法是压缩由 SQL WHERE 子句定义的一组行的排序值。

reorder(string|string[] where = '') :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

where: string|array<string|int, string>用于限制行选择以压缩排序值的 WHERE 子句。

响应

mixed成功时为布尔值 True。

方法是将类属性重置为类定义中设置的默认值。它将忽略主键以及任何私有类属性（除了 $_errors）。

reset() :

继承

自	1.7.0

响应

void

方法是提供将 Table 实例绑定、检查和存储到数据库表的快捷方式。

save(array|object src,  orderingFilter = '', array|string ignore = '') :

继承

该方法将在数据存储后检查一次行，如果存在排序过滤器，它将尝试根据过滤器重新排序表行。排序过滤器是实例属性名称。将重新排序的行是其值为 Table 实例中为指定属性指定的行的行。

自	1.7.0

参数

src: array<string|int, mixed>|object要绑定到 Table 实例的关联数组或对象。
orderingFilter: string用于排序更新的过滤器
ignore: array<string|int, mixed>|string要忽略的属性的可选数组或空格分隔列表，在绑定时要忽略。

响应

bool成功时为 True。

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

set( property,  value = null) :

继承弃用

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

参数

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

响应

mixed属性的先前值。

方法是为“特殊”列注册列别名。

setColumnAlias( column,  columnAlias) :

继承

自	3.4

参数

column: string“特殊”列（即排序）
columnAlias: string实际列名（即 foo_ordering）

响应

void

方法是设置 DatabaseDriver 对象。

setDbo(\Joomla\Database\DatabaseDriver db) :

继承

自	1.7.0

参数

db: DatabaseDriver要由表对象使用的 DatabaseDriver 对象。

响应

bool成功时为 True。

添加错误消息。

setError( error) :

继承弃用

自	1.7.0
弃用	3.1.4 将在 6.0 中删除将被删除，没有替代方案而是抛出异常，而不是使用 setError

参数

error: string错误消息。

响应

void

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

setProperties( properties) :

继承弃用

自	1.7.0
参见	CMSObject::set()
弃用	4.3.0 将在 6.0 中删除为属性创建适当的 setter 函数

参数

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

响应

bool

方法是设置记录的规则。

setRules( input) :

继承

自	1.7.0

参数

input: mixedRules 对象、JSON 字符串或数组。

响应

void

方法是将数据库中的表实例属性存储到一行中。

store( updateNulls = false) :

继承

如果设置了主键值，则将使用实例属性值更新具有该主键值的列。如果没有设置主键值，则将使用 Table 实例中的属性将新行插入数据库。

自	1.7.0

参数

updateNulls: bool如果为 True，则即使字段为 null 也会更新字段。

响应

bool成功时为 True。

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

继承弃用

自	1.7.0
弃用	3.1.4 JError 已弃用

类型

array<string|int, mixed>

用于搜索 Table 类别的包含路径。

inherited static

自	3.0.0

类型

array<string|int, mixed>

Table 字段缓存

inherited static

自	3.10.4

类型

array<string|int, mixed>

要建模的数据库表的名称。

继承

自	1.7.0

类型

字符串

表中主键字段的名称。

继承

自	1.7.0

类型

字符串

表中主键字段的名称。

继承

自	3.0.1

类型

array<string|int, mixed>

DatabaseDriver 对象。

继承

自	1.7.0

类型

DatabaseDriver

行是否应作为 ACL 资产跟踪？

继承

自	1.7.0

类型

bool

与该记录关联的规则。

继承

自	1.7.0

类型

Rules

指示表已被锁定的指标。

继承

自	1.7.0

类型

bool

指示主键自动递增。

继承

自	3.1.4

类型

bool

包含排序、点击次数等的“特殊”列的别名的数组

继承

自	3.4.0

类型

array<string|int, mixed>

要在 bind 函数中进行 json 编码的键名称数组

继承

自	3.3

类型

array<string|int, mixed>

指示列完全支持数据库中的 NULL 值

继承

自	3.10.0

类型

bool

UCM 类型别名。用于标签、内容版本控制等。保留为空将有效地禁用这些功能。

继承

自	4.0.0

类型

字符串