CategoryFeedView
扩展自 AbstractView类别的基本 Feed 视图类
自 |
3.2 |
---|---|
包 |
Joomla CMS |
方法
__construct
构造函数
__construct(mixed||string|int config = []) :
自 |
3.0 |
---|
参数
- config
array<string|int, mixed>
用于对象构造的命名配置数组。name:视图的名称(可选),默认为视图类名后缀。charset:用于显示的字符集escape:用于转义字符串的函数名称(可选)base_path:视图目录的父路径(可选),默认为组件文件夹template_plath:布局目录的路径(可选),默认为 base_path + /views/ + 视图名称helper_path:辅助文件的路径(可选),默认为 base_path + /helpers/layout:用于显示视图的布局(可选)
响应
混合
def
如果尚未分配,则设置默认值
def( property, default = null) :
自 |
1.7.0 |
---|---|
已弃用 |
4.3.0 将在 6.0 中移除 不应再使用定义动态属性 |
参数
- 属性
string
属性的名称。- 默认
mixed
默认值。
响应
混合
dispatchEvent
在内部调度器上分派给定的事件,并回退到全局调度器。
dispatchEvent(\Joomla\Event\EventInterface event) :
自 |
4.1.0 |
---|---|
已弃用 |
4.4 将在 6.0 中移除。直接使用 $this->getDispatcher()。 |
参数
- 事件
EventInterface
事件
响应
空
display
执行并显示模板脚本。
display( tpl = null) :
自 |
3.2 |
---|---|
抛出 |
|
参数
- tpl
string
要解析的模板文件的名称;自动搜索模板路径。
响应
空
get
从注册的模型或视图的属性中获取数据的方法
get( property, default = null) :
自 |
3.0 |
---|
参数
- 属性
string
要在模型上调用的方法的名称或要获取的属性的名称- 默认
string
要引用的模型的名称或默认值 [可选]
响应
mixed
方法的返回值
getDispatcher
获取事件调度器。
getDispatcher() : \Joomla\Event\DispatcherInterface
进行覆盖是为了保持对旧版组件的向后兼容性。待办事项:在 6.0 中删除覆盖
自 |
4.4.0 |
---|---|
抛出 |
|
响应
DispatcherInterface
getDocument
获取文档。
getDocument() : \Joomla\CMS\Document\Document
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>
错误消息数组。
getLanguage
获取语言。
getLanguage() : \Joomla\CMS\Language\Language
getModel
获取模型对象的方法
getModel( name = null) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
getName
获取视图名称的方法
getName() :
默认情况下使用类名解析的模型名称,或者可以通过在类构造函数中传递 $config['name'] 来设置。
自 |
3.0 |
---|---|
抛出 |
|
响应
string
模型的名称
getProperties
返回对象属性的关联数组。
getProperties( public = true) : mixed||string|int
自 |
1.7.0 |
---|---|
参见 | CMSObject::get() |
已弃用 |
4.3.0 将在 6.0 中移除 为属性创建正确的 getter 函数 |
参数
- 公有
bool
如果为真,则仅返回公有属性。
响应
array<string|int, mixed>
reconcileNames
协调组件中非标准名称以在本类中使用的方法。
reconcileNames( item) :
通常在组件 Feed 视图类中被覆盖。
自 |
3.2 |
---|
参数
- 项目
object
Feed 的项目,$items 数组的元素。
响应
空
set
修改对象的属性,如果它不存在则创建它。
set( property, value = null) :
自 |
1.7.0 |
---|---|
已弃用 |
4.3.0 将在 6.0 中移除 为属性创建正确的 setter 函数 |
参数
- 属性
string
属性的名称。- 价值
mixed
要设置的属性的值。
响应
mixed
属性的先前值。
setDocument
设置要使用的文档。
setDocument(\Joomla\CMS\Document\Document document) :
setError
添加错误消息。
setError( error) :
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 将在 6.0 中移除 将无替换地移除 抛出异常而不是使用 setError |
参数
- 错误
string
错误消息。
响应
空
setLanguage
设置要使用的语言。
setLanguage(\Joomla\CMS\Language\Language language) :
setModel
向视图添加模型的方法。我们支持多模型单视图系统,其中模型通过类名引用。类名引用的一个警告是,任何以 \JModel 开头的类名都将以不带 \JModel 的名称引用,例如 \JModelCategory 只是 Category。
setModel(\Joomla\CMS\MVC\Model\BaseDatabaseModel model, default = false) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
setProperties
根据命名数组/哈希设置对象属性。
setProperties( properties) :
自 |
1.7.0 |
---|---|
参见 | CMSObject::set() |
已弃用 |
4.3.0 将在 6.0 中移除 为属性创建正确的 setter 函数 |
参数
- 属性
mixed
关联数组或其他对象。
响应
布尔
属性
_errors
错误消息或 Exception 对象的数组。
自 |
1.7.0 |
---|---|
已弃用 |
3.1.4 JError 已弃用 |
类型(s)
array<string|int, mixed>
选项
组件的 URL 选项。它通常在控制器创建视图时传递
自 |
3.0 |
---|
类型(s)
字符串
_name
视图的名称
自 |
3.0 |
---|
类型(s)
字符串
_models
已注册的模型
自 |
3.0 |
---|
类型(s)
array<string|int, mixed>
_defaultModel
默认模型
自 |
3.0 |
---|
类型(s)
字符串