Update

Extends \Joomla\CMS\Object\CMSObject

Update class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for an extension.

This class allows for simple but smart objects with get and set methods and an internal error handler.

since

1.7.0

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

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
inherited deprecated
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
inherited
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
inherited
since

1.7.0

see \Joomla\CMS\Object\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(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
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(boolean $public = true) : array
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

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

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
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
inherited deprecated
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) : boolean
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

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

since

3.8.3

Type(s)

array<mixed,\Joomla\CMS\Updater\DownloadSource>

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)

since

14.1

see \Joomla\CMS\Updater\Updater

Type(s)

integer

compatibleVersions

Array with compatible versions used by the pre-update check

since

3.10.2

Type(s)

array

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Type(s)

array