Joomla! API

下载
启动

Usergroup

扩展自 Table

用户组表类。

自版本

1.7.0
包

Joomla CMS

方法

__construct

构造函数

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

1.7.0

参数

db

DatabaseDriver数据库连接器对象

dispatcher

DispatcherInterface|null此表的事件调度器

返回值

混合类型

_getAssetName

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

_getAssetName() :
继承

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

自版本

1.7.0

返回值

字符串

_getAssetParentId

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

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

默认情况下，所有资产都注册到 ID 为根节点，如果不存在则默认为 1。扩展类可以定义一个表和 ID 来查找。如果资产不存在，则会创建它。

自版本

1.7.0

参数

表

Table资产父级的 Table 对象。

id

int要查找的 ID

返回值

整数

_getAssetTitle

返回要在资产表中使用的标题的方法。

_getAssetTitle() :
继承

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

自版本

1.7.0

返回值

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

_lock

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

_lock() :
继承
自版本

1.7.0
抛出

RuntimeException

返回值

bool成功时返回 True。

_unlock

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

_unlock() :
继承
自版本

1.7.0

返回值

bool成功时返回 True。

addIncludePath

添加 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

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

appendPrimaryKeys(\Joomla\Database\DatabaseQuery query,  pk = null) :
继承
自版本

3.1.4

参数

查询

DatabaseQuery要附加的查询对象。

pk

mixed可选的主键参数。

返回值

空

bind

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

bind(array|object src, array|string ignore = []) :
继承
自版本

1.7.0
抛出

InvalidArgumentException

参数

源

array<string|int, mixed>|object要绑定到 Table 实例的关联数组或对象。

忽略

array<string|int, mixed>|string一个可选的数组或以空格分隔的属性列表，在绑定时忽略这些属性。

返回值

bool成功时返回 True。

check

检查要保存的当前记录的方法

check() :
自版本

1.7.0

返回值

bool成功时返回 True

checkIn

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

checkIn( pk = null) :
继承

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

自版本

1.7.0
抛出

UnexpectedValueException

参数

pk

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

返回值

bool成功时返回 True。

checkOut

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

checkOut( userId,  pk = null) :
继承

为了防止在编辑数据库中的行时出现竞争条件，如果字段“checked_out”和“checked_out_time”可用，则可以签出行。当一行被签出时，任何其他用户尝试存储该行的操作都应被阻止，直到该行再次签入。

自版本

1.7.0
抛出

UnexpectedValueException

参数

userId

int签出行的用户的 ID。

pk

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

返回值

bool成功时返回 True。

def

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

def( property,  default = null) :
继承 已弃用
自版本

1.7.0
已弃用

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

参数

属性

string属性的名称。

默认值

mixed默认值。

返回值

混合类型

delete

删除此对象及其依赖项

delete( oid = null) :
自版本

1.7.0
抛出

RuntimeException数据库错误时。

UnexpectedValueException数据错误时。

参数

oid

int要删除的用户组的主键。

返回值

mixed布尔值或异常。

get

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

get( property,  default = null) :
继承 已弃用
自版本

1.7.0
参见 CMSObject::getProperties()
已弃用

4.3.0 将在 6.0 中删除 为属性创建一个合适的 getter 函数

参数

属性

string属性的名称。

默认值

mixed默认值。

返回值

mixed属性的值。

getColumnAlias

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

getColumnAlias( column) :
继承
自版本

3.4

参数

列

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

返回值

string标识特殊的字符串

getDbo

获取 DatabaseDriver 对象的方法。

getDbo() : \Joomla\Database\DatabaseDriver
继承
自版本

1.7.0

返回值

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

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>错误消息数组。

getFields

获取数据库表中的列。

getFields( reload = false) :
继承
自版本

1.7.0
抛出

UnexpectedValueException

参数

重新加载

bool重新加载缓存的标志

返回值

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

getId

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

getId() :
继承
自版本

4.0.0

返回值

混合类型

getInstance

如果可以在表包含路径中找到 Table 类，则获取 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);

参数

类型

string要获取实例的 Table 类的类型（名称）。

前缀

stringTable 类名称的可选前缀。

配置

array<string|int, mixed>Table 对象的可选配置值数组。

返回值

Table|bool如果找到则返回 Table 对象，否则返回布尔值 false。

getKeyName

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

getKeyName( multiple = false) :
继承
自版本

1.7.0

参数

多个

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

返回值

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

getNextOrder

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

getNextOrder( where = '') :
继承

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

自版本

1.7.0
抛出

UnexpectedValueException

参数

where

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

返回值

int下一个排序值。

getPrimaryKey

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

getPrimaryKey(mixed||string|int keys = []) : mixed||string|int
继承
自版本

3.1.4

参数

键

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

返回值

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>

getRules

获取记录规则的方法。

getRules() : \Joomla\CMS\Access\Rules
继承
自版本

1.7.0

返回值

Rules对象

getTableName

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

getTableName() :
继承
自版本

1.7.0

返回值

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

hasField

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

hasField( key) :
继承
自版本

3.9.11

参数

键

string要检查的键

返回值

bool

hasPrimaryKey

验证是否已设置主键。

hasPrimaryKey() :
继承
自版本

3.1.4

返回值

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

hit

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

hit( pk = null) :
继承
自版本

