Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Updater - list of methods

Updater Class

Extends

Adapter
Package: Joomla\CMS\Updater
Copyright: (C) 2008 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Updater/Updater.php
Project: Joomla

Method Summary

public
__construct
(mixed $basepath = __DIR__, mixed $classprefix = '\\Joomla\\CMS\\Updater\\Adapter', mixed $adapterfolder = 'Adapter')

Constructor
Parameters
  • string $basepath Base Path of the adapters
  • string $classprefix Class prefix of adapters
  • string $adapterfolder Name of folder to append to base path
Since
  • 3.1
Show source code of this method: __construct Source Code

public static \Joomla\CMS\Updater\Updater
()

Returns a reference to the global Installer object, only creating it if it doesn't already exist.
Returns
  • \Joomla\CMS\Updater\Updater An installer object
Since
  • 1.7.0
Show source code of this method: getInstance Source Code

public bool
(mixed $eid = 0, mixed $cacheTimeout = 0, mixed $minimumStability = self::STABILITY_STABLE, mixed $includeCurrent = false)

Finds the update for an extension. Any discovered updates are stored in the #__updates table.
Parameters
  • int|array $eid Extension Identifier or list of Extension Identifiers; if zero use all sites
  • int $cacheTimeout How many seconds to cache update information; if zero, force reload the update information
  • int $minimumStability Minimum stability for the updates; 0=dev, 1=alpha, 2=beta, 3=rc, 4=stable
  • bool $includeCurrent Should I include the current version in the results?
Returns
  • bool True if there are updates
Since
  • 1.7.0
Show source code of this method: findUpdates Source Code

private array
(mixed $eid = 0)

Returns the update site records for an extension with ID $eid. If $eid is zero all enabled update sites records will be returned.
Parameters
  • int $eid The extension ID to fetch.
Returns
  • array
Since
  • 3.6.0
Show source code of this method: getUpdateSites Source Code

private array
(mixed $updateSite, mixed $minimumStability = self::STABILITY_STABLE, mixed $includeCurrent = false)

Loads the contents of an update site record $updateSite and returns the update objects
Parameters
  • array $updateSite The update site record to process
  • int $minimumStability Minimum stability for the returned update records
  • bool $includeCurrent Should I also include the current version?
Returns
  • array The update records. Empty array if no updates are found.
Since
  • 3.6.0
Show source code of this method: getUpdateObjectsForSite Source Code

private array
(mixed $timestamp = 0)

Returns the IDs of the update sites with cached updates
Parameters
  • int $timestamp Optional. If set, only update sites checked before $timestamp will be taken into account.
Returns
  • array The IDs of the update sites with cached updates
Since
  • 3.6.0
Show source code of this method: getSitesWithUpdates Source Code

private void
(mixed $updateSiteId)

Update the last check timestamp of an update site
Parameters
  • int $updateSiteId The update site ID to mark as just checked
Returns
  • void
Since
  • 3.6.0
Show source code of this method: updateLastCheckTimestamp Source Code

Properties Summary

protected static \Joomla\CMS\Updater\Updater
$instance
Updater instance container.
Since
  • 1.7.3

Constants Summary

public int
$STABILITY_DEV
Development snapshots, nightly builds, pre-release versions and so on
Since
  • 3.4
public int
$STABILITY_ALPHA
Alpha versions (work in progress, things are likely to be broken)
Since
  • 3.4
public int
$STABILITY_BETA
Beta versions (major functionality in place, show-stopper bugs are likely to be present)
Since
  • 3.4
public int
$STABILITY_RC
Release Candidate versions (almost stable, minor bugs might be present)
Since
  • 3.4
public int
$STABILITY_STABLE
Stable versions (production quality code)
Since
  • 3.4

Tags Summary

Since
1.7.0