LibraryHelper

Library helper class

since

3.2

Methods

_load

Load the installed library into the libraries property.

_load(string $element) : boolean
static deprecated
since

3.2

deprecated

4.0 Use LibraryHelper::loadLibrary() instead

Arguments

$element

stringThe element value for the extension

Response

booleanTrue on success

getLibrary

Get the library information.

getLibrary(string $element, boolean $strict = false) : \stdClass
static
since

3.2

Arguments

$element

stringElement of the library in the extensions table.

$strict

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

Response

\stdClassAn object with the library's information.

getParams

Gets the parameter object for the library

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

3.2

Arguments

$element

stringElement of the library in the extensions table.

$strict

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

Response

\Joomla\Registry\RegistryA Registry object.

isEnabled

Checks if a library is enabled

isEnabled(string $element) : boolean
static
since

3.2

Arguments

$element

stringElement of the library in the extensions table.

Response

boolean

loadLibrary

Load the installed library into the libraries property.

loadLibrary(string $element) : boolean
static
since

3.7.0

Arguments

$element

stringThe element value for the extension

Response

booleanTrue on success

saveParams

Save the parameters object for the library

saveParams(string $element, \Joomla\Registry\Registry $params) : \Joomla\Registry\Registry
static
see \Joomla\CMS\Helper\Registry
since

3.2

Arguments

$element

stringElement of the library in the extensions table.

$params

\Joomla\Registry\RegistryParams to save

Response

\Joomla\Registry\RegistryA Registry object.

Properties

libraries

The component list cache

static
since

3.2

Type(s)

array