Joomla! API

下载
启动

Content

扩展 Table 实现 VersionableTableInterface, TaggableTableInterface, CurrentUserInterface

内容表

自

1.5
包

Joomla CMS

方法

__construct

构造函数

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

1.5

参数

db

DatabaseDriver数据库连接器对象

dispatcher

DispatcherInterface|null此表的事件调度器

响应

混合

_getAssetName

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

_getAssetName() :

默认名称采用 table_name.id 的形式，其中 id 是表主键的值。

自

1.6

响应

字符串

_getAssetParentId

用于获取记录的父资产 ID 的方法

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

1.6

参数

表

Table资产父级的 Table 对象（可选）

id

int内容的 ID（可选）。

响应

int

_getAssetTitle

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

_getAssetTitle() :
自

1.6

响应

字符串

_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可选主键参数。

响应

void

bind

重载的 bind 函数

bind(mixed||string|int array,  ignore = '') :
参见 Table::bind()
自

1.6

参数

数组

array<string|int, mixed>命名数组

忽略

mixed在绑定时要忽略的属性的可选数组或空格分隔列表。

响应

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

check

重载的 check 函数

check() :
参见 Table::check()
自

1.5

响应

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

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。

clearTagsHelper

清除标签助手

clearTagsHelper() :
继承
自

4.0.0

响应

void

def

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

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

1.7.0
已弃用

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

参数

属性

string属性的名称。

默认

mixed默认值。

响应

混合

delete

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

delete( pk = null) :
继承
自

1.7.0
抛出

UnexpectedValueException

参数

pk

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

响应

bool成功时为 True。

get

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

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

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

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

参数

属性

string属性的名称。

默认

mixed默认值。

响应

mixed属性的值。

getColumnAlias

用于返回“特殊”列（例如 ordering、hits、published 等）的真实名称的方法。这样，您就可以自由地遵循您的数据库命名约定并使用内置的 \Joomla 函数。

getColumnAlias( column) :
继承
自

3.4

参数

列

string“特殊”列的名称（例如 ordering、hits）

响应

string标识特殊的字符串

getCurrentUser

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

getCurrentUser() : \Joomla\CMS\User\User
继承
自

4.2.0

响应

用户

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 类实例的静态方法（如果该类可以在表包含路径中找到）。

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

参数

哪里

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正在建模的数据库表的名称。

getTagsHelper

获取标签助手

getTagsHelper() : \Joomla\CMS\Helper\TagsHelper
继承
自

4.0.0

响应

TagsHelper标签助手对象

getTypeAlias

获取 UCM 功能的类型别名

getTypeAlias() :
自

4.0.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

参数

with

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

against

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

响应

bool如果已签出，则为 true。

load

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

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

1.7.0
抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

钥匙

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

reset

bool加载新行之前，是否将默认值重置为 true。

响应

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

move

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

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

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

自

1.7.0
抛出

UnexpectedValueException

参数

delta

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

哪里

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成功时为 true；如果 $pks 为空，则为 false。

reorder

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

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

1.7.0
抛出

UnexpectedValueException

参数

哪里

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

响应

mixed成功时为布尔值 true。

reset

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

reset() :
继承
自

1.7.0

响应

void

save

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

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

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）

响应

void

setCurrentUser

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :
继承
自

4.2.0

参数

currentUser

User当前用户对象

响应

void

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

响应

void

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 字符串或数组。

响应

void

setTagsHelper

设置标签助手

setTagsHelper(\Joomla\CMS\Helper\TagsHelper tagsHelper) :
继承
自

4.0.0

参数

tagsHelper

TagsHelper要设置的标签助手

响应

void

store

覆盖 Table::store 以设置修改后的数据和用户 ID。

store( updateNulls = true) :
自

1.6

参数

updateNulls

bool如果字段为空，是否更新字段。

响应

bool成功时为 True。

Properties

_errors

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

继承 已弃用
自

1.7.0
已弃用

3.1.4 JError 已弃用

Type(s)

array<string|int, mixed>

_includePaths

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

inherited static
自

3.0.0

Type(s)

array<string|int, mixed>

tableFields

表字段缓存

inherited static
自

3.10.4

Type(s)

array<string|int, mixed>

_tbl

要建模的数据库表的名称。

继承
自

1.7.0

Type(s)

字符串

_tbl_key

表中主键字段的名称。

继承
自

1.7.0

Type(s)

字符串

_tbl_keys

表中主键字段的名称。

继承
自

3.0.1

Type(s)

array<string|int, mixed>

_db

DatabaseDriver 对象。

继承
自

1.7.0

Type(s)

DatabaseDriver

_trackAssets

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

继承
自

1.7.0

Type(s)

bool

_rules

与该记录关联的规则。

继承
自

1.7.0

Type(s)

Rules

_locked

指示表是否已锁定。

继承
自

1.7.0

Type(s)

bool

_autoincrement

指示主键是否自动递增。

继承
自

3.1.4

Type(s)

bool

_columnAlias

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

继承
自

3.4.0

Type(s)

array<string|int, mixed>

_jsonEncode

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

继承
自

3.3

Type(s)

array<string|int, mixed>

_supportNullValue

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

自

4.0.0

Type(s)

bool

typeAlias

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

继承
自

4.0.0

Type(s)

字符串

currentUser

当前用户对象。

继承
自

4.2.0

Type(s)

用户

tagsHelper

标签助手属性

继承
自

4.0.0
note

标签助手属性设置为 public，以便与 Joomla 4.0 向后兼容。它将在 Joomla 6.0 中成为受保护的属性。

Type(s)

TagsHelper
  • \ Joomla
  • \ CMS
  • \ Table
  • \ Content