Joomla! API

下载
启动

Table

扩展 stdClass 实现 TableInterface, DispatcherAwareInterface

抽象 Table 类

抽象

所有表的父类。

自

1.7.0
包

Joomla CMS

方法

__construct

对象构造函数，用于设置表和键字段。在大多数情况下，子类将覆盖此方法以明确设置特定数据库表的表和键字段。

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

1.7.0

参数

table

string要建模的表的名称。

key

mixed表中主键字段的名称或组成主键的字段名称数组。

db

DatabaseDriverDatabaseDriver 对象。

dispatcher

DispatcherInterface此表的事件调度程序

响应

mixed

_getAssetName

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

_getAssetName() :

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

自

1.7.0

响应

string

_getAssetParentId

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

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

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

自

1.7.0

参数

table

Table资产父级的 Table 对象。

id

int要查找的 ID

响应

int

_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 加载的

参数

path

array<string|int, mixed>|string要添加的文件系统路径或文件系统路径数组。

响应

array<string|int, mixed>用于查找 Table 类的文件系统路径数组。

appendPrimaryKeys

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

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

3.1.4

参数

query

DatabaseQuery要附加的查询对象。

pk

mixed可选的主键参数。

响应

void

bind

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

bind(array|object src, array|string ignore = []) :
自

1.7.0
抛出

InvalidArgumentException

参数

src

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

ignore

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

响应

bool成功时为 True。

check

对 Table 实例属性执行完整性检查以确保它们可以安全地存储在数据库中的方法。

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 中删除 不应再使用定义动态属性

参数

property

string属性的名称。

default

mixed默认值。

响应

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 函数

参数

property

string属性的名称。

default

mixed默认值。

响应

mixed属性的值。

getColumnAlias

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

getColumnAlias( column) :
自

3.4

参数

column

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

参数

reload

bool重新加载缓存的标志

响应

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

getId

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

getId() :
自

4.0.0

响应

mixed

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

参数

type

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

prefix

stringTable 类名称的可选前缀。

config

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

响应

Table|bool如果找到则为 Table 对象，如果失败则为布尔值 false。

getKeyName

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

getKeyName( multiple = false) :
自

1.7.0

参数

multiple

boolTrue 表示返回所有主键（作为数组），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

参数

keys

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

参数

key

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如果已签出，则为 true。

load

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

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

1.7.0
抛出

InvalidArgumentException

RuntimeException

UnexpectedValueException

参数

keys

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

reset

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

响应

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

move

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

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

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

自

1.7.0
抛出

UnexpectedValueException

参数

增量

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

where

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

响应

bool成功时为 True。

publish

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

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

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

自

1.7.0

参数

主键

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

状态

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

userId

int执行操作的用户 ID。

响应

bool成功时为 true；如果 $pks 为空，则为 false。

reorder

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

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

1.7.0
抛出

UnexpectedValueException

参数

where

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 实例的关联数组或对象。

排序过滤器

string排序更新的过滤器

ignore

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

响应

bool成功时为 True。

set

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

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

1.7.0
已弃用

4.3.0 将在 6.0 中移除 创建属性的正确设置器函数

参数

property

string属性的名称。

值

mixed要设置的属性的值。

响应

mixed属性的先前值。

setColumnAlias

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

setColumnAlias( column,  columnAlias) :
自

3.4

参数

column

string“特殊”列（即排序）

列别名

string真实的列名（即 foo_ordering）

响应

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

参数

错误

string错误消息。

响应

void

setProperties

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

setProperties( properties) :
继承 已弃用
自

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

4.3.0 将在 6.0 中移除 创建属性的正确设置器函数

参数

属性

mixed关联数组或其他对象。

响应

bool

setRules

用于设置记录规则的方法。

setRules( input) :
自

1.7.0

参数

输入

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

响应

void

store

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

store( updateNulls = false) :

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

自

1.7.0

参数

更新空值

bool即使字段为空也更新字段，设置为 true。

响应

bool成功时为 True。

属性

_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

类型

string

_tbl_key

表中主键字段的名称。

自

1.7.0

类型

string

_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

类型

string
  • \ Joomla
  • \ CMS
  • \ Table
  • \ Table