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

构造函数

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

自	1.5

参数

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 对象。
id: int要查找的 ID

响应

int

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

_getAssetTitle() :

继承

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

自	1.7.0

响应

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

获取树中节点的嵌套集属性的方法。

_getNode( id,  key = null) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

id: int要查找节点的值。
键: string一个可选的键，用于查找节点（父级 | 左 | 右）。如果省略，则使用表的 primary key。

响应

mixed失败时为布尔值 false，成功时为节点对象。

获取在某个位置为节点及其子节点腾出空间所需的各种数据的方法。返回的数据对象包括用于更新左右 ID 值以腾出节点空间的 SQL WHERE 子句条件，以及节点的新左右 ID。

_getTreeRepositionData( referenceNode,  nodeWidth,  position = 'before') :

继承

自	1.7.0

参数

参考节点: object一个节点对象，至少包含“lft”和“rgt”，用于在树周围为新节点腾出空间。
节点宽度: int要在树中腾出空间的节点宽度。
位置: string相对于参考节点的位置，应在该位置腾出空间。

响应

mixed失败时为布尔值 false，成功时为数据对象。

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

_lock() :

继承

自	1.7.0
抛出	`RuntimeException`

响应

bool成功时为 True。

在缓冲区中创建日志表的方法，可以选择显示查询和/或数据。

_logtable( showData = true,  showQuery = true) :

继承

自	1.7.0

参数

显示数据: boolTrue 表示显示数据
显示查询: boolTrue 表示显示查询

响应

无效

运行查询并在出错时解锁数据库。

_runQuery( query,  errorMessage) :

继承

注意	自 3.0.0 起，此方法返回 void 并重新抛出数据库异常。
自	1.7.0
抛出	`Exception`数据库错误。

参数

查询: mixed字符串或 DatabaseQuery 对象。
错误消息: string未使用。

响应

无效

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

_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 类的文件系统路径数组。

将此表的 primary key 附加到查询的方法。

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

继承

自	3.1.4

参数

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

响应

无效

重载的 bind 函数

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

参见	Table::bind()
自	1.5

参数

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

响应

mixed如果操作成功，则为 Null，否则返回错误

重载的 check 函数

check() :

参见	Table::check()
自	1.5

响应

bool成功时为 True

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

checkIn( pk = null) :

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

pk: mixed一个可选 primary key 值，用于签出。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

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

checkOut( userId,  pk = null) :

继承

为了防止在编辑数据库中的行时出现竞争条件，如果字段“checked_out”和“checked_out_time”可用，则可以签出行。当一行被签出时，任何用户（除了签出行的人之外）尝试存储该行的尝试都应保持挂起，直到该行再次签入。

自	1.7.0
抛出	`UnexpectedValueException`

参数

用户ID: int签出行用户的 ID。
pk: mixed一个可选 primary key 值，用于签出。如果未设置，则使用实例属性值。

响应

bool成功时为 True。

打开或关闭调试级别

debug( level) :

继承

自	1.7.0

参数

级别: int0 = 关闭，1 = 打开

响应

无效

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

def( property,  default = null) :

继承已弃用

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

参数

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

响应

混合

删除节点并选择性地删除其子节点的方法。

delete( pk = null,  children = true) :

继承

自	1.7.0

参数

pk: int要删除的节点的 primary key。
孩子: boolTrue 表示删除子节点，False 表示将它们上移一级。

响应

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。

返回此记录的标识（primary key）值

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

参数

