BaseModel
实现 ModelInterface，StatefulModelInterfaceJoomla 模型的基类
| 自版本 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数
__construct(mixed||string|int config = []) :
| 自版本 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- config
array<string|int, mixed>配置选项数组（名称、状态、忽略请求）。
响应
混合类型
_createFileName
创建资源的文件名
_createFileName( type, mixed||string|int parts = []) :
| 自版本 |
3.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除 将被移除且没有替换 |
参数
- 类型
string要为其创建文件名的资源类型。- parts
array<string|int, mixed>文件名信息的关联数组。
响应
string文件名
addIncludePath
添加 \JModelLegacy 应该在其中搜索模型的目录。您可以传递字符串或目录数组。
addIncludePath( path = '', prefix = '') : mixed||string|int
addTablePath
按后进先出 (LIFO) 顺序将模型表路径添加到堆栈中。
addTablePath( path) :
| 自版本 |
3.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除 将被移除且没有替换。改为通过 MVCFactory 获取模型 |
参数
- path
mixed要添加的目录（字符串）或目录数组。
响应
空
createModelFromComponent
通过从前缀加载组件来返回 Model 对象。
createModelFromComponent( type, prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\ModelInterface|null
| 自版本 |
4.0.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除 将被移除且没有替换 |
参数
- 类型
string要实例化的模型类型- prefix
string模型类名的前缀。可选。- config
array<string|int, mixed>模型的配置数组。可选。
响应
ModelInterface|nullModelInterface 实例或失败时的 null
def
如果尚未分配，则设置默认值
def( property, default = null) :
| 自版本 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中移除 不应再使用定义动态属性 |
参数
- property
string属性的名称。- default
mixed默认值。
响应
混合类型
get
返回对象的属性或如果未设置属性则返回默认值。
get( property, default = null) :
| 自版本 |
1.7.0 |
|---|---|
| 参见 | CMSObject::getProperties() |
| 已弃用 |
4.3.0 将在 6.0 中移除 为属性创建一个合适的 getter 函数 |
参数
- property
string属性的名称。- default
mixed默认值。
响应
mixed属性的值。
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>错误消息数组。
getInstance
返回 Model 对象，始终创建它
getInstance( type, prefix = '', mixed||string|int config = []) : self|bool
| 自版本 |
3.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除 将被移除且没有替换。改为通过 MVCFactory 获取模型 例如：Factory::getApplication->bootComponent('com_xxx')->getMVCFactory()->createModel($type, $prefix, $config); |
参数
- 类型
string要实例化的模型类型- prefix
string模型类名的前缀。可选。- config
array<string|int, mixed>模型的配置数组。可选。
响应
self|bool\JModelLegacy 实例或失败时的 false
getName
获取模型名称的方法
getName() :
模型名称。默认情况下使用类名解析，或者可以通过在类构造函数中传递 $config['name'] 来设置。
| 自版本 |
4.0.0 |
|---|---|
| 抛出 |
|
响应
string模型的名称
getProperties
返回对象属性的关联数组。
getProperties( public = true) : mixed||string|int
| 自版本 |
1.7.0 |
|---|---|
| 参见 | CMSObject::get() |
| 已弃用 |
4.3.0 将在 6.0 中移除 为属性创建一个合适的 getter 函数 |
参数
- 公有
bool如果为 true，则仅返回公有属性。
响应
array<string|int, mixed>
getState
获取状态变量的方法。
getState( property = null, default = null) :
| 自版本 |
4.0.0 |
|---|
参数
- property
string可选参数名称- default
mixed可选默认值
响应
mixed指定时的属性，省略时的状态对象
populateState
自动填充状态的方法。
populateState() :
此方法应在每个实例化时仅调用一次，并且旨在在首次调用 getState() 方法时调用，除非设置了忽略请求的配置标志。
| 注意 |
在此方法中调用 getState 将导致递归。 |
|---|---|
| 自版本 |
4.0.0 |
响应
空
set
修改对象的属性，如果它不存在则创建它。
set( property, value = null) :
| 自版本 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中移除 为属性创建一个合适的 setter 函数 |
参数
- property
string属性的名称。- value
mixed要设置的属性的值。
响应
mixed属性的先前值。
setError
添加错误消息。
setError( error) :
| 自版本 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中移除 将被移除且没有替换 改为抛出异常而不是使用 setError |
参数
- error
string错误消息。
响应
空
setProperties
根据命名数组/哈希设置对象属性。
setProperties( properties) :
| 自版本 |
1.7.0 |
|---|---|
| 参见 | CMSObject::set() |
| 已弃用 |
4.3.0 将在 6.0 中移除 为属性创建一个合适的 setter 函数 |
参数
- properties
mixed关联数组或其他对象。
响应
布尔值
setState
设置状态变量的方法。
setState( property, value = null) :
| 自版本 |
4.0.0 |
|---|
参数
- property
string属性的名称- value
mixed要设置的属性的值或 null
响应
mixed属性的先前值或如果未设置则为 null
属性
_errors
错误消息或 Exception 对象的数组。
| 自版本 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 JError 已弃用 |
类型(s)
array<string|int, mixed>
__state_set
指示内部状态是否已设置
| 自版本 |
4.0.0 |
|---|
类型(s)
布尔值
name
模型（基本）名称
| 自版本 |
4.0.0 |
|---|
类型(s)
字符串
paths
包含路径
| 自版本 |
4.0.0 |
|---|
类型(s)
array<string|int, mixed>