TableInterface
表类接口。
自 |
3.2 |
---|---|
包 |
Joomla CMS |
方法
bind
将关联数组或对象绑定到 TableInterface 实例的方法。
bind( src, ignore = []) :
此方法仅绑定公开可访问的属性,并可以选择使用属性数组来忽略绑定时的属性。
自 |
3.2 |
---|---|
抛出 |
|
参数
- src
mixed
要绑定到 TableInterface 实例的关联数组或对象。- ignore
mixed
绑定时要忽略的属性的可选数组或空格分隔列表。
响应
bool
成功时为 True。
check
对 TableInterface 实例属性执行完整性检查以确保它们安全存储在数据库中的方法。
check() :
此接口的实现应使用此方法来确保它们在存储到数据库之前存储的数据安全且符合预期。
自 |
3.2 |
---|
响应
bool
如果实例是安全的并且能够存储在数据库中,则为 True。
delete
删除记录的方法。
delete( pk = null) :
自 |
3.2 |
---|---|
抛出 |
|
参数
- pk
mixed
要删除的可选主键值。如果未设置,则使用实例属性值。
响应
bool
成功时为 True。
getDbo
获取 DatabaseDriver 对象的方法。
getDbo() : \Joomla\Database\DatabaseDriver
自 |
3.2 |
---|
响应
DatabaseDriver
内部数据库驱动程序对象。
getId
返回此记录的标识(主键)值
getId() :
自 |
4.0.0 |
---|
响应
mixed
getKeyName
获取表的主键字段名称的方法。
getKeyName() :
自 |
3.2 |
---|
响应
string
表的 primary key 名称。
hasField
检查记录是否具有属性(如果存在,则应用列别名)
hasField( key) :
自 |
4.0.0 |
---|
参数
- key
string
要检查的键
响应
bool
load
通过主键从数据库加载行并将字段绑定到 TableInterface 实例属性的方法。
load( keys = null, reset = true) :
自 |
3.2 |
---|---|
抛出 |
|
参数
- keys
mixed
要加载行的可选主键值,或要匹配的字段数组。如果未设置,则使用实例属性值。- reset
bool
在加载新行之前重置默认值为 True。
响应
bool
如果成功,则为 True。如果未找到行,则为 False。
reset
将类属性重置为类定义中设置的默认值的方法。
reset() :
它将忽略主键以及任何私有类属性。
自 |
3.2 |
---|
响应
void
store
从 TableInterface 实例属性将行存储到数据库的方法。
store( updateNulls = false) :
如果设置了主键值,则具有该主键值的行将使用实例属性值进行更新。如果没有设置主键值,则将使用 TableInterface 实例中的属性将新行插入数据库。
自 |
3.2 |
---|
参数
- updateNulls
bool
即使字段为 null,也要更新字段为 True。
响应
bool
成功时为 True。