JInstallerPackage
Extends \JAdapterInstancePackage 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.
_getExtensionID
Gets the extension id.
_getExtensionID(string $type, string $id, integer $client, string $group) : integer
| since |
11.1 |
|---|
Arguments
- $type
stringThe extension type.- $id
stringThe name of the extension (the element field).- $client
integerThe application id (0: Joomla CMS site; 1: Joomla CMS administrator).- $group
stringThe extension group (mainly for plugins).
Response
integer
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
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
install() : integer
| since |
11.1 |
|---|
Response
integerThe extension id
loadLanguage
Load language from a path
loadLanguage(string $path) : void
| since |
11.1 |
|---|
Arguments
- $path
stringThe path of the language.
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
uninstall(integer $id) : boolean
| since |
11.1 |
|---|
Arguments
- $id
integerThe id of the package to uninstall.
Response
booleanTrue on success
update
Updates a package
update() : void
The only difference between an update and a full install is how we handle the database
| since |
11.1 |
|---|
Properties
route
Method of system
| since |
11.1 |
|---|
Type(s)
string
_errors
An array of error messages or Exception objects.