Joomla! CMS 5.1.x API » \Joomla\CMS\Layout\FileLayout

链接
自	3.0
包	Joomla CMS

实例化基于文件布局的方法。

__construct( layoutId,  basePath = null,  options = null) :

自	3.0

参数

layoutId: string布局文件的点分隔路径，相对于基本路径
basePath: string加载布局文件时要使用的基本路径
options: mixed可选的自定义选项，要加载。注册表或数组格式 [@since 3.2]

响应

混合

将调试消息添加到调试消息数组

addDebugMessage( message) :

继承

自	3.2

参数

message: string要保存的消息

响应

自身

添加一个要在布局搜索中包含的路径。addIncludePaths() 的代理

addIncludePath(string|string[] path) :

自	3.2

参数

path: string|array<string|int, string>要搜索布局的路径

响应

自身

添加一个或多个路径，以包含在布局搜索中

addIncludePaths(string|string[] paths) :

自	3.2

参数

paths: string|array<string|int, string>要搜索布局的路径或路径数组

响应

自身

清除调试消息数组

clearDebugMessages() :

继承

自	3.5

响应

自身

清除包含路径

clearIncludePaths() :

自	3.5

响应

自身

使用调试信息渲染布局

debug( data = []) :

继承

自	3.5

参数

data: mixed传递给布局的数据

响应

string

转义输出的方法。

escape( output) :

继承

注意	ENT_COMPAT 标志在 Joomla 4.0 中被 ENT_QUOTES 替换，以转义单引号
自	3.0

参数

output: string要转义的输出。

响应

string转义后的输出。

从数据数组获取值的方法

get( key,  defaultValue = null) :

继承

自	3.5

参数

key: string在数据数组中搜索的键
defaultValue: mixed如果未设置键，则返回的默认值

响应

mixed来自数据数组的值 | 如果不存在则为 defaultValue

获取正在渲染的数据

getData() : mixed||string|int

继承

自	3.5

响应

array<string|int, mixed>

获取调试消息数组

getDebugMessages() : mixed||string|int

继承

自	3.2

响应

array<string|int, mixed>

获取包含路径的默认数组

getDefaultIncludePaths() : mixed||string|int

自	3.5

响应

array<string|int, mixed>

获取活动包含路径

getIncludePaths() : mixed||string|int

自	3.5

响应

array<string|int, mixed>

获取活动布局 ID

getLayoutId() :

自	3.5

响应

string

获取选项

getOptions() : \Joomla\Registry\Registry

继承

自	3.2

响应

Registry包含选项的对象

查找完整的实际文件路径的方法，检查可能的覆盖

getPath() :

自	3.0

响应

string布局文件的完整路径

获取活动后缀

getSuffixes() : mixed||string|int

自	3.5

响应

array<string|int, mixed>

检查是否启用了调试模式

isDebugEnabled() :

继承

自	3.5

响应

bool

加载自动生成的语言后缀。

loadLanguageSuffixes() :

例如：array('es-ES', 'es', 'ltr')

自	3.5

响应

自身

加载自动生成的版本后缀。

loadVersionSuffixes() :

例如：array('j311', 'j31', 'j3')

自	3.5

响应

自身

从布局搜索中删除一条路径

removeIncludePath( path) :

自	3.2

参数

path: string要从布局搜索中删除的路径

响应

自身

删除一个或多个路径以排除在布局搜索中

removeIncludePaths( paths) :

自	3.2

参数

paths: string要从布局搜索中删除的路径或路径数组

响应

自身

渲染布局的方法。

render(mixed||string|int displayData = []) :

自	3.0

参数

displayData: array<string|int, mixed>在布局文件中可用于构建显示输出的属性数组

响应

string显示布局所需的 HTML

渲染调试消息列表

renderDebugMessages() :

继承

自	3.2

响应

string输出文本/HTML 代码

清空所有选项的功能

resetOptions() : \Joomla\CMS\Layout\BaseLayout

继承

自	3.2

响应

BaseLayout$this 的实例，允许链接。

在数据数组中设置值的方法。示例：$layout->set('items', $items);

set( key,  value) :

继承

自	3.5

参数

key: string数据数组的键
value: mixed要分配给键的值

响应

自身

初始化应用程序客户端的功能

setClient( client) :

自	3.2

参数

client: mixed前端：'site' 或 0 | 后端：'admin' 或 1

响应

void

更改布局搜索路径的组件

setComponent( option) :

自	3.2

参数

option: string组件的 URL 选项。示例：com_content

响应

void

设置传递给布局的数据

setData(mixed||string|int data) :

继承

自	3.5

参数

data: array<string|int, mixed>包含布局数据的数组

响应

自身

更改调试模式

setDebug( debug) :

继承

自	3.5

参数

debug: bool启用/禁用调试

响应

自身

设置包含路径以搜索布局

setIncludePaths(mixed||string|int paths) :

自	3.5

参数

paths: array<string|int, mixed>包含要搜索的路径的数组

响应

自身

设置活动布局 ID

setLayoutId( layoutId) :

自	3.5

参数

layoutId: string布局标识符

响应

自身

设置选项

setOptions(array|\Joomla\Registry\Registry options = null) : \Joomla\CMS\Layout\BaseLayout

继承

自	3.2

参数

options: array<string|int, mixed>|Registry包含要加载的选项的数组/注册表对象

响应

BaseLayout$this 的实例，允许链接。

设置后缀以搜索布局

setSuffixes(mixed||string|int suffixes) :

自	3.5

参数

suffixes: array<string|int, mixed>要使用的后缀数组

响应

自身

使用相同的包含路径和选项渲染布局

sublayout( layoutId,  displayData) :

自	3.2

参数

layoutId: string要在当前布局名称的子文件夹中搜索的子布局的标识符
displayData: mixed要渲染的数据

响应

string显示布局所需的 HTML

验证活动组件是否有效

validComponent( option = null) :

自	3.2

参数

option: string组件的 URL 选项。示例：com_content

响应

bool

选项对象

继承

自	3.2

类型(s)

注册表

布局数据

继承

自	3.5

类型(s)

array<string|int, mixed>

调试信息消息

继承

自	3.2

类型(s)

array<string|int, mixed>

缓存的布局路径

static

自	3.5

类型(s)

array<string|int, mixed>

布局文件的点分隔路径，相对于基本路径

自	3.0

类型(s)

string

加载布局文件时要使用的基本路径

自	3.0

类型(s)

string

实际布局文件的完整路径，在可能的模板覆盖检查之后

自	3.0.3

类型(s)

string

要搜索布局的路径

自	3.2

类型(s)

array<string|int, mixed>