Joomla! CMS 5.1.x API » \Joomla\CMS\MVC\Model\FormModel

参见	Form FormField FormRule
自	1.6
包	Joomla CMS

构造函数

__construct(mixed||string|int config = [], \Joomla\CMS\MVC\Factory\MVCFactoryInterface factory = null, \Joomla\CMS\Form\FormFactoryInterface formFactory = null) :

自	3.6
抛出	`异常`

参数

config: array<string|int, mixed>配置选项数组（名称、状态、dbo、table_path、ignore_request）。
factory: MVCFactoryInterface|null工厂。
formFactory: FormFactoryInterface|null表单工厂。

响应

混合

_db 变量的代理。

__get( name) :

继承已弃用

自	4.2.0
已弃用	4.3 将在 6.0 中删除。使用 getDatabase() 而不是直接访问 _db

参数

name: string元素的名称

响应

mixed如果设置了元素的值，否则为 null

为资源创建文件名

_createFileName( type, mixed||string|int parts = []) :

继承 static 已弃用

自	3.0
已弃用	4.3 将在 6.0 中删除。将被删除，不作替换

参数

type: string要为其创建文件名的资源类型。
parts: array<string|int, mixed>文件名信息的关联数组。

响应

string文件名

加载并返回表对象的方法。

_createTable( name,  prefix = 'Table', mixed||string|int config = []) : \Joomla\CMS\Table\Table|bool

继承

自	3.0
参见	Table::getInstance()

参数

name: string视图的名称
prefix: string类前缀。可选。
config: array<string|int, mixed>要传递给 Table::getInstance 的配置设置

响应

Table|bool表对象或布尔值 false（如果失败）

从数据库查询结果中获取对象数组。

_getList(\Joomla\Database\DatabaseQuery|string query,  limitstart,  limit) : object||string|int

继承

自	3.0
抛出	`RuntimeException`

参数

query: DatabaseQuery|string查询。
limitstart: int偏移量。
limit: int记录数。

响应

array<string|int, object>结果数组。

返回查询的记录数。

_getListCount(\Joomla\Database\DatabaseQuery|string query) :

继承

注意：此方法的当前实现假设 getListQuery() 返回一组唯一的行，因此它使用 SELECT COUNT(*) 来计算行数。如果 getListQuery() 使用 DISTINCT，则要么必须在派生模型类中通过自定义实现覆盖此方法，要么必须使用 GROUP BY 子句来使集合唯一。

自	3.0

参数

query: DatabaseQuery|string查询。

响应

int查询的行数。

添加 \JModelLegacy 应该在其中搜索模型的目录。您可以传递字符串或目录数组。

addIncludePath( path = '',  prefix = '') : mixed||string|int

继承 static 已弃用

自	3.0
已弃用	4.3 将在 6.0 中删除。将被删除，不作替换。通过 MVCFactory + 命名空间获取模型而不是
参见

参数

path: mixed要搜索的路径或路径数组[sting]。
prefix: string模型的前缀。

响应

array<string|int, mixed>包含目录元素的数组。如果 prefix 等于 ''，则返回所有目录。

按 LIFO 顺序将模型表路径添加到堆栈中。

addTablePath( path) :

继承 static 已弃用

自	3.0
已弃用	4.3 将在 6.0 中删除。将被删除，不作替换。通过 MVCFactory 获取模型而不是

参数

path: mixed要添加的目录（字符串形式）或目录（数组形式）。

响应

void

使用给定名称启动组件。

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface

继承

自	4.0.0

参数

component: string组件名称，例如 com_content。

响应

ComponentInterface服务容器

检查一行的方法。

checkin( pk = null) :

自	1.6

参数

pk: int主键的数字 ID。

响应

bool如果失败或出错，则为 false，否则为 true。

检出要编辑的行的方法。

checkout( pk = null) :

自	1.6

参数

pk: int主键的数字 ID。

响应

bool如果失败或出错，则为 false，否则为 true。

清理缓存

cleanCache( group = null) :

继承

自	3.0

参数

group: string缓存组

响应

void

通过从前缀加载组件来返回模型对象。

