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

构造函数

__construct(\Joomla\Database\DatabaseDriver db) :

自	5.1.0

参数

db: DatabaseDriver数据库连接器对象

响应

混合

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

_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资产父级的表对象。
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

继承 static 已弃用

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

参数

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

响应

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

将此表的 primary keys 追加到查询中的方法。

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

继承

自	3.1.4

参数

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

响应

void

将关联数组或对象绑定到 Table 实例的方法。此方法仅绑定公开可访问的属性，并可以选择接受一个要忽略的属性数组，这些属性在绑定时不会被忽略。

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

继承

自	1.7.0
抛出	`InvalidArgumentException`

参数

src: array<string|int, mixed>|object要绑定到 Table 实例的关联数组或对象。
忽略: 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 中删除不应再使用定义动态属性

参数

属性: string属性的名称。
默认: 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 函数

参数

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

响应

mixed属性的值。

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

getColumnAlias( column) :

继承

自	3.4

参数

列: 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`

参数

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

响应

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

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

getId() :

继承

自	4.0.0

响应

混合

静态方法，如果可以在表包含路径中找到，则获取 Table 类的实例。

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

继承 static 已弃用

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

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

参数

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

响应

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

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

getKeyName( multiple = false) :

继承

自	1.7.0

参数

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

响应

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

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

getNextOrder( where = '') :

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

哪里: string用于选择表的 MAX(排序) 的 WHERE 子句。

响应

int下一个排序值。

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

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

继承

自	3.1.4

参数

键: 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 函数

参数

公共的: 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

参数

钥匙: string要检查的键

响应

布尔

验证主键是否已设置。

hasPrimaryKey() :

继承

自	3.1.4

响应

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

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

hit( pk = null) :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

pk: mixed可选的主键值以递增。如果没有设置，则使用实例属性值。

响应

bool成功时为 True。

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

isCheckedOut( with,  against = null) :

继承

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

自	1.7.0

参数

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

响应

bool如果检出，则为真。

用于通过主键从数据库加载行并将字段绑定到 Table 实例属性的方法。

load( keys = null,  reset = true) :

继承

自

1.7.0

抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

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

响应

bool如果成功，则为真。如果未找到行，则为假。

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

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

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

delta: int在排序顺序中移动行的方向和幅度。
哪里: 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成功时为真；如果 $pks 为空，则为假。

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

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

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

哪里: string|array<string|int, string>WHERE 子句，用于限制对行进行选择以压缩排序值。

响应

mixed成功时为布尔值真。

用于将类属性重置为类定义中设置的默认值的方法。它将忽略主键以及任何私有类属性（除了 $_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用于更新顺序的过滤器
忽略: array<string|int, mixed>|string一个可选的数组或以空格分隔的属性列表，这些属性在绑定时要忽略。

响应

bool成功时为 True。

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

set( property,  value = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除创建一个适当的 setter 函数来设置该属性

参数

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

响应

mixed属性的先前值。

用于为“特殊”列注册列别名的方法。

setColumnAlias( column,  columnAlias) :

继承

自	3.4

参数

列: 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关联数组或另一个对象。

响应

布尔

用于设置记录规则的方法。

setRules( input) :

继承

自	1.7.0

参数

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

响应

void

用于从 Table 实例属性将行存储到数据库的方法。

store( updateNulls = false) :

继承

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

自	1.7.0

参数

updateNulls: bool如果要更新字段，即使它们为 null，则为真。

响应

bool成功时为 True。

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

继承已弃用

自	1.7.0
已弃用	3.1.4 JError 已弃用

类型

array<string|int, mixed>

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

继承静态

自	3.0.0

类型

array<string|int, mixed>

表字段缓存

继承静态

自	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

类型

布尔

与该记录关联的规则。

继承

自	1.7.0

类型

规则

指示表是否已锁定。

继承

自	1.7.0

类型

布尔

指示主键是否自动递增。

继承

自	3.1.4

类型

布尔

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

继承

自	3.4.0

类型

array<string|int, mixed>

要使用 bind 函数进行 JSON 编码的键名称数组

继承

自	3.3

类型

array<string|int, mixed>

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

继承

自	3.10.0

类型

布尔

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

继承

自	4.0.0

类型

字符串