Updater
Implements DatabaseAwareInterfaceUpdater Class
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct( basepath = __DIR__, classprefix = 'JoomlaCMSUpdaterAdapter', adapterfolder = 'Adapter') :
| 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
def
Sets a default value if not already assigned
def( property, default = null) :
| since |
1.7.0 |
|---|---|
| deprecated |
4.3.0 will be removed in 7.0 Defining dynamic properties should not be used anymore |
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, cacheTimeout, minimumStability = self::STABILITY_STABLE, includeCurrent = false) :
| since |
1.7.0 |
|---|
Arguments
- eid
int|array<string|int, mixed>Extension 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( property, default = null) :
| since |
1.7.0 |
|---|---|
| see | CMSObject::getProperties() |
| deprecated |
4.3.0 will be removed in 7.0 Create a proper getter function for the property |
Arguments
- property
stringThe name of the property.- default
mixedThe default value.
Response
mixedThe value of the property.
getAdapter
Get an update adapter instance
getAdapter( name, mixed||string|int options = []) : \Joomla\CMS\Updater\UpdateAdapter
| throws |
|
|---|---|
| since |
6.0.0 |
Arguments
- name
stringAdapter name- options
array<string|int, mixed>Adapter options
Response
getAdapters
Gets a list of available update adapters.
getAdapters(mixed||string|int options = [], mixed||string|int custom = []) : string||string|int
| since |
3.4 |
|---|
Arguments
- options
array<string|int, mixed>An array of options to inject into the adapter- custom
array<string|int, mixed>Array of custom update adapters
Response
array<string|int, string>An array of the class names of available install adapters.
getAvailableUpdates
Returns available updates
getAvailableUpdates( eid, minimumStability = self::STABILITY_STABLE) : mixed||string|int
Arguments
- eid
int- minimumStability
string
Response
array<string|int, mixed>
getInstance
Returns a reference to the global Installer object, only creating it if it doesn't already exist.
getInstance() : \Joomla\CMS\Updater\Updater
getProperties
Returns an associative array of object properties.
getProperties( public = true) : mixed||string|int
| since |
1.7.0 |
|---|---|
| see | CMSObject::get() |
| deprecated |
4.3.0 will be removed in 7.0 Create a proper getter function for the property |
Arguments
- public
boolIf true, returns only the public properties.
Response
array<string|int, mixed>
getSitesWithUpdates
Returns the IDs of the update sites with cached updates
getSitesWithUpdates( timestamp) : mixed||string|int
| since |
3.6.0 |
|---|
Arguments
- timestamp
intOptional. If set, only update sites checked before $timestamp will be taken into account.
Response
array<string|int, mixed>The IDs of the update sites with cached updates
getUpdateObjectsForSite
Loads the contents of an update site record $updateSite and returns the update objects
getUpdateObjectsForSite(mixed||string|int updateSite, minimumStability = self::STABILITY_STABLE, includeCurrent = false) : mixed||string|int
| since |
3.6.0 |
|---|
Arguments
- updateSite
array<string|int, mixed>The update site record to process- minimumStability
intMinimum stability for the returned update records- includeCurrent
boolShould I also include the current version?
Response
array<string|int, mixed>The 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( eid) : mixed||string|int
| since |
3.6.0 |
|---|
Arguments
- eid
intThe extension ID to fetch.
Response
array<string|int, mixed>
loadAdapters
Discover all adapters in the adapterfolder path
loadAdapters() :
| since |
6.0.0 |
|---|
Response
void
set
Modifies a property of the object, creating it if it does not already exist.
set( property, value = null) :
| since |
1.7.0 |
|---|---|
| deprecated |
4.3.0 will be removed in 7.0 Create a proper setter function for the property |
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( name, \Joomla\CMS\Updater\UpdateAdapter|string adapter) :
| since |
6.0.0 |
|---|
Arguments
- name
stringAdapter name- adapter
UpdateAdapter|stringAdapter object or class name
Response
boolTrue if successful
setProperties
Set the object properties based on a named array/hash.
setProperties( properties) :
| since |
1.7.0 |
|---|---|
| see | CMSObject::set() |
| deprecated |
4.3.0 will be removed in 7.0 Create a proper setter function for the property |
Arguments
- properties
mixedEither an associative array or another object.
Response
bool
updateLastCheckTimestamp
Update the last check timestamp of an update site
updateLastCheckTimestamp( updateSiteId) :
| since |
3.6.0 |
|---|
Arguments
- updateSiteId
intThe update site ID to mark as just checked
Response
void
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
adapters
Array of installer adapters
classprefix
Adapter Class Prefix
| since |
6.0.0 |
|---|
Type(s)
string
adapterfolder
Base Path for the installer adapters
| since |
6.0.0 |
|---|
Type(s)
string