类型

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`

参数

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

响应

int下一个排序值。

获取从给定节点到其根节点的所有节点数组的方法。

getPath( pk = null,  diagnostic = false) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误

参数

pk: int要获取路径的节点的主键。
诊断: bool仅为嵌套集选择诊断数据。

响应

mixed包含起始节点的节点对象数组。

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

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>

获取树中根项目的 ID

getRootId() :

继承

自	1.7.0

响应

mixed根行的主键 ID，如果未找到且内部错误已设置，则为 false。

获取记录规则的方法。

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

继承

自	1.7.0

响应

Rules对象

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

getTableName() :

继承

自	1.7.0

响应

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

获取节点及其所有子节点的方法。

getTree( pk = null,  diagnostic = false) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

pk: int要获取树的节点的主键。
诊断: bool仅为嵌套集选择诊断数据。

响应

mixed失败时返回布尔值 false，成功时返回节点对象数组。

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

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

参数

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

响应

bool如果已签出，则返回 true。

确定节点是否为树中的叶子节点（没有子节点）的方法。

isLeaf( pk = null) :

继承

注意	从 3.0.0 开始，如果节点不存在，此方法将返回 null。
自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

pk: int要检查的节点的主键。

响应

bool如果为叶子节点，则返回 true；如果不是，则返回 false；如果节点不存在，则返回 null。

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

load( keys = null,  reset = true) :

继承

自

1.7.0

抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

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

响应

bool如果成功，则返回 true。如果未找到行，则返回 false。

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

move( delta,  where = '') :

继承

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

自	1.7.0

参数

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

响应

mixed成功时返回布尔值 true。

将节点及其子节点移动到树中新位置的方法。

moveByReference( referenceId,  position = 'after',  pk = null,  recursiveUpdate = true) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

referenceId: int要通过其引用新位置的节点的主键。
位置: string位置类型字符串。['before', 'after', 'first-child', 'last-child']
pk: int要移动的节点的主键。
recursiveUpdate: bool标志指示是否应调用方法 recursiveUpdatePublishedColumn。

响应

bool成功时为 True。

将节点在同一级别向右移动一个位置的方法。

orderDown( pk) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

pk: int要移动的节点的主键。

响应

bool成功时为 True。

将节点在同一级别向左移动一个位置的方法。

orderUp( pk) :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

pk: int要移动的节点的主键。

响应

bool成功时为 True。

设置数据库表中节点或节点列表的发布状态的方法。该方法会尊重其他用户签出的行，并在调整后尝试签入其可以签入的行。该方法不允许您将发布状态设置为高于任何祖先节点的状态，也不允许您在具有已签出子节点的节点上设置发布状态。

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

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

bool成功时为 True。

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

rebuild( parentId = null,  leftId,  level,  path = '') :

继承

自	1.7.0
抛出	`RuntimeException`数据库错误。

参数

parentId: int要重建的树的根。
leftId: int构建树时要开始的左 ID。
级别: int要分配给当前节点的级别。
路径: string当前节点的路径。

响应

int成功时为 1 + 根 rgt 值，失败时为 false

从当前节点到树的根节点的节点的别名值重建节点路径字段的方法。

rebuildPath( pk = null) :

继承

自	1.7.0

参数

pk: int要获取路径的节点的主键。

响应

bool成功时为 True。

递归更新子行发布列的方法。

recursiveUpdatePublishedColumn( pk,  newState = null) :

继承

自	3.7.0
抛出	`RuntimeException`数据库错误。

参数

pk: int已更改发布列的行号。
newState: int由 $pk 标识的行发布列的可选值。

响应

bool成功时为 True。

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

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

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

mixed成功时返回布尔值 True。

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

reset() :

继承

自	3.2.1

响应

无效

提供将 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。

更新表行顺序的方法

saveorder(mixed||string|int idArray = null, mixed||string|int lftArray = null) : int|bool

继承

自	1.7.0
抛出	`Exception`数据库错误。

参数

idArray: array<string|int, mixed>要重新排序的行号。
lftArray: array<string|int, mixed>要重新排序行的 lft 值。

响应

int|bool成功时为 1 + 根 rgt 值，失败时为 false。

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

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）

响应

无效

设置 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错误消息。

响应

无效

设置树对象中节点位置的方法。此方法不会将新位置保存到数据库，但会将其设置在对象中，以便在存储节点时将其存储在新位置。

setLocation( referenceId,  position = 'after') :

继承

注意	从 3.0.0 开始，此方法返回 void，并在传递无效位置时抛出 \InvalidArgumentException。
参见	Nested::$_validLocations
自	1.7.0
抛出	`InvalidArgumentException`

参数

referenceId: int要通过其引用新位置的节点的主键。
位置: string位置类型字符串。

响应

无效

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

setProperties( properties) :

继承已弃用

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

参数

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

响应

bool

设置记录规则的方法。

setRules( input) :

继承

自	1.7.0

参数

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

响应

无效

重载的 store 函数

store( updateNulls = true) :

参见	Table::store()
自	1.6

参数

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

响应

mixed失败时为 false，成功时为正整数。

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

继承已弃用

自	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

类型

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 值

自	4.0.0

类型

bool

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

继承

自	4.0.0

类型

字符串

保存父节点主键的对象属性。为节点提供邻接列表数据。

继承

自	1.7.0

类型

int

保存节点在树中的深度级别的对象属性。

继承

自	1.7.0

类型

int

保存节点的左值，用于管理其在嵌套集树中的位置的对象属性。

继承

自	1.7.0

类型

int

保存节点的右值，用于管理其在嵌套集树中的位置的对象属性。

继承

自	1.7.0

类型

int

保存此节点的别名，用于构建完整文本路径（以正斜杠分隔）的对象属性。

继承

自	1.7.0

类型

字符串

保存存储行时要使用的位置类型的对象属性。

继承

自	1.7.0
参见	Nested::$_validLocations

类型

字符串

保存存储行时要使用的位置引用节点主键的对象属性。

继承

位置类型和引用节点的组合描述了在树中存储当前节点的位置。

自	1.7.0

类型

int

用于在递归过程中缓存值的数组。

继承

自	1.7.0

类型

array<string|int, mixed>

调试级别

继承

自	1.7.0

类型

int

根 ID 缓存

继承静态

自	3.3

类型

int

声明用于移动节点的有效位置值的数组

继承

自	3.7.0

类型

array<string|int, mixed>