UpdateAdapter
Extends AdapterInstanceUpdateAdapter class.
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct(\Joomla\CMS\Adapter\Adapter parent, \Joomla\Database\DatabaseDriver db, mixed||string|int options = []) :
| since |
1.6 |
|---|
Arguments
- parent
AdapterParent object- db
DatabaseDriverDatabase object- options
array<string|int, mixed>Configuration Options
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
stringThe classname.
_getLastTag
Gets the reference to the last tag
_getLastTag() :
| since |
1.7.0 |
|---|
Response
object
_getStackLocation
Gets the reference to the current direct parent
_getStackLocation() :
| since |
1.7.0 |
|---|
Response
string
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
stringThe name of the property.- default
mixedThe default value.
Response
mixed
findUpdate
Finds an update
findUpdate(mixed||string|int options) : mixed||string|int
| since |
1.7.0 |
|---|
Arguments
- options
array<string|int, mixed>Options to use: update_site_id: the unique ID of the update site to look at
Response
array<string|int, mixed>Update_sites and updates discovered
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
stringThe name of the property.- default
mixedThe default value.
Response
mixedThe value of the property.
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
intOption error index.- toString
boolIndicates if Exception objects should return their error message.
Response
stringError 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.
getParent
Retrieves the parent object
getParent() : \Joomla\CMS\Adapter\Adapter
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
boolIf true, returns only the public properties.
Response
array<string|int, mixed>
getUpdateSiteName
Get the name of an update site. This is used in logging.
getUpdateSiteName( updateSiteId) :
Arguments
- updateSiteId
intThe numeric ID of the update site
Response
stringThe name of the update site or an empty string if it's not found
getUpdateSiteResponse
Try to get the raw HTTP response from the update site, hopefully containing the update XML.
getUpdateSiteResponse(mixed||string|int options = []) : \Joomla\CMS\Http\Response|bool
| throws |
|
|---|
Arguments
- options
array<string|int, mixed>The update options, see findUpdate() in children classes
Response
Response|boolFalse if we can't connect to the site, HTTP Response object otherwise
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
stringThe name of the property.- value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
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
stringError 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
mixedEither an associative array or another object.
Response
bool
toggleUpdateSite
Toggles the enabled status of an update site. Update sites are disabled before getting the update information from their URL and enabled afterwards. If the URL fetch fails with a PHP fatal error (e.g. timeout) the faulty update site will remain disabled the next time we attempt to load the update information.
toggleUpdateSite( updateSiteId, enabled = true) :
Arguments
- updateSiteId
intThe numeric ID of the update site to enable/disable- enabled
boolEnable the site when true, disable it when false
Response
void
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>
db
Database
| since |
1.6 |
|---|
Type(s)
DatabaseDriver
xmlParser
Resource handle for the XML Parser
| since |
3.0.0 |
|---|
Type(s)
resource
stack
Element call stack
| since |
3.0.0 |
|---|
Type(s)
array<string|int, mixed>
updateSiteId
ID of update site
| since |
3.0.0 |
|---|
Type(s)
int
updatecols
Columns in the extensions table to be updated
| since |
3.0.0 |
|---|
Type(s)
array<string|int, mixed>
appendExtension
Should we try appending a .xml extension to the update site's URL?
Type(s)
bool
updateSiteName
The name of the update site (used in logging)
Type(s)
string
_url
The update site URL from which we will get the update information
Type(s)
string
minimum_stability
The minimum stability required for updates to be taken into account. The possible values are: 0 dev Development snapshots, nightly builds, pre-release versions and so on 1 alpha Alpha versions (work in progress, things are likely to be broken) 2 beta Beta versions (major functionality in place, show-stopper bugs are likely to be present) 3 rc Release Candidate versions (almost stable, minor bugs might be present) 4 stable Stable versions (production quality code)