JComponentHelper

Component helper class

since

1.5

package

Joomla.Libraries

Methods

_load

Load the installed components into the components property.

_load(string $option) : boolean
static deprecated
since

1.5

deprecated

4.0 Use JComponentHelper::load() instead

Arguments

$option

stringThe element value for the extension

Response

booleanTrue on success

executeComponent

Execute the component.

executeComponent(string $path) : string
static
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
static
since

2.5

Arguments

$text

stringThe string to filter

Response

stringThe filtered string

getComponent

Get the component information.

getComponent(string $option, boolean $strict = false) : \JComponentRecord
static
since

1.5

Arguments

$option

stringThe component option.

$strict

booleanIf set and the component does not exist, the enabled attribute will be set to false.

Response

\JComponentRecordAn object with the information for the component.

getComponents

Get installed components

getComponents() : array<mixed,\JComponentRecord>
static
since

3.6.3

Response

array<mixed,\JComponentRecord>The components property

getParams

Gets the parameter object for the component

getParams(string $option, boolean $strict = false) : \Joomla\Registry\Registry
static
see \Registry
since

1.5

Arguments

$option

stringThe option for the component.

$strict

booleanIf 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) : boolean
static
since

1.5

Arguments

$option

stringThe component option.

Response

boolean

isInstalled

Checks if a component is installed

isInstalled(string $option) : integer
static
since

3.4

Arguments

$option

stringThe component option.

Response

integer

load

Load the installed components into the components property.

load(string $option) : boolean
static
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

booleanTrue on success

renderComponent

Render the component.

renderComponent(string $option, array $params = array()) : string
static
since

1.5

throws

\JComponentExceptionMissing

Arguments

$option

stringThe component option.

$params

arrayThe component parameters

Response

string

Properties

components

The component list cache

static

Type(s)

array<mixed,\JComponentRecord>