Joomla! API

下载
启动

语言

扩展 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 是表主键的值。

自

3.8.0

响应

字符串

_getAssetParentId

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

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

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

自

3.8.0

参数

表

Table资产父级的一个 Table 对象。

id

int要查找的 ID

响应

int

_getAssetTitle

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

_getAssetTitle() :
自

3.8.0

响应

字符串

_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
继承 static 已弃用
自

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

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

check

重载 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( 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 等）的真实名称的方法。通过这种方式，您可以自由地遵循您的 db 命名约定并使用内置的 \Joomla 函数。

getColumnAlias( column) :
继承
自

3.4

参数

列

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

响应

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 类的实例。

getInstance( type,  prefix = 'JTable', mixed||string|int config = []) : \Joomla\CMS\Table\Table|bool
继承 static 已弃用

要添加用于搜索 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 对象，则为 Table 对象，如果失败，则为布尔值 false。

getKeyName

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

getKeyName( multiple = false) :
继承
自

1.7.0

参数

多个

boolTrue 表示返回所有主键（作为数组），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正在建模的数据库表的名称。

hasField

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

hasField( key) :
继承
自

3.9.11

参数

键

string要检查的键

响应

布尔

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

参数

键

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

reset

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

响应

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

move

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

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

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

自

1.7.0
抛出

UnexpectedValueException

参数

增量

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

哪里

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

响应

bool成功时为 True。

publish

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

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

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

自

1.7.0

参数

pks

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

状态

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属性的名称。

值

mixed要设置的属性的值。

响应

mixed属性的先前值。

setColumnAlias

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

setColumnAlias( column,  columnAlias) :
继承
自

3.4

参数

列

string“特殊”列（即排序）

columnAlias

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 中删除。为属性创建适当的 setter 函数

参数

属性

mixed关联数组或其他对象。

响应

布尔

setRules

设置记录规则的方法。

setRules( input) :
继承
自

1.7.0

参数

输入

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

响应

void

store

覆盖 Table::store 以检查唯一字段。

store( updateNulls = false) :
自

2.5.0

参数

updateNulls

bool如果更新字段，即使它们为 null，则为 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

Table 字段缓存

继承 静态
自

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

类型

布尔

_rules

与该记录关联的规则。

继承
自

1.7.0

类型

规则

_locked

指示表已被锁定的指标。

继承
自

1.7.0

类型

布尔

_autoincrement

指示主键自动递增。

继承
自

3.1.4

类型

布尔

_columnAlias

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

继承
自

3.4.0

类型

array<string|int, mixed>

_jsonEncode

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

继承
自

3.3

类型

array<string|int, mixed>

_supportNullValue

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

继承
自

3.10.0

类型

布尔

typeAlias

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

继承
自

4.0.0

类型

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