Updater
Extends AdapterUpdater Class
since |
1.7.0 |
---|---|
package |
Joomla CMS |
Methods
__construct
Constructor
__construct( basepath = __DIR__, classprefix = '\Joomla\CMS\Updater\Adapter', adapterfolder = 'Adapter') :
since |
3.1 |
---|
Arguments
- basepath
string
Base Path of the adapters- classprefix
string
Class prefix of adapters- adapterfolder
string
Name of folder to append to base path
Response
mixed
__toString
Magic method to convert the object to a string gracefully.
__toString() :
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Classes should provide their own __toString() implementation. |
Response
string
The classname.
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 6.0 Defining dynamic properties should not be used anymore |
Arguments
- property
string
The name of the property.- default
mixed
The 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
int
How many seconds to cache update information; if zero, force reload the update information- minimumStability
int
Minimum stability for the updates; 0=dev, 1=alpha, 2=beta, 3=rc, 4=stable- includeCurrent
bool
Should I include the current version in the results?
Response
bool
True 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 6.0 Create a proper getter function for the property |
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
The value of the property.
getAdapter
Return an adapter.
getAdapter( name, mixed||string|int options = []) : static|bool
since |
1.6 |
---|
Arguments
- name
string
Name of adapter to return- options
array<string|int, mixed>
Adapter options
Response
static|bool
Adapter of type 'name' or false
getDbo
Get the database connector object
getDbo() : \Joomla\Database\DatabaseDriver
since |
1.6 |
---|
Response
DatabaseDriver
Database connector object
getError
Get the most recent error message.
getError( i = null, toString = true) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError |
Arguments
- i
int
Option error index.- toString
bool
Indicates if Exception objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : mixed||string|int
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors |
Response
array<string|int, mixed>
Array 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
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 6.0 Create a proper getter function for the property |
Arguments
- public
bool
If 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
int
Optional. 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
int
Minimum stability for the returned update records- includeCurrent
bool
Should 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
int
The extension ID to fetch.
Response
array<string|int, mixed>
loadAllAdapters
Loads all adapters.
loadAllAdapters(mixed||string|int options = []) :
since |
1.6 |
---|
Arguments
- options
array<string|int, mixed>
Adapter options
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 6.0 Create a proper setter function for the property |
Arguments
- property
string
The name of the property.- value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setAdapter
Set an adapter by name
setAdapter( name, &adapter = null, mixed||string|int options = []) :
since |
1.6 |
---|
Arguments
- name
string
Adapter name- adapter
object
Adapter object- options
array<string|int, mixed>
Adapter options
Response
bool
True if successful
setError
Add an error message.
setError( error) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError |
Arguments
- error
string
Error message.
Response
void
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 6.0 Create a proper setter function for the property |
Arguments
- properties
mixed
Either 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
int
The 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
_errors
An array of error messages or Exception objects.
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Type(s)
array<string|int, mixed>
_adapters
Associative array of adapters
since |
1.6 |
---|
Type(s)
array<string|int, static>
_adapterfolder
Adapter Folder
since |
1.6 |
---|
Type(s)
string
_classprefix
Adapter Class Prefix
since |
1.6 |
---|
Type(s)
string
_basepath
Base Path for the adapter instance
since |
1.6 |
---|
Type(s)
string
_db
Database Connector Object
since |
1.6 |
---|
Type(s)
DatabaseDriver