Update
Extends \JObjectUpdate class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.
| since |
1.7.0 |
|---|
Methods
_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() : object
| since |
1.7.0 |
|---|
Response
object
_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
loadFromXml
Loads an XML file from a URL.
loadFromXml(string $url, integer $minimumStability = \Joomla\CMS\Updater\Updater::STABILITY_STABLE) : boolean
| since |
1.7.0 |
|---|
Arguments
- $url
stringThe URL.- $minimumStability
integerThe minimum stability required for updating the extension {@see Updater}
Response
booleanTrue on success
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) : integer
| since |
3.4 |
|---|
Arguments
- $tag
stringThe tag string, e.g. dev, alpha, beta, rc, stable
Response
integer
Properties
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
stateStore
Unused state array
| since |
3.0.0 |
|---|
Type(s)
array
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
| since |
3.10.2 |
|---|
Type(s)
array