LibraryHelper
Library helper class
since |
3.2 |
---|
Methods
_load
Load the installed library into the libraries property.
_load(string $element) : boolean
since |
3.2 |
---|---|
deprecated |
4.0 Use LibraryHelper::loadLibrary() instead |
Arguments
- $element
string
The element value for the extension
Response
boolean
True on success
getLibrary
Get the library information.
getLibrary(string $element, boolean $strict = false) : \stdClass
since |
3.2 |
---|
Arguments
- $element
string
Element of the library in the extensions table.- $strict
boolean
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(string $element, boolean $strict = false) : \Joomla\Registry\Registry
see | \Joomla\Registry\Registry |
---|---|
since |
3.2 |
Arguments
- $element
string
Element of the library in the extensions table.- $strict
boolean
If set and the library does not exist, false will be returned
Response
\Joomla\Registry\Registry
A Registry object.
isEnabled
Checks if a library is enabled
isEnabled(string $element) : boolean
since |
3.2 |
---|
Arguments
- $element
string
Element of the library in the extensions table.
Response
boolean
loadLibrary
Load the installed library into the libraries property.
loadLibrary(string $element) : boolean
since |
3.7.0 |
---|
Arguments
- $element
string
The element value for the extension
Response
boolean
True on success
saveParams
Save the parameters object for the library
saveParams(string $element, \Joomla\Registry\Registry $params) : \Joomla\Registry\Registry
see | \Joomla\Registry\Registry |
---|---|
since |
3.2 |
Arguments
- $element
string
Element of the library in the extensions table.- $params
\Joomla\Registry\Registry
Params to save
Response
\Joomla\Registry\Registry
A Registry object.
Properties
libraries
The component list cache
since |
3.2 |
---|
Type(s)
array