ComponentHelper
组件助手类
| 自版本 |
1.5 |
|---|---|
| 包 |
Joomla CMS |
方法
filterText
根据当前用户组的设置，将全局文本过滤器应用于任意文本。
filterText( text) :
静态
| 自版本 |
2.5 |
|---|
参数
- text
string要过滤的字符串
返回值
string已过滤的字符串
getComponent
获取组件信息。
getComponent( option, strict = false) : \Joomla\CMS\Component\ComponentRecord
静态
| 自版本 |
1.5 |
|---|
参数
- option
string组件选项。- strict
bool如果设置且组件不存在，则 enabled 属性将设置为 false。
返回值
ComponentRecord包含组件信息的实例。
getComponentName
根据类名返回给定对象的组件名称（例如 com_content）。
getComponentName( object, alternativeName) :
静态
如果对象没有命名空间，则使用备用名称。
| 自版本 |
4.0.0 |
|---|
参数
- object
object对象控制器或模型- alternativeName
string通常是对象 getName() 方法的返回值
返回值
string名称
getComponents
获取已安装的组件
getComponents() : \Joomla\CMS\Component\ComponentRecord||string|int
静态
getParams
获取组件的参数对象
getParams( option, strict = false) : \Joomla\Registry\Registry
静态
| 参见 | Registry |
|---|---|
| 自版本 |
1.5 |
参数
- option
string组件的选项。- strict
bool如果设置且组件不存在，则返回 false
返回值
RegistryRegistry 对象。
isEnabled
检查组件是否已启用
isEnabled( option) :
静态
| 自版本 |
1.5 |
|---|
参数
- option
string组件选项。
返回值
bool
isInstalled
检查组件是否已安装
isInstalled( option) :
静态
| 自版本 |
3.4 |
|---|
参数
- option
string组件选项。
返回值
int
load
将已安装的组件加载到 components 属性中。
load() :
静态
| 自版本 |
3.2 |
|---|
返回值
bool成功时返回 True
renderComponent
渲染组件。
renderComponent( option, mixed||string|int params = []) :
静态
| 自版本 |
1.5 |
|---|---|
| 抛出 |
参数
- option
string组件选项。- params
array<string|int, mixed>组件参数
返回值
string