TaggableTableInterface

扩展 TableInterface

可标记的 Table 类接口

3.10.0

Joomla CMS

方法

bind

将关联数组或对象绑定到 TableInterface 实例的方法。

bind( src,  ignore = []) : 
继承的

此方法仅绑定公开可访问的属性,并可以选择性地接收一个属性数组,以在绑定时忽略。

3.2

抛出

UnexpectedValueException

参数

src

mixed要绑定到 TableInterface 实例的关联数组或对象。

ignore

mixed要忽略的可选属性数组或以空格分隔的列表。

响应

bool成功时为 True。

check

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

check() : 
继承的

此接口的实现应使用此方法来确保它们存储在数据库中的数据是安全的,并且在存储之前符合预期。

3.2

响应

bool如果实例是健全的并且可以存储在数据库中,则为 True。

clearTagsHelper

清除一组标签助手

clearTagsHelper() : 

4.0.0

响应

void

delete

删除记录的方法。

delete( pk = null) : 
继承的

3.2

抛出

UnexpectedValueException

参数

pk

mixed可选的主键值以供删除。如果没有设置,将使用实例属性值。

响应

bool成功时为 True。

getDbo

获取 DatabaseDriver 对象的方法。

getDbo() : \Joomla\Database\DatabaseDriver
继承的

3.2

响应

DatabaseDriver内部数据库驱动程序对象。

getId

返回此记录的标识(主键)值

getId() : 
继承的

4.0.0

响应

mixed

getKeyName

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

getKeyName() : 
继承的

3.2

响应

string表的表主键名称。

getTagsHelper

获取标签助手

getTagsHelper() : \Joomla\CMS\Helper\TagsHelper

4.0.0

响应

TagsHelper|null标签助手对象

getTypeAlias

获取标签映射表的类型别名

getTypeAlias() : 

类型别名通常是具有内容类型的内部组件名称。例如:com_content.article

4.0.0

响应

string如上所述的别名

hasField

检查记录是否具有属性(如果存在,则应用列别名)

hasField( key) : 
继承的

4.0.0

参数

key

string要检查的键

响应

bool

load

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

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

3.2

抛出

RuntimeException

UnexpectedValueException

参数

keys

mixed可选的主键值以供加载行,或要匹配的字段数组。如果没有设置,将使用实例属性值。

reset

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

响应

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

reset

将类属性重置为类定义中设置的默认值的方法。

reset() : 
继承的

它将忽略主键以及任何私有类属性。

3.2

响应

void

setTagsHelper

设置标签助手

setTagsHelper(\Joomla\CMS\Helper\TagsHelper tagsHelper) : 

4.0.0

参数

tagsHelper

TagsHelper标签助手对象

响应

void

store

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

store( updateNulls = false) : 
继承的

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

3.2

参数

updateNulls

bool如果要更新字段,即使它们为空,也为 True。

响应

bool成功时为 True。