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

构造函数

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

自	1.7.0

参数

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

响应

混合

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

_getAssetName() :

继承

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

自	1.7.0

响应

字符串

获取要在此资产下注册的父资产的方法。

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

继承

默认情况下，所有资产都注册到根节点，其 ID 为，如果不存在则默认为 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

继承静态已弃用

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

参数

路径: array<string|int, mixed>|string要添加的目录路径或目录路径数组。

响应

array<string|int, mixed>查找 Table 类的目录路径数组。

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

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

继承

自	3.1.4

参数

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

响应

void

绑定用户、用户组以及任何其他必要数据的方法。

bind(mixed||string|int array,  ignore = '') :

自	1.7.0

参数

数组: array<string|int, mixed>要绑定的数据。
忽略: mixed要忽略的字段数组或以空格分隔的列表。

响应

bool成功时为 True，失败时为 False。

验证和过滤

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( userId = null) :

自	1.7.0

参数

userId: int可选用户 ID。

响应

bool成功时为 True，失败时为 False。

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

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`

参数

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

响应

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

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

getId() :

继承

自	4.0.0

响应

混合

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

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);

参数

类型: string要获取实例的 Table 类的类型（名称）。
前缀: string表类名称的可选前缀。
配置: 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(ordering) 的 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要检查的键

响应

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

参数

与: int要与之执行匹配的用户 ID，如果项目由该用户检出，则该函数将返回 false。
反对: int当该函数用作静态函数时，要与之进行匹配的用户 ID。

响应

bool如果已检出则为 True。

从数据库中加载用户、用户组以及任何其他必要数据，以便可以将其绑定到用户对象的方法。

load( userId = null,  reset = true) :

自	1.7.0

参数

userId: int可选用户 ID。
reset: bool如果行未找到或发生错误（在这种情况下，内部错误状态将被设置），则为 False。

响应

bool成功时为 True，失败时为 False。

用于移动由 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成功时为 True；如果 $pks 为空则为 False。

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

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

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

哪里: 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用于排序更新的过滤器
忽略: 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

更新用户的最后访问时间

setLastVisit( timeStamp = null,  userId = null) :

自	1.7.0

参数

timeStamp: int时间戳，默认为“现在”。
userId: int用户 ID（可选）。

响应

bool如果发生错误，则为 False

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

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

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

store( updateNulls = true) :

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

自	1.7.0

参数

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

响应

bool成功时为 True。

错误消息或 Exception 对象数组。

继承已弃用

自	1.7.0
已弃用	3.1.4 JError 已弃用

Type(s)

array<string|int, mixed>

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

inherited static

自	3.0.0

Type(s)

array<string|int, mixed>

Table 字段缓存

inherited static

自	3.10.4

Type(s)

array<string|int, mixed>

要建模的数据库表名称。

继承

自	1.7.0

Type(s)

字符串

表中主键字段的名称。

继承

自	1.7.0

Type(s)

字符串

表中主键字段的名称。

继承

自	3.0.1

Type(s)

array<string|int, mixed>

DatabaseDriver 对象。

继承

自	1.7.0

Type(s)

DatabaseDriver

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

继承

自	1.7.0

Type(s)

bool

与该记录关联的规则。

继承

自	1.7.0

Type(s)

Rules

指示表已被锁定的指标。

继承

自	1.7.0

Type(s)

bool

指示主键自动递增。

继承

自	3.1.4

Type(s)

bool

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

继承

自	3.4.0

Type(s)

array<string|int, mixed>

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

继承

自	3.3

Type(s)

array<string|int, mixed>

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

自	4.0.0

Type(s)

bool

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

继承

自	4.0.0

Type(s)

字符串

用户组 ID 的关联数组 => 组 ID

自	1.7.0

Type(s)

array<string|int, mixed>