ComponentHelper
Component helper class
| since |
1.5 |
|---|---|
| package |
Joomla CMS |
Methods
_load
Load the installed components into the components property.
_load(string option) : bool
| since |
1.5 |
|---|---|
| deprecated |
4.0 Use JComponentHelper::load() instead |
Arguments
- option
stringThe element value for the extension
Response
boolTrue on success
executeComponent
Execute the component.
executeComponent(string path) : string
| since |
1.7 |
|---|
Arguments
- path
stringThe component path.
Response
stringThe 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
stringThe string to filter
Response
stringThe filtered string
getComponent
Get the component information.
getComponent(string option, bool strict = false) : \Joomla\CMS\Component\ComponentRecord
| since |
1.5 |
|---|
Arguments
- option
stringThe component option.- strict
boolIf set and the component does not exist, the enabled attribute will be set to false.
Response
\Joomla\CMS\Component\ComponentRecordAn object with the information for the component.
getComponents
Get installed components
getComponents() : \Joomla\CMS\Component\ComponentRecord[]
| since |
3.6.3 |
|---|
Response
\Joomla\CMS\Component\ComponentRecord[]The components property
getParams
Gets the parameter object for the component
getParams(string option, bool strict = false) : \Joomla\Registry\Registry
| see | Registry |
|---|---|
| since |
1.5 |
Arguments
- option
stringThe option for the component.- strict
boolIf set and the component does not exist, false will be returned
Response
\Joomla\Registry\RegistryA Registry object.
isEnabled
Checks if the component is enabled
isEnabled(string option) : bool
| since |
1.5 |
|---|
Arguments
- option
stringThe component option.
Response
bool
isInstalled
Checks if a component is installed
isInstalled(string option) : int
| since |
3.4 |
|---|
Arguments
- option
stringThe component option.
Response
int
load
Load the installed components into the components property.
load(string option) : bool
| since |
3.2 |
|---|---|
| note |
As of 4.0 this method will be restructured to only load the data into memory |
Arguments
- option
stringThe element value for the extension
Response
boolTrue on success
renderComponent
Render the component.
renderComponent(string option, array params = array()) : string
| since |
1.5 |
|---|---|
| throws |
|
Arguments
- option
stringThe component option.- params
arrayThe component parameters
Response
string
Properties
components
The component list cache
| since |
1.6 |
|---|
Type(s)
\Joomla\CMS\Component\ComponentRecord[]