JsonView
扩展自 AbstractViewJoomla Json 视图的基类
包含用于显示演示数据的类方法。
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数
__construct(mixed||string|int config = []) :
| 自 |
4.0.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) :
| 自 |
4.0.0 |
|---|
参数
- tpl
string要解析的模板文件的名称；自动搜索模板路径。
响应
空值
get
从注册的模型或视图的属性中获取数据的方法
get( property, default = null) :
| 自 |
3.0 |
|---|
参数
- 属性
string要在模型上调用的方法的名称或要获取的属性的名称- 默认
string要引用的模型的名称或默认值[可选]
响应
mixed方法的返回值
getDispatcher
获取事件调度程序。
getDispatcher() : \Joomla\Event\DispatcherInterface
进行覆盖以保持对旧版组件的向后兼容性。TODO：在 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>
set
修改对象的属性，如果该属性尚不存在则创建它。
set( property, value = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中移除 为属性创建合适的 setter 函数 |
参数
- 属性
string属性的名称。- value
mixed要设置的属性的值。
响应
mixed属性的上一个值。
setDocument
设置要使用的文档。
setDocument(\Joomla\CMS\Document\Document document) :
setError
添加错误消息。
setError( error) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中移除 将不带替换地移除 改为抛出异常，而不是使用 setError |
参数
- error
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 函数 |
参数
- properties
mixed关联数组或其他对象。
响应
bool
属性
_errors
错误消息或 Exception 对象的数组。
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 JError 已弃用 |
类型(s)
array<string|int, mixed>
option
组件的 URL 选项。通常由控制器在创建视图时传递
| 自 |
3.0 |
|---|
类型(s)
string
_name
视图的名称
| 自 |
3.0 |
|---|
类型(s)
string
_models
已注册的模型
| 自 |
3.0 |
|---|
类型(s)
array<string|int, mixed>
_defaultModel
默认模型
| 自 |
3.0 |
|---|
类型(s)
string
_basePath
视图的基本路径
| 自 |
4.0.0 |
|---|
类型(s)
string
_charset
在转义机制中使用的字符集；默认为 urf8 (UTF-8)
| 自 |
4.0.0 |
|---|
类型(s)
string
_output
视图的输出。
| 自 |
4.0.0 |
|---|
类型(s)
array<string|int, mixed>