Updater

Extends Adapter

Updater Class

since

1.7.0

package

Application

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed properties = null) : mixed
inherited
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
inherited deprecated
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
inherited
since

1.7.0

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixed

findUpdates

Finds the update for an extension. Any discovered updates are stored in the #__updates table.

findUpdates(int|array eid, int cacheTimeout, int minimumStability = self::STABILITY_STABLE, bool includeCurrent = false) : bool
since

1.7.0

Arguments

eid

int|arrayExtension Identifier or list of Extension Identifiers; if zero use all sites

cacheTimeout

intHow many seconds to cache update information; if zero, force reload the update information

minimumStability

intMinimum stability for the updates; 0=dev, 1=alpha, 2=beta, 3=rc, 4=stable

includeCurrent

boolShould I include the current version in the results?

Response

boolTrue if there are updates

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 CMSObject::getProperties()

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixedThe value of the property.

getAdapter

Return an adapter.

getAdapter(string name, array options = array()) : static|bool
inherited
since

1.6

Arguments

name

stringName of adapter to return

options

arrayAdapter options

Response

static|boolAdapter of type 'name' or false

getDbo

Get the database connector object

getDbo() : \Joomla\Database\DatabaseDriver
inherited
since

1.6

Response

\Joomla\Database\DatabaseDriverDatabase connector object

getError

Get the most recent error message.

getError(int i = null, bool toString = true) : string
inherited deprecated
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
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

getInstance

Returns a reference to the global Installer object, only creating it if it doesn't already exist.

getInstance() : \Joomla\CMS\Updater\Updater
static
since

1.7.0

Response

\Joomla\CMS\Updater\UpdaterAn installer object

getProperties

Returns an associative array of object properties.

getProperties(bool public = true) : array
inherited
since

1.7.0

see CMSObject::get()

Arguments

public

boolIf true, returns only the public properties.

Response

array

getSitesWithUpdates

Returns the IDs of the update sites with cached updates

getSitesWithUpdates(int timestamp) : array
since

3.6.0

Arguments

timestamp

intOptional. If set, only update sites checked before $timestamp will be taken into account.

Response

arrayThe IDs of the update sites with cached updates

getUpdateObjectsForSite

Loads the contents of an update site record $updateSite and returns the update objects

getUpdateObjectsForSite(array updateSite, int minimumStability = self::STABILITY_STABLE, bool includeCurrent = false) : array
since

3.6.0

Arguments

updateSite

arrayThe update site record to process

minimumStability

intMinimum stability for the returned update records

includeCurrent

boolShould I also include the current version?

Response

arrayThe update records. Empty array if no updates are found.

getUpdateSites

Returns the update site records for an extension with ID $eid. If $eid is zero all enabled update sites records will be returned.

getUpdateSites(int eid) : array
since

3.6.0

Arguments

eid

intThe extension ID to fetch.

Response

array

loadAllAdapters

Loads all adapters.

loadAllAdapters(array options = array()) : void
inherited
since

1.6

Arguments

options

arrayAdapter options

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.

setAdapter

Set an adapter by name

setAdapter(string name, object &adapter = null, array options = array()) : bool
inherited
since

1.6

Arguments

name

stringAdapter name

adapter

objectAdapter object

options

arrayAdapter options

Response

boolTrue if successful

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) : bool
inherited
since

1.7.0

see CMSObject::set()

Arguments

properties

mixedEither an associative array or another object.

Response

bool

updateLastCheckTimestamp

Update the last check timestamp of an update site

updateLastCheckTimestamp(int updateSiteId) : void
since

3.6.0

Arguments

updateSiteId

intThe update site ID to mark as just checked

Constants

STABILITY_DEV

Development snapshots, nightly builds, pre-release versions and so on

Value 0
since

3.4

Type(s)

int

STABILITY_ALPHA

Alpha versions (work in progress, things are likely to be broken)

Value 1
since

3.4

Type(s)

int

STABILITY_BETA

Beta versions (major functionality in place, show-stopper bugs are likely to be present)

Value 2
since

3.4

Type(s)

int

STABILITY_RC

Release Candidate versions (almost stable, minor bugs might be present)

Value 3
since

3.4

Type(s)

int

STABILITY_STABLE

Stable versions (production quality code)

Value 4
since

3.4

Type(s)

int

Properties

instance

Updater instance container.

static
since

1.7.3

Type(s)

Updater

_adapters

Associative array of adapters

inherited
since

1.6

Type(s)

static[]

_adapterfolder

Adapter Folder

inherited
since

1.6

Type(s)

string

_classprefix

Adapter Class Prefix

inherited
since

1.6

Type(s)

string

_basepath

Base Path for the adapter instance

inherited
since

1.6

Type(s)

string

_db

Database Connector Object

inherited
since

1.6

Type(s)

\Joomla\Database\DatabaseDriver

_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