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
string
Element of the library in the extensions table.- strict
bool
If set and the library does not exist, the enabled attribute will be set to false.
Response
stdClass
An 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
string
Element of the library in the extensions table.- strict
bool
If set and the library does not exist, false will be returned
Response
Registry
A Registry object.
isEnabled
Checks if a library is enabled
isEnabled( element) :
since |
3.2 |
---|
Arguments
- element
string
Element 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
string
The element value for the extension
Response
bool
True 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
string
Element of the library in the extensions table.- params
Registry
Params to save
Response
Registry|bool
A Registry object.
Properties
libraries
The component list cache
since |
3.2 |
---|
Type(s)
array<string|int, mixed>