CollectionAdapter

Extends \Joomla\CMS\Updater\UpdateAdapter

Collection Update Adapter Class

since

1.7.0

Methods

__construct

Constructor

__construct(\JAdapter $parent, \JDatabaseDriver $db, array $options = array()) 
inherited
since

1.6

Arguments

$parent

\JAdapterParent object

$db

\JDatabaseDriverDatabase object

$options

arrayConfiguration Options

_endElement

Closing an XML element Note: This is a protected function though has to be exposed externally as a callback

_endElement(object $parser, string $name) : void
since

1.7.0

Arguments

$parser

objectParser object

$name

stringName of the element closing

_getLastTag

Gets the reference to the last tag

_getLastTag() : object
inherited
since

1.7.0

Response

object

_getParent

Get the parent tag

_getParent() : string
since

1.7.0

Response

stringparent

_getStackLocation

Gets the reference to the current direct parent

_getStackLocation() : object
inherited
since

1.7.0

Response

object

_startElement

Opening an XML element

_startElement(object $parser, string $name, array $attrs = array()) : void
since

1.7.0

Arguments

$parser

objectParser object

$name

stringName of element that is opened

$attrs

arrayArray of attributes for the element

findUpdate

Finds an update

findUpdate(array $options) : array
inherited abstract
since

1.7.0

Arguments

$options

arrayOptions to use: update_site_id: the unique ID of the update site to look at

Response

arrayUpdate_sites and updates discovered

getParent

Retrieves the parent object

getParent() : \JAdapter
inherited
since

1.6

Response

\JAdapter

getUpdateSiteName

Get the name of an update site. This is used in logging.

getUpdateSiteName(integer $updateSiteId) : string
inherited

Arguments

$updateSiteId

integerThe 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(array $options = array()) : boolean|\JHttpResponse
inherited
throws

\Exception

Arguments

$options

arrayThe update options, see findUpdate() in children classes

Response

boolean|\JHttpResponseFalse if we can't connect to the site, JHttpResponse otherwise

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(integer $update_site_id, boolean $enabled = true) : void
inherited

Arguments

$update_site_id

integerThe numeric ID of the update site to enable/disable

$enabled

booleanEnable the site when true, disable it when false

Properties

base

Root of the tree

since

1.7.0

Type(s)

object

parent

Parent

inherited
since

1.6

Type(s)

\JAdapter

pop_parent

Used to control if an item has a child or not

since

1.7.0

Type(s)

boolean

update_sites

A list of discovered update sites

Type(s)

array

updates

A list of discovered updates

Type(s)

array

xmlParser

Resource handle for the XML Parser

inherited
since

3.0.0

Type(s)

resource

stack

Element call stack

inherited
since

3.0.0

Type(s)

array

updateSiteId

ID of update site

inherited
since

3.0.0

Type(s)

string

updatecols

Columns in the extensions table to be updated

inherited
since

3.0.0

Type(s)

array

appendExtension

Should we try appending a .xml extension to the update site's URL?

inherited

Type(s)

boolean

updateSiteName

The name of the update site (used in logging)

inherited

Type(s)

string

_url

The update site URL from which we will get the update information

inherited

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)

inherited
since

14.1

see \Joomla\CMS\Updater\Updater

Type(s)

integer

db

Database

inherited
since

1.6

Type(s)

\JDatabaseDriver