Updater

Extends \JAdapter

Updater Class

since

1.7.0

Methods

__construct

Constructor

__construct(string $basepath, string $classprefix = null, string $adapterfolder = null) 
inherited
since

1.6

Arguments

$basepath

stringBase Path of the adapters

$classprefix

stringClass prefix of adapters

$adapterfolder

stringName of folder to append to base path

findUpdates

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

findUpdates(integer|array $eid, integer $cacheTimeout, integer $minimum_stability = self::STABILITY_STABLE, boolean $includeCurrent = false) : boolean
since

1.7.0

Arguments

$eid

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

$cacheTimeout

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

$minimum_stability

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

$includeCurrent

booleanShould I include the current version in the results?

Response

booleanTrue if there are updates

getAdapter

Return an adapter.

getAdapter(string $name, array $options = array()) : \JAdapterInstance|boolean
inherited
since

1.6

Arguments

$name

stringName of adapter to return

$options

arrayAdapter options

Response

\JAdapterInstance|booleanAdapter of type 'name' or false

getDbo

Get the database connector object

getDbo() : \JDatabaseDriver
inherited
since

1.6

Response

\JDatabaseDriverDatabase connector object

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

getSitesWithUpdates

Returns the IDs of the update sites with cached updates

getSitesWithUpdates(integer $timestamp) : array
since

3.6.0

Arguments

$timestamp

integerOptional. 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, integer $minimum_stability = self::STABILITY_STABLE, boolean $includeCurrent = false) : array
since

3.6.0

Arguments

$updateSite

arrayThe update site record to process

$minimum_stability

integerMinimum stability for the returned update records

$includeCurrent

booleanShould 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(integer $eid) : array
since

3.6.0

Arguments

$eid

integerThe extension ID to fetch.

Response

array

loadAllAdapters

Loads all adapters.

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

1.6

Arguments

$options

arrayAdapter options

setAdapter

Set an adapter by name

setAdapter(string $name,  &$adapter = null, array $options = array()) : boolean
inherited
since

1.6

Arguments

$name

stringAdapter name

$adapter

$options

arrayAdapter options

Response

booleanTrue if successful

update

Finds an update for an extension

update(integer $id) : mixed
deprecated
since

3.6.0

deprecated

4.0 No replacement.

Arguments

$id

integerId of the extension

Response

mixed

updateLastCheckTimestamp

Update the last check timestamp of an update site

updateLastCheckTimestamp(integer $updateSiteId) : void
since

3.6.0

Arguments

$updateSiteId

integerThe update site ID to mark as just checked

Constants

STABILITY_DEV

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

const

integer

since

3.4

STABILITY_ALPHA

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

const

integer

since

3.4

STABILITY_BETA

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

const

integer

since

3.4

STABILITY_RC

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

const

integer

since

3.4

STABILITY_STABLE

Stable versions (production quality code)

const

integer

since

3.4

Properties

instance

Updater instance container.

static
since

1.7.3

Type(s)

\Joomla\CMS\Updater\Updater

_adapters

Associative array of adapters

inherited
since

1.6

Type(s)

array<mixed,\JAdapterInstance>

_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)

\JDatabaseDriver