BaseLayout
实现 LayoutInterface渲染显示布局的基本类
| 链接 | |
|---|---|
| 自 |
3.0 |
| 包 |
Joomla CMS |
方法
addDebugMessage
向调试消息数组添加调试消息
addDebugMessage( message) :
| 自 |
3.2 |
|---|
参数
- 消息
string要保存的消息
响应
自身
clearDebugMessages
清空调试消息数组
clearDebugMessages() :
| 自 |
3.5 |
|---|
响应
自身
debug
使用调试信息渲染布局
debug( data = []) :
| 自 |
3.5 |
|---|
参数
- 数据
mixed传递给布局的数据
响应
字符串
escape
转义输出的方法。
escape( output) :
| 注意 |
在 Joomla 4.0 中，ENT_COMPAT 标志被 ENT_QUOTES 替换，以同时转义单引号 |
|---|---|
| 自 |
3.0 |
参数
- 输出
string要转义的输出。
响应
string转义后的输出。
get
从数据数组获取值的方法
get( key, defaultValue = null) :
| 自 |
3.5 |
|---|
参数
- 键
string在数据数组中搜索的键- 默认值
mixed如果未设置键，则返回的默认值
响应
mixed数据数组中的值 | 如果不存在，则为 defaultValue
getData
获取正在渲染的数据
getData() : mixed||string|int
| 自 |
3.5 |
|---|
响应
array<string|int, mixed>
getDebugMessages
获取调试消息数组
getDebugMessages() : mixed||string|int
| 自 |
3.2 |
|---|
响应
array<string|int, mixed>
getOptions
获取选项
getOptions() : \Joomla\Registry\Registry
| 自 |
3.2 |
|---|
响应
Registry包含选项的对象
isDebugEnabled
检查是否启用了调试模式
isDebugEnabled() :
| 自 |
3.5 |
|---|
响应
布尔值
render
渲染布局的方法。
render(mixed||string|int displayData) :
| 自 |
3.0 |
|---|
参数
- 显示数据
array<string|int, mixed>可在布局文件中使用的属性数组，用于构建显示的输出
响应
string显示布局所需的 HTML
renderDebugMessages
渲染调试消息列表
renderDebugMessages() :
| 自 |
3.2 |
|---|
响应
string输出文本/HTML 代码
resetOptions
清空所有选项的功能
resetOptions() : \Joomla\CMS\Layout\BaseLayout
set
在数据数组中设置值的方法。例如：$layout->set('items', $items);
set( key, value) :
| 自 |
3.5 |
|---|
参数
- 键
string数据数组的键- 值
mixed要分配给键的值
响应
自身
setData
设置传递给布局的数据
setData(mixed||string|int data) :
| 自 |
3.5 |
|---|
参数
- 数据
array<string|int, mixed>包含布局数据的数组
响应
自身
setDebug
更改调试模式
setDebug( debug) :
| 自 |
3.5 |
|---|
参数
- debug
bool启用/禁用调试
响应
自身
setOptions
设置选项
setOptions(array|\Joomla\Registry\Registry options = null) : \Joomla\CMS\Layout\BaseLayout
属性
选项
选项对象
| 自 |
3.2 |
|---|
类型(s)
注册表
数据
布局数据
| 自 |
3.5 |
|---|
类型(s)
array<string|int, mixed>
debugMessages
调试信息消息
| 自 |
3.2 |
|---|
类型(s)
array<string|int, mixed>