ComponentHelper
Component helper class
since |
1.5 |
---|
Methods
_load
Load the installed components into the components property.
_load(string $option) : boolean
since |
1.5 |
---|---|
deprecated |
4.0 Use JComponentHelper::load() instead |
Arguments
- $option
string
The element value for the extension
Response
boolean
True on success
executeComponent
Execute the component.
executeComponent(string $path) : string
since |
1.7 |
---|
Arguments
- $path
string
The component path.
Response
string
The component output
filterText
Applies the global text filters to arbitrary text as per settings for current user groups
filterText(string $text) : string
since |
2.5 |
---|
Arguments
- $text
string
The string to filter
Response
string
The filtered string
getComponent
Get the component information.
getComponent(string $option, boolean $strict = false) : \Joomla\CMS\Component\ComponentRecord
since |
1.5 |
---|
Arguments
- $option
string
The component option.- $strict
boolean
If set and the component does not exist, the enabled attribute will be set to false.
Response
\Joomla\CMS\Component\ComponentRecord
An object with the information for the component.
getComponents
Get installed components
getComponents() : array<mixed,\Joomla\CMS\Component\ComponentRecord>
getParams
Gets the parameter object for the component
getParams(string $option, boolean $strict = false) : \Joomla\Registry\Registry
see | \Joomla\CMS\Component\Registry |
---|---|
since |
1.5 |
Arguments
- $option
string
The option for the component.- $strict
boolean
If set and the component does not exist, false will be returned
Response
\Joomla\Registry\Registry
A Registry object.
isEnabled
Checks if the component is enabled
isEnabled(string $option) : boolean
since |
1.5 |
---|
Arguments
- $option
string
The component option.
Response
boolean
isInstalled
Checks if a component is installed
isInstalled(string $option) : integer
since |
3.4 |
---|
Arguments
- $option
string
The component option.
Response
integer
load
Load the installed components into the components property.
load(string $option) : boolean
since |
3.2 |
---|---|
note |
As of 4.0 this method will be restructured to only load the data into memory |
Arguments
- $option
string
The element value for the extension
Response
boolean
True on success
renderComponent
Render the component.
renderComponent(string $option, array $params = array()) : string
since |
1.5 |
---|---|
throws |
|
Arguments
- $option
string
The component option.- $params
array
The component parameters
Response
string
Properties
components
The component list cache