Update
Extends CMSObjectUpdate class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.
| since |
1.7.0 |
|---|---|
| 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.
_characterData
Character Parser Function
_characterData(object parser, object data) : void
| note |
This is public because its called externally. |
|---|---|
| since |
1.7.0 |
Arguments
- parser
objectParser object.- data
objectThe data.
_endElement
Callback for closing the element
_endElement(object parser, string name) : void
| note |
This is public because it is called externally |
|---|---|
| since |
1.7.0 |
Arguments
- parser
objectParser object- name
stringName of element that was closed
_getLastTag
Get the last position in stack count
_getLastTag() : string
| since |
1.7.0 |
|---|
Response
string
_getStackLocation
Gets the reference to the current direct parent
_getStackLocation() : string
| since |
1.7.0 |
|---|
Response
string
_startElement
XML Start Element callback
_startElement(object parser, string name, array attrs = array()) : void
| note |
This is public because it is called externally |
|---|---|
| since |
1.7.0 |
Arguments
- parser
objectParser object- name
stringName of the tag found- attrs
arrayAttributes of the tag
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
loadFromXml
Loads an XML file from a URL.
loadFromXml(string url, int minimumStability = Updater::STABILITY_STABLE) : bool
| since |
1.7.0 |
|---|
Arguments
- url
stringThe URL.- minimumStability
intThe minimum stability required for updating the extension {@see}
Response
boolTrue on success
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
stabilityTagToInteger
Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of dev, alpha, beta, rc, stable) it is ignored.
stabilityTagToInteger(string tag) : int
| since |
3.4 |
|---|
Arguments
- tag
stringThe tag string, e.g. dev, alpha, beta, rc, stable
Response
int
Properties
currentUpdate
Object containing the current update data
| since |
3.0.0 |
|---|
Type(s)
\stdClass
latest
Object containing the latest update data
| since |
3.0.0 |
|---|
Type(s)
\stdClass
minimum_stability
The minimum stability required for updates to be taken into account. The possible values are: 0 dev Development snapshots, nightly builds, pre-release versions and so on 1 alpha Alpha versions (work in progress, things are likely to be broken) 2 beta Beta versions (major functionality in place, show-stopper bugs are likely to be present) 3 rc Release Candidate versions (almost stable, minor bugs might be present) 4 stable Stable versions (production quality code)
compatibleVersions
Array with compatible versions used by the pre-update check
_errors
An array of error messages or Exception objects.