JInstallerComponent
Extends \JAdapterInstanceComponent installer
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Installer |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
_buildAdminMenus
Method to build menu database entries for a component
_buildAdminMenus() : boolean
| since |
11.1 |
|---|
Response
booleanTrue if successful
_removeAdminMenus
Method to remove admin menu references to a component
_removeAdminMenus( &$row) : boolean
| since |
11.1 |
|---|
Arguments
- $row
Response
booleanTrue if successful.
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
discover
Discover unregistered extensions.
discover() : array
| since |
11.1 |
|---|
Response
arrayA list of extensions.
discover_install
Install unregistered extensions that have been discovered.
discover_install() : mixed
| since |
11.1 |
|---|
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getParent
Retrieves the parent object
getParent() : object
| since |
11.1 |
|---|
Response
objectparent
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
install
Custom install method for components
install() : boolean
| since |
11.1 |
|---|
Response
booleanTrue on success
loadLanguage
Custom loadLanguage method
loadLanguage(string $path = null) : void
| since |
11.1 |
|---|
Arguments
- $path
stringThe path language files are on.
refreshManifestCache
Refreshes the extension table cache
refreshManifestCache() : boolean
| since |
11.1 |
|---|
Response
booleanResult of operation, true if updated, false on failure
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
uninstall
Custom uninstall method for components
uninstall(integer $id) : mixed
| since |
11.1 |
|---|
Arguments
- $id
integerThe unique extension id of the component to uninstall
Response
mixedReturn value for uninstall method in component uninstall file
update
Custom update method for components
update() : boolean
| since |
11.1 |
|---|
Response
booleanTrue on success
Properties
manifest
Copy of the XML manifest file
| since |
11.1 |
|---|
Type(s)
string
name
Name of the extension
| since |
11.1 |
|---|
Type(s)
string
element
The unique identifier for the extension (e.g. mod_login)
| since |
11.1 |
|---|
Type(s)
string
oldAdminFiles
The list of current files fo the Joomla! CMS administrator that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.
| since |
11.1 |
|---|
Type(s)
array
oldFiles
The list of current files that are installed and is read from the manifest on disk in the update area to handle doing a diff and deleting files that are in the old files list and not in the new files list.
| since |
11.1 |
|---|
Type(s)
array
manifest_script
A path to the PHP file that the scriptfile declaration in the manifest refers to.
| since |
11.1 |
|---|
Type(s)
string
install_script
For legacy installations this is a path to the PHP file that the scriptfile declaration in the manifest refers to.
| since |
11.1 |
|---|
Type(s)
string
_errors
An array of error messages or Exception objects.