JComponentHelper

Component helper class

package

Joomla.Platform

subpackage

Application

since

11.1

Methods

_load

Load the installed components into the components property.

_load(string $option) : boolean
static
since

11.1

Arguments

$option

stringThe element value for the extension

Response

booleanTrue on success

executeComponent

Execute the component.

executeComponent(string $path) : string
static
since

11.3

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

11.4

Arguments

$text

stringThe string to filter

Response

stringThe filtered string

getComponent

Get the component information.

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

11.1

Arguments

$option

stringThe component option.

$strict

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

Response

objectAn object with the information for the component.

getParams

Gets the parameter object for the component

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

11.1

Arguments

$option

stringThe option for the component.

$strict

booleanIf set and the component does not exist, false will be returned

Response

\JRegistryA JRegistry object.

isEnabled

Checks if the component is enabled

isEnabled(string $option, boolean $strict = false) : boolean
static
since

11.1

Arguments

$option

stringThe component option.

$strict

booleanIf set and the component does not exist, false will be returned.

Response

boolean

renderComponent

Render the component.

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

11.1

Arguments

$option

stringThe component option.

$params

arrayThe component parameters

Response

object

Properties

components

The component list cache

static
since

11.1

Type(s)

array