Joomla! CMS 5.1.x API » \Joomla\CMS\Helper\ModuleHelper

清理模块列表

cleanModuleList(mixed||string|int modules) : mixed||string|int

静态

参数

模块: array<string|int, mixed>包含模块对象的数组

响应

array<string|int, mixed>

创建虚拟模块的方法。

createDummyModule() : \stdClass

静态

自	4.0.0

响应

stdClass模块对象

获取模块布局的路径

getLayoutPath( module,  layout = 'default') :

静态

自	1.5

参数

模块: string模块名称
布局: string模块布局的名称。如果为替代布局，则格式为 template:filename。

响应

string模块布局的路径

通过名称获取模块（实际名称，如“面包屑”，或文件夹名称，如“mod_breadcrumbs”）

getModule( name,  title = null) : \stdClass

静态

自	1.5

参数

名称: string模块名称
标题: string模块标题，可选

响应

stdClass模块对象

通过 ID 获取模块

getModuleById( id) : \stdClass

静态

自	3.9.0

参数

ID: string模块的 ID

响应

stdClass模块对象

模块列表

getModuleList() : mixed||string|int

静态

响应

array<string|int, mixed>

通过位置获取模块

getModules( position) : mixed||string|int

静态

自	1.5

参数

位置: string模块的位置

响应

array<string|int, mixed>模块对象的数组

用于确定模块后端是否启用了语言过滤的方法。

isAdminMultilang() :

静态

自	3.8.0

响应

bool如果启用，则为 true；否则为 false。

检查模块是否启用。仅当满足以下条件时，才会返回给定模块：已启用、分配到当前菜单项或所有项，以及用户满足访问级别要求。

isEnabled( module) :

静态

自	1.5

参数

模块: string模块名称

响应

bool请参见条件说明。

加载已发布的模块。

load() : mixed||string|int

静态

自	3.2

响应

array<string|int, mixed>

模块缓存助手

moduleCache( module,  moduleparams,  cacheparams) :

静态

缓存模式：在 XML 中设置：'static' 所有具有相同模块参数的页面的单个缓存文件 'itemid' 在 itemid 更改时更改，从模块内部调用：'safeuri' 从 $cacheparams->modeparams 数组创建 ID，'id' 模块设置自己的缓存 ID

参见	InputFilter::clean()
自	1.6

参数

模块: object模块对象
moduleparams: object模块参数
cacheparams: object模块缓存参数 - ID 或 URL 参数，具体取决于模块缓存模式

响应

string

渲染模块。

renderModule( module, mixed||string|int attribs = []) :

静态

自	1.5

参数

模块: object模块对象。
attribs: array<string|int, mixed>模块属性的数组（可能来自 XML）。

响应

string模块输出的 HTML 内容。

渲染模块内容。

renderRawModule( module, \Joomla\Registry\Registry params, mixed||string|int attribs = []) :

静态

自	4.0.0

参数

模块: object模块对象
params: Registry模块参数
attribs: array<string|int, mixed>模块属性的数组（可能来自 XML）。

响应

string