Joomla! API

下载
启动

Update

扩展 Table

Update 表临时存储更新

自

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

自

1.7.0

响应

字符串

_getAssetParentId

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

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

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

自

1.7.0

参数

表

Table资产父级的 Table 对象。

id

int要查找的 ID

响应

int

_getAssetTitle

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

_getAssetTitle() :
继承

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

自

1.7.0

响应

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

_lock

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

_lock() :
继承
自

1.7.0
抛出

RuntimeException

响应

bool成功时为真。

_unlock

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

_unlock() :
继承
自

1.7.0

响应

bool成功时为真。

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

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

check

重载的 check 函数

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

1.7.0

响应

bool如果对象正常，则为真

checkIn

用于检查行，如果必要的属性/字段存在，则将行检入。

checkIn( pk = null) :
继承

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

自

1.7.0
抛出

UnexpectedValueException

参数

pk

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

响应

bool成功时为真。

checkOut

用于检查行，如果必要的属性/字段存在，则将行签出。

checkOut( userId,  pk = null) :
继承

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

自

1.7.0
抛出

UnexpectedValueException

参数

userId

int签出行的用户的 ID。

pk

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

响应

bool成功时为真。

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

find

用于创建和执行 SELECT WHERE 查询的方法。

find(mixed||string|int options = []) :
自

1.7.0

参数

选项

array<string|int, mixed>选项数组

响应

string查询结果

get

返回对象的属性，如果未设置该属性，则返回默认值。

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

1.7.0
见 CMSObject::getProperties()
已弃用

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

参数

属性

string属性的名称。

默认

mixed默认值。

响应

mixed属性的值。

getColumnAlias

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

getColumnAlias( column) :
继承
自

3.4

参数

列

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

响应

混合

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

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

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

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用于订单更新的过滤器

ignore

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

响应

bool成功时为真。

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

setDbo

用于设置 DatabaseDriver 对象的方法。

setDbo(\Joomla\Database\DatabaseDriver db) :
继承
自

1.7.0

参数

db

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

响应

bool成功时为真。

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

store

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

store( updateNulls = false) :
继承

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

自

1.7.0

参数

updateNulls

bool如果即使字段为 null 也要更新字段，则为 True。

响应

bool成功时为真。

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

确保绑定方法中的参数采用 json 编码

自

4.0.0

Type(s)

array<string|int, mixed>

_supportNullValue

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

继承
自

3.10.0

Type(s)

bool

typeAlias

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

继承
自

4.0.0

Type(s)

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