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

构造函数

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

自	1.6

参数

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

响应

混合

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

_getAssetName() :

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

自	3.6

响应

字符串

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

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

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

自	3.6

参数

表: Table资产父级的表对象。
id: int要查找的 ID

响应

int

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

_getAssetTitle() :

自	3.6

响应

字符串

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

_lock() :

继承

自	1.7.0
抛出	`RuntimeException`

响应

bool成功时为真。

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

_unlock() :

继承

自	1.7.0

响应

bool成功时为真。

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

将关联数组或对象绑定到 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成功时为真。

重载的检查函数

check() :

见	Table::check()
自	1.6

响应

bool成功时为真，失败时为假

检查行是否存在必要属性/字段的方法。

checkIn( pk = null) :

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

bool成功时为真。

检查行是否存在必要属性/字段的方法。

checkOut( userId,  pk = null) :

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

bool成功时为真。

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

def( property,  default = null) :

继承已弃用

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

参数

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

响应

混合

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

delete( pk = null) :

自	1.6

参数

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

响应

bool成功时为真。

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

get( property,  default = null) :

继承已弃用

自	1.7.0
见	CMSObject::getProperties()
已弃用	4.3.0 将在 6.0 中删除，为该属性创建一个合适的获取器函数

参数

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

响应

mixed属性的值。

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

getColumnAlias( column) :

继承

自	3.4

参数

专栏: string“特殊”列的名称（即排序、点击次数）

响应

string标识特殊的字符串

返回当前用户，如果未设置任何用户，则返回全局应用程序的标识。这将在 6.0 中更改，并将返回一个空用户。

getCurrentUser() : \Joomla\CMS\User\User

继承

自	4.2.0

响应

用户

获取 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字段名称数组，如果发生错误则为假。

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

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 对象，如果失败则为布尔值假。

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

getKeyName( multiple = false) :

继承

自	1.7.0

参数

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

响应

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 中删除，为该属性创建一个合适的获取器函数

参数

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

响应

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如果已设置主键，则为真。

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

hit( pk = null) :

继承

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

bool成功时为真。

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

isCheckedOut( with,  against = null) :

继承

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

自	1.7.0

参数

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

响应

bool如果已签出，则为 True。

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

load( keys = null,  reset = true) :

继承

自

1.7.0

抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

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

响应

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

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

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

继承

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

自	1.7.0
抛出	`UnexpectedValueException`

参数

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

响应

bool成功时为真。

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

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成功时为真。

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

set( property,  value = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除创建用于该属性的正确设置函数

参数

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

响应

mixed属性的先前值。

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

setColumnAlias( column,  columnAlias) :

继承

自	3.4

参数

专栏: string“特殊”列（例如排序）
columnAlias: string实际列名（例如 foo_ordering）

响应

void

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :

继承

自	4.2.0

参数

currentUser: User当前用户对象

响应

void

设置 DatabaseDriver 对象的方法。

setDbo(\Joomla\Database\DatabaseDriver db) :

继承

自	1.7.0

参数

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

响应

bool成功时为真。

添加错误消息。

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 中删除创建用于该属性的正确设置函数

参数

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

响应

bool

设置记录规则的方法。

setRules( input) :

继承

自	1.7.0

参数

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

响应

void

从 Table 实例属性存储数据库中的一行的方法。

store( updateNulls = false) :

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

自	1.6

参数

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

响应

bool成功时为真。

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

继承已弃用

自	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 值

继承

自	3.10.0

Type(s)

bool

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

继承

自	4.0.0

Type(s)

字符串

当前用户对象。

继承

自	4.2.0

Type(s)

用户