createModelFromComponent( type,  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\ModelInterface|null

继承 static 已弃用

自	4.0.0
已弃用	4.3 将在 6.0 中删除。将被删除，不作替换

参数

type: string要实例化的模型类型
prefix: string模型类名称的前缀。可选。
config: array<string|int, mixed>模型的配置数组。可选。

响应

ModelInterface|nullModelInterface 实例或失败时的 null

如果尚未分配，则设置默认值

def( property,  default = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除。不再应使用定义动态属性

参数

property: string属性的名称。
default: mixed默认值。

响应

混合

在内部调度程序上调度给定事件，并对全局调度程序进行回退。

dispatchEvent(\Joomla\Event\EventInterface event) :

继承已弃用

自	4.1.0
已弃用	4.4 将在 6.0 中删除。直接使用 $this->getDispatcher()。

参数

event: EventInterface事件

响应

void

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

get( property,  default = null) :

继承已弃用

自	1.7.0
参见	CMSObject::getProperties()
已弃用	4.3.0 将在 6.0 中删除。为属性创建适当的 getter 函数

参数

property: string属性的名称。
default: mixed默认值。

响应

mixed属性的值。

获取 CacheControllerFactoryInterface。

getCacheControllerFactory() : \Joomla\CMS\Cache\CacheControllerFactoryInterface

继承

自	4.2.0

响应

CacheControllerFactoryInterface

返回当前用户，如果没有设置，则返回全局应用程序的身份。这将在 6.0 中更改，并且将返回空用户。

getCurrentUser() : \Joomla\CMS\User\User

继承

自	4.2.0

响应

User

获取数据库驱动程序。

getDbo() : \Joomla\Database\DatabaseInterface

继承已弃用

自	4.2.0
抛出	`UnexpectedValueException`
已弃用	4.3 将在 6.0 中删除。使用 getDatabase() 而不是示例：$model->getDatabase();

响应

DatabaseInterface数据库驱动程序。

获取事件调度程序。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承

进行覆盖是为了保持与旧组件的向后兼容性。TODO：在 6.0 中删除覆盖

自	4.4.0
抛出	`UnexpectedValueException`如果未设置调度程序，则可能会抛出。

响应

DispatcherInterface

获取最新的错误消息。

getError( i = null,  toString = true) :

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除。将被删除，不作替换。捕获抛出的异常而不是 getError

参数

i: int可选错误索引。
toString: bool指示异常对象是否应返回其错误消息。

响应

string错误消息

返回所有错误（如果有）。

getErrors() : mixed||string|int

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除。将被删除，不作替换。捕获抛出的异常而不是 getErrors

响应

array<string|int, mixed>错误消息数组。

获取 FormFactoryInterface。

getFormFactory() : \Joomla\CMS\Form\FormFactoryInterface

继承抽象

自	4.0.0
抛出	`UnexpectedValueException`如果未设置 FormFactory，则可能会抛出。

响应

FormFactoryInterface

返回模型对象，始终创建它

getInstance( type,  prefix = '', mixed||string|int config = []) : self|bool

继承 static 已弃用

自	3.0
已弃用	4.3 将在 6.0 中删除。将被删除，不作替换。通过 MVCFactory 获取模型而不是示例：Factory::getApplication->bootComponent('com_xxx')->getMVCFactory()->createModel($type, $prefix, $config);

参数

type: string要实例化的模型类型
prefix: string模型类名称的前缀。可选。
config: array<string|int, mixed>模型的配置数组。可选。

响应

self|bool\JModelLegacy 实例或失败时的 false

返回 MVC 工厂。

getMVCFactory() : \Joomla\CMS\MVC\Factory\MVCFactoryInterface

继承

自	4.0.0
抛出	`UnexpectedValueException`

响应

MVCFactoryInterface

获取模型名称的方法

getName() :

继承

模型名称。默认情况下使用类名解析，也可以通过在类构造函数中传递 $config['name'] 来设置

自	4.0.0
抛出	`异常`

响应

string模型的名称

返回对象属性的关联数组。

getProperties( public = true) : mixed||string|int

继承已弃用

自	1.7.0
参见	CMSObject::get()
已弃用	4.3.0 将在 6.0 中删除。为属性创建适当的 getter 函数

参数

public: bool如果为 true，则仅返回公共属性。

响应

array<string|int, mixed>

获取状态变量的方法。

getState( property = null,  default = null) :

继承

自	4.0.0

参数

property: string可选参数名称
default: mixed可选默认值

响应

mixed指定的属性，省略时的状态对象

获取表对象的方法，如果需要，则加载它。

getTable( name = '',  prefix = '', mixed||string|int options = []) : \Joomla\CMS\Table\Table

继承

自	3.0
抛出	`异常`

参数

name: string表名。可选。
prefix: string类前缀。可选。
options: array<string|int, mixed>模型的配置数组。可选。

响应

Table一个 Table 对象

方法用于检查给定的记录是否被当前用户检出

isCheckedOut(\stdClass item) :

继承

参数

item: stdClass要检查的记录

响应

bool

方法用于获取表单对象。

loadForm( name,  source = null, mixed||string|int options = [],  clear = false,  xpath = null) : \Joomla\CMS\Form\Form

继承

参见	Form
自	4.0.0
抛出	`异常`

参数

name: string表单的名称。
source: string表单源。如果 file 标志设置为 false，则可以是 XML 字符串。
options: array<string|int, mixed>用于表单创建的可选选项数组。
clear: bool可选参数，用于强制加载新的表单。
xpath: string用于搜索字段的可选 xpath。

响应

Form

方法用于获取应注入表单中的数据。

loadFormData() : mixed||string|int

继承

自	4.0.0

响应

array<string|int, mixed>默认数据是一个空数组。

方法用于自动填充状态。

populateState() :

继承

此方法应在每个实例化时只调用一次，并且旨在在第一次调用 getState() 方法时调用，除非设置了忽略请求的配置标志。

note	在此方法中调用 getState 将导致递归。
自	4.0.0

响应

void

方法允许派生类预处理数据。

preprocessData( context,  &data,  group = 'content') :

继承

自	4.0.0

参数

context: string上下文标识符。
data: mixed要处理的数据。它将直接被修改。
group: string要导入的插件组的名称（默认为“content”）。

响应

void

方法允许派生类预处理表单。

preprocessForm(\Joomla\CMS\Form\Form form,  data,  group = 'content') :

继承

参见	FormField
自	4.0.0
抛出	`Exception`如果表单事件中存在错误。

参数

form: Form一个 Form 对象。
data: mixed表单期望的数据。
group: string要导入的插件组的名称（默认为“content”）。

响应

void

修改对象属性，如果属性不存在则创建它。

set( property,  value = null) :

继承已弃用

自	1.7.0
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的 setter 函数

参数

property: string属性的名称。
value: mixed要设置的属性的值。

响应

mixed属性的先前值。

设置要使用的缓存控制器工厂。

setCacheControllerFactory(\Joomla\CMS\Cache\CacheControllerFactoryInterface cacheControllerFactory = null) :

继承

自	4.2.0

参数

cacheControllerFactory: CacheControllerFactoryInterface要使用的缓存控制器工厂。

响应

void

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :

继承

自	4.2.0

参数

currentUser: User当前用户对象

响应

void

设置数据库驱动程序。

setDbo(\Joomla\Database\DatabaseInterface db = null) :

继承已弃用

自	4.2.0
已弃用	4.3 将在 6.0 中删除使用 setDatabase() 代替例如：$model->setDatabase($db);

参数

db: DatabaseInterface|null数据库驱动程序。

响应

void

添加错误消息。

setError( error) :

继承已弃用

自	1.7.0
已弃用	3.1.4 将在 6.0 中删除将被删除，不会替换使用 Exception 代替 setError

参数

error: string错误消息。

响应

void

设置要使用的表单工厂。

setFormFactory(\Joomla\CMS\Form\FormFactoryInterface formFactory = null) :

继承

自	4.0.0

参数

formFactory: FormFactoryInterface|null要使用的表单工厂。

响应

$this

设置 MVC 工厂。

setMVCFactory(\Joomla\CMS\MVC\Factory\MVCFactoryInterface mvcFactory) :

继承

自	4.0.0

参数

mvcFactory: MVCFactoryInterfaceMVC 工厂

响应

void

基于命名数组/哈希设置对象属性。

setProperties( properties) :

继承已弃用

自	1.7.0
参见	CMSObject::set()
已弃用	4.3.0 将在 6.0 中删除为属性创建适当的 setter 函数

参数

properties: mixed关联数组或其他对象。

响应

bool

方法用于设置状态变量。

setState( property,  value = null) :

继承

自	4.0.0

参数

property: string属性的名称
value: mixed要设置的属性的值或 null

响应

mixed属性的先前值，如果未设置则为 null

方法用于验证表单数据。

validate(\Joomla\CMS\Form\Form form, mixed||string|int data,  group = null) : array|bool

参见	FormRule InputFilter
自	1.6

参数

form: Form要验证的表单。
data: array<string|int, mixed>要验证的数据。
group: string要验证的字段组的名称。

响应

array<string|int, mixed>|bool如果有效，则为过滤后的数据数组，否则为 false。

错误消息或 Exception 对象的数组。

继承已弃用

自	1.7.0
已弃用	3.1.4 JError 已被弃用

Type(s)

array<string|int, mixed>

指示内部状态是否已设置

继承

自	4.0.0

Type(s)

bool

状态对象

继承

自	4.0.0

Type(s)

State

模型（基本）名称

继承

自	4.0.0

Type(s)

string

包含路径

inherited static

自	4.0.0

Type(s)

array<string|int, mixed>

CacheControllerFactoryInterface

继承

自	4.2.0

Type(s)

CacheControllerFactoryInterface

当前用户对象。

继承

自	4.2.0

Type(s)

User

mvc 工厂。

继承

自	4.0.0

Type(s)

MVCFactoryInterface

组件的 URL 选项。

继承

自	3.0

Type(s)

string

清理缓存时触发的事件。

继承

自	3.0

Type(s)

string

FormFactoryInterface

继承

自	4.0.0

Type(s)

FormFactoryInterface

表单对象的数组。

继承

自	4.0.0

Type(s)

array<string|int, Form>

将事件映射到插件组。

自	3.6

Type(s)

array<string|int, mixed>