LibraryHelper
Library helper class
| since |
3.2 |
|---|---|
| package |
Joomla CMS |
Methods
getLibrary
Get the library information.
getLibrary( element, strict = false) : \stdClass
| since |
3.2 |
|---|
Arguments
- element
stringElement of the library in the extensions table.- strict
boolIf 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( element, strict = false) : \Joomla\Registry\Registry
| see | Registry |
|---|---|
| since |
3.2 |
Arguments
- element
stringElement of the library in the extensions table.- strict
boolIf set and the library does not exist, false will be returned
Response
RegistryA Registry object.
isEnabled
Checks if a library is enabled
isEnabled( element) :
| since |
3.2 |
|---|
Arguments
- element
stringElement of the library in the extensions table.
Response
bool
loadLibrary
Load the installed library into the libraries property.
loadLibrary( element) :
| since |
3.7.0 |
|---|
Arguments
- element
stringThe element value for the extension
Response
boolTrue on success
saveParams
Save the parameters object for the library
saveParams( element, \Joomla\Registry\Registry params) : \Joomla\Registry\Registry|bool
| see | Registry |
|---|---|
| since |
3.2 |
Arguments
- element
stringElement of the library in the extensions table.- params
RegistryParams to save
Response
Registry|boolA Registry object.
Properties
libraries
The component list cache
| since |
3.2 |
|---|
Type(s)
array<string|int, mixed>