1.7.0
抛出

UnexpectedValueException

参数

pk

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

返回值

bool成功时返回 True。

isCheckedOut

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

isCheckedOut( with,  against = null) :
继承

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

自版本

1.7.0

参数

与

int要执行匹配的用户 ID，如果项目由此用户签出，则函数将返回 false。

对比

int当函数用作静态函数时，执行匹配的用户 ID。

返回值

bool如果已签出，则为真。

load

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

load( keys = null,  reset = true) :
继承
自版本

1.7.0
抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

键

mixed可选的主键值，用于按其加载行，或要匹配的字段数组。如果未设置，则使用实例属性值。

reset

bool在加载新行之前重置默认值，则为真。

返回值

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

move

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

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

负数将行在序列中向上移动，正数将行向下移动。

自版本

1.7.0
抛出

UnexpectedValueException

参数

delta

int在排序序列中移动行的方向和幅度。

where

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

返回值

bool成功时返回 True。

publish

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

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

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

自版本

1.7.0

参数

pks

mixed要更新的主键值的可选数组。如果未设置，则使用实例属性值。

state

int发布状态。例如 [0 = 未发布，1 = 已发布]

userId

int执行操作的用户 ID。

返回值

bool成功时为真；如果 $pks 为空，则为假。

rebuild

递归重建嵌套集树的方法。

rebuild( parentId,  left) :
自版本

1.7.0

参数

parentId

int要重建的树的根。

left

int构建树时开始使用的左侧 ID。

返回值

bool成功时返回 True

reorder

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

reorder(string|string[] where = '') :
继承
自版本

1.7.0
抛出

UnexpectedValueException

参数

where

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

返回值

mixed布尔值，成功时为真。

reset

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

reset() :
继承
自版本

1.7.0

返回值

空

save

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

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

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

自版本

1.7.0

参数

源

array<string|int, mixed>|object要绑定到 Table 实例的关联数组或对象。

orderingFilter

string顺序更新的过滤器

忽略

array<string|int, mixed>|string一个可选的数组或以空格分隔的属性列表，在绑定时忽略这些属性。

返回值

bool成功时返回 True。

set

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

set( property,  value = null) :
继承 已弃用
自版本

1.7.0
已弃用

4.3.0 将在 6.0 中删除 创建属性的正确 setter 函数

参数

属性

string属性的名称。

value

mixed要设置的属性的值。

返回值

mixed属性的先前值。

setColumnAlias

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

setColumnAlias( column,  columnAlias) :
继承
自版本

3.4

参数

列

string“特殊”列（即排序）

columnAlias

string真实的列名（即 foo_ordering）

返回值

空

setDbo

设置 DatabaseDriver 对象的方法。

setDbo(\Joomla\Database\DatabaseDriver db) :
继承
自版本

1.7.0

参数

db

DatabaseDriver表对象要使用的 DatabaseDriver 对象。

返回值

bool成功时返回 True。

setError

添加错误消息。

setError( error) :
继承 已弃用
自版本

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将在不替换的情况下删除 抛出异常而不是使用 setError

参数

error

string错误消息。

返回值

空

setProperties

基于命名数组/哈希设置对象属性。

setProperties( properties) :
继承 已弃用
自版本

1.7.0
参见 CMSObject::set()
已弃用

4.3.0 将在 6.0 中删除 创建属性的正确 setter 函数

参数

properties

mixed关联数组或其他对象。

返回值

bool

setRules

设置记录规则的方法。

setRules( input) :
继承
自版本

1.7.0

参数

input

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

返回值

空

store

如果 id 为零，则插入新行，或者更新数据库表中的现有行

store( updateNulls = false) :
自版本

1.7.0

参数

updateNulls

bool如果为假，则不更新空对象变量

返回值

bool如果成功则为真，否则为假，并设置内部错误消息

属性

_errors

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

继承 已弃用
自版本

1.7.0
已弃用

3.1.4 JError 已弃用

类型

array<string|int, mixed>

_includePaths

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

继承 静态
自版本

3.0.0

类型

array<string|int, mixed>

tableFields

表字段缓存

继承 静态
自版本

3.10.4

类型

array<string|int, mixed>

_tbl

要建模的数据库表名称。

继承
自版本

1.7.0

类型

字符串

_tbl_key

表中主键字段的名称。

继承
自版本

1.7.0

类型

字符串

_tbl_keys

表中主键字段的名称。

继承
自版本

3.0.1

类型

array<string|int, mixed>

_db

DatabaseDriver 对象。

继承
自版本

1.7.0

类型

DatabaseDriver

_trackAssets

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

继承
自版本

1.7.0

类型

bool

_rules

与此记录关联的规则。

继承
自版本

1.7.0

类型

规则

_locked

表已被锁定的指示器。

继承
自版本

1.7.0

类型

bool

_autoincrement

指示主键是否自动递增。

继承
自版本

3.1.4

类型

bool

_columnAlias

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

继承
自版本

3.4.0

类型

array<string|int, mixed>

_jsonEncode

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

继承
自版本

3.3

类型

array<string|int, mixed>

_supportNullValue

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

继承
自版本

3.10.0

类型

bool

typeAlias

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

继承
自版本

4.0.0

类型

字符串
  • \ Joomla
  • \ CMS
  • \ Table
  • \ Usergroup