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 |
Joomla CMS |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct( properties = null) :
since |
1.7.0 |
---|
Arguments
- properties
mixed
Either 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() :
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Classes should provide their own __toString() implementation. |
Response
string
The classname.
_characterData
Character Parser Function
_characterData( parser, data) :
note |
This is public because its called externally. |
---|---|
since |
1.7.0 |
Arguments
- parser
object
Parser object.- data
object
The data.
Response
void
_endElement
Callback for closing the element
_endElement( parser, name) :
note |
This is public because it is called externally |
---|---|
since |
1.7.0 |
Arguments
- parser
object
Parser object- name
string
Name of element that was closed
Response
void
_getLastTag
Get the last position in stack count
_getLastTag() :
since |
1.7.0 |
---|
Response
string
_getStackLocation
Gets the reference to the current direct parent
_getStackLocation() :
since |
1.7.0 |
---|
Response
string
_startElement
XML Start Element callback
_startElement( parser, name, mixed||string|int attrs = []) :
note |
This is public because it is called externally |
---|---|
since |
1.7.0 |
Arguments
- parser
object
Parser object- name
string
Name of the tag found- attrs
array<string|int, mixed>
Attributes of the tag
Response
void
def
Sets a default value if not already assigned
def( property, default = null) :
since |
1.7.0 |
---|---|
deprecated |
4.3.0 will be removed in 6.0 Defining dynamic properties should not be used anymore |
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get( property, default = null) :
since |
1.7.0 |
---|---|
see | CMSObject::getProperties() |
deprecated |
4.3.0 will be removed in 6.0 Create a proper getter function for the property |
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError( i = null, toString = true) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError |
Arguments
- i
int
Option error index.- toString
bool
Indicates if Exception objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : mixed||string|int
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors |
Response
array<string|int, mixed>
Array of error messages.
getProperties
Returns an associative array of object properties.
getProperties( public = true) : mixed||string|int
since |
1.7.0 |
---|---|
see | CMSObject::get() |
deprecated |
4.3.0 will be removed in 6.0 Create a proper getter function for the property |
Arguments
- public
bool
If true, returns only the public properties.
Response
array<string|int, mixed>
loadFromXml
Loads an XML file from a URL.
loadFromXml( url, minimumStability = Updater::STABILITY_STABLE) :
since |
1.7.0 |
---|
Arguments
- url
string
The URL.- minimumStability
int
The minimum stability required for updating the extension {@see \Joomla\CMS\Updater\Updater}
Response
bool
True on success
set
Modifies a property of the object, creating it if it does not already exist.
set( property, value = null) :
since |
1.7.0 |
---|---|
deprecated |
4.3.0 will be removed in 6.0 Create a proper setter function for the property |
Arguments
- property
string
The name of the property.- value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError( error) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError |
Arguments
- error
string
Error message.
Response
void
setProperties
Set the object properties based on a named array/hash.
setProperties( properties) :
since |
1.7.0 |
---|---|
see | CMSObject::set() |
deprecated |
4.3.0 will be removed in 6.0 Create a proper setter function for the property |
Arguments
- properties
mixed
Either 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( tag) :
since |
3.4 |
---|
Arguments
- tag
string
The tag string, e.g. dev, alpha, beta, rc, stable
Response
int
Properties
_errors
An array of error messages or Exception objects.
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Type(s)
array<string|int, mixed>
name
Update manifest <name>
element
since |
1.7.0 |
---|
Type(s)
string
description
Update manifest <description>
element
since |
1.7.0 |
---|
Type(s)
string
element
Update manifest <element>
element
since |
1.7.0 |
---|
Type(s)
string
type
Update manifest <type>
element
since |
1.7.0 |
---|
Type(s)
string
version
Update manifest <version>
element
since |
1.7.0 |
---|
Type(s)
string
infourl
Update manifest <infourl>
element
since |
1.7.0 |
---|
Type(s)
string
client
Update manifest <client>
element
since |
1.7.0 |
---|
Type(s)
string
group
Update manifest <group>
element
since |
1.7.0 |
---|
Type(s)
string
downloads
Update manifest <downloads>
element
since |
1.7.0 |
---|
Type(s)
string
downloadSources
Update manifest <downloadsource>
elements
tags
Update manifest <tags>
element
since |
1.7.0 |
---|
Type(s)
string
maintainer
Update manifest <maintainer>
element
since |
1.7.0 |
---|
Type(s)
string
maintainerurl
Update manifest <maintainerurl>
element
since |
1.7.0 |
---|
Type(s)
string
category
Update manifest <category>
element
since |
1.7.0 |
---|
Type(s)
string
relationships
Update manifest <relationships>
element
since |
1.7.0 |
---|
Type(s)
string
targetplatform
Update manifest <targetplatform>
element
since |
1.7.0 |
---|
Type(s)
string
extra_query
Extra query for download URLs
since |
3.2.0 |
---|
Type(s)
string
xmlParser
Resource handle for the XML Parser
since |
3.0.0 |
---|
Type(s)
resource
stack
Element call stack
since |
3.0.0 |
---|
Type(s)
array<string|int, mixed>
stateStore
Unused state array
since |
3.0.0 |
---|
Type(s)
array<string|int, mixed>
currentUpdate
Object containing the current update data
since |
3.0.0 |
---|
Type(s)
stdClass
latest
Object containing the latest update data which meets the PHP and DB version requirements
since |
3.0.0 |
---|
Type(s)
stdClass
otherUpdateInfo
Object containing details if the latest update does not meet the PHP and DB version requirements
since |
4.4.2 |
---|
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
since |
3.10.2 |
---|
Type(s)
array<string|int, mixed>