LibraryHelper
Library helper class
| since |
3.2 |
|---|---|
| package |
Joomla CMS |
Methods
getLibrary
Get the library information.
getLibrary(string element, bool 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(string element, bool strict = false) : \Joomla\Registry\Registry
| see | \Joomla\Registry\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
\Joomla\Registry\RegistryA Registry object.
isEnabled
Checks if a library is enabled
isEnabled(string element) : bool
| 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(string element) : bool
| 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(string element, \Joomla\Registry\Registry params) : \Joomla\Registry\Registry|bool
| see | \Joomla\Registry\Registry |
|---|---|
| since |
3.2 |
Arguments
- element
stringElement of the library in the extensions table.- params
\Joomla\Registry\RegistryParams to save
Response
\Joomla\Registry\Registry|boolA Registry object.