HtmlView
扩展自 AbstractView 实现 CurrentUserInterfaceJoomla Html 视图的基类
包含用于显示表示数据的类的类。
| 自 |
2.5.5 |
|---|---|
| 包 |
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：用于显示视图的布局（可选）
响应
混合
_addPath
添加到模板和资源的搜索路径。
_addPath( type, path) :
| 自 |
3.0 |
|---|
参数
- 类型
string要添加的路径类型。- path
mixed要搜索的目录或流，或两者之一的数组。
响应
空
_createFileName
创建资源的文件名
_createFileName( type, mixed||string|int parts = []) :
| 自 |
3.0 |
|---|
参数
- 类型
string要为其创建文件名的资源类型- parts
array<string|int, mixed>文件名信息的关联数组
响应
string文件名
_setPath
为模板或资源设置一组完整的搜索路径。
_setPath( type, path) :
| 自 |
3.0 |
|---|
参数
- 类型
string要设置的路径类型，通常为“模板”。- path
mixed新的搜索路径，或搜索路径的数组。如果为 null 或 false，则重置为仅当前目录。
响应
空
addHelperPath
按后进先出顺序添加到助手脚本路径堆栈中。
addHelperPath( path) :
| 自 |
3.0 |
|---|
参数
- path
mixed目录路径或路径数组。
响应
空
addTemplatePath
按后进先出顺序添加到视图脚本路径堆栈中。
addTemplatePath( path) :
| 自 |
3.0 |
|---|
参数
- path
mixed目录路径或路径数组。
响应
空
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) :
| 抛出 |
|
|---|---|
| 参见 | JViewLegacy::loadTemplate() |
| 自 |
3.0 |
参数
- tpl
string要解析的模板文件的名称；自动搜索模板路径。
响应
空
escape
转义视图脚本中输出的值。
escape( var) :
如果转义机制为 htmlspecialchars，则使用 {@link $_charset} 设置。
| 注意 |
ENT_COMPAT 标志在 Joomla 4.0 中被 ENT_QUOTES 替换，以转义单引号 |
|---|---|
| 自 |
3.0 |
参数
- 变量
mixed要转义的输出。
响应
mixed转义后的值。
get
从注册的模型或视图的属性获取数据的方法
get( property, default = null) :
| 自 |
3.0 |
|---|
参数
- 属性
string要在模型上调用的方法的名称或要获取的属性的名称- 默认
string要引用的模型的名称或默认值 [可选]
响应
mixed方法的返回值
getCurrentUser
返回当前用户，如果未设置，则返回全局应用程序的身份。这将在 6.0 中更改，并将返回空用户。
getCurrentUser() : \Joomla\CMS\User\User
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>错误消息数组。
getForm
返回表单对象
getForm() :
| 自 |
3.2 |
|---|
响应
mixed成功时为 \JForm 对象，失败时为 false
getLanguage
获取语言。
getLanguage() : \Joomla\CMS\Language\Language
getLayout
获取布局。
getLayout() :
| 自 |
3.0 |
|---|
响应
string布局名称
getLayoutTemplate
获取布局模板。
getLayoutTemplate() :
| 自 |
3.0 |
|---|
响应
string布局模板名称
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如果为 true，则仅返回公共属性。
响应
array<string|int, mixed>
loadHelper
加载助手文件
loadHelper( hlp = null) :
| 自 |
3.0 |
|---|
参数
- hlp
string助手源文件的名称，自动搜索助手路径并根据需要编译。
响应
空
loadTemplate
加载模板文件 - 首先在模板文件夹中查找覆盖
loadTemplate( tpl = null) :
| 自 |
3.0 |
|---|---|
| 抛出 |
|
参数
- tpl
string模板源文件的名称；自动搜索模板路径并根据需要编译。
响应
string模板脚本的输出。
set
修改对象的属性，如果它不存在则创建它。
set( property, value = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中删除 为属性创建合适的 setter 函数 |
参数
- 属性
string属性的名称。- 值
mixed要设置的属性的值。
响应
mixed属性的先前值。
setCurrentUser
设置当前用户。
setCurrentUser(\Joomla\CMS\User\User currentUser) :
setDocument
设置要使用的文档。
setDocument(\Joomla\CMS\Document\Document document) :
setDocumentTitle
根据全局配置选项设置文档标题
setDocumentTitle( title) :
| 自 |
3.6 |
|---|
参数
- 标题
string页面标题
响应
空
setError
添加错误消息。
setError( error) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中删除 将无替换删除 改为抛出异常，而不是使用 setError |
参数
- 错误
string错误消息。
响应
空
setLanguage
设置要使用的语言。
setLanguage(\Joomla\CMS\Language\Language language) :
setLayout
设置要使用的布局名称
setLayout( layout) :
| 自 |
3.0 |
|---|
参数
- 布局
string布局名称或格式字符串:响应
string先前值。setLayoutExt
允许使用布局文件的不同扩展名。
setLayoutExt( value) :
自 3.0
参数
- 值
string扩展名。
响应
string先前值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)
字符串_basePath
视图的基路径
自 3.0
类型(s)
字符串_layout
布局名称
自 3.0
类型(s)
字符串_layoutExt
布局扩展名
自 3.0
类型(s)
字符串_layoutTemplate
布局模板
自 3.0
类型(s)
字符串_path
资源（模板）的搜索目录集
自 3.0
类型(s)
array<string|int, mixed>_template
默认模板源文件的名称。
自 3.0
类型(s)
字符串_output
模板脚本的输出。
自 3.0
类型(s)
字符串_charset
转义机制中使用的字符集；默认为 urf8 (UTF-8)
自 3.0
类型(s)
字符串