Updater
Extends JAdapterUpdater Class
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct(string basepath = __DIR__, string classprefix = '\Joomla\CMS\Updater\Adapter', string adapterfolder = 'Adapter') : mixed
| since |
3.1 |
|---|
Arguments
- basepath
stringBase Path of the adapters- classprefix
stringClass prefix of adapters- adapterfolder
stringName of folder to append to base path
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
getInstance
Returns a reference to the global Installer object, only creating it if it doesn't already exist.
getInstance() : \Joomla\CMS\Updater\Updater
| since |
1.7.0 |
|---|
Response
\Joomla\CMS\Updater\UpdaterAn installer object
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
update
Finds an update for an extension
update(int id) : mixed
| since |
3.6.0 |
|---|---|
| deprecated |
4.0 No replacement. |
Arguments
- id
intId of the extension
Response
mixed
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.
| since |
1.7.3 |
|---|
Type(s)
\Joomla\CMS\Updater\Updater