InstallerExtension
Extends CMSObjectExtension object
| since |
3.1 |
|---|---|
| package |
Application |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed properties = null) : mixed
| since |
1.7.0 |
|---|
Arguments
- properties
mixedEither and associative array or another object to set the initial properties of the object.
Response
mixed
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
1.7.0 |
|---|---|
| deprecated |
3.1.4 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
def
Sets a default value if not already assigned
def(string property, mixed default = null) : mixed
| since |
1.7.0 |
|---|
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 |
1.7.0 |
|---|---|
| see | CMSObject::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(int i = null, bool toString = true) : string
| since |
1.7.0 |
|---|---|
| deprecated |
3.1.4 JError has been deprecated |
Arguments
- i
intOption error index.- toString
boolIndicates if Exception objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
1.7.0 |
|---|---|
| deprecated |
3.1.4 JError has been deprecated |
Response
arrayArray of error messages.
getProperties
Returns an associative array of object properties.
getProperties(bool public = true) : array
| since |
1.7.0 |
|---|---|
| see | CMSObject::get() |
Arguments
- public
boolIf true, returns only the public properties.
Response
array
set
Modifies a property of the object, creating it if it does not already exist.
set(string property, mixed value = null) : mixed
| since |
1.7.0 |
|---|
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 |
1.7.0 |
|---|---|
| deprecated |
3.1.4 JError has been deprecated |
Arguments
- error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed properties) : bool
| since |
1.7.0 |
|---|---|
| see | CMSObject::set() |
Arguments
- properties
mixedEither an associative array or another object.
Response
bool
Properties
client
String representation of client. Valid for modules, templates and languages.
group
The group name of the plugin. Not used for other known extension types (only plugins)
manifest_cache
An object representation of the manifest file stored metadata
_errors
An array of error messages or Exception objects.