CollectionAdapter

Extends UpdateAdapter

Collection Update Adapter Class

since

1.7.0

package

Application

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed properties = null) : mixed
inherited
since

1.7.0

Arguments

properties

mixedEither and associative array or another object to set the initial properties of the object.

Response

mixed

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_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() : string
inherited
since

1.7.0

Response

string

_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

def

Sets a default value if not already assigned

def(string property, mixed default = null) : mixed
inherited
since

1.7.0

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixed

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

get

Returns a property of the object or the default value if the property is not set.

get(string property, mixed default = null) : mixed
inherited
since

1.7.0

see CMSObject::getProperties()

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(int i = null, bool toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

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() : array
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

getParent

Retrieves the parent object

getParent() : \Joomla\CMS\Adapter\Adapter
inherited
since

1.6

Response

\Joomla\CMS\Adapter\Adapter

getProperties

Returns an associative array of object properties.

getProperties(bool public = true) : array
inherited
since

1.7.0

see CMSObject::get()

Arguments

public

boolIf true, returns only the public properties.

Response

array

getUpdateSiteName

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

getUpdateSiteName(int updateSiteId) : string
inherited

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(array options = array()) : \Joomla\CMS\Http\Response|bool
inherited
throws

\Exception

Arguments

options

arrayThe update options, see findUpdate() in children classes

Response

\Joomla\CMS\Http\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(string property, mixed value = null) : mixed
inherited
since

1.7.0

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(string error) : void
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed properties) : bool
inherited
since

1.7.0

see CMSObject::set()

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(int updateSiteId, bool enabled = true) : void
inherited

Arguments

updateSiteId

intThe numeric ID of the update site to enable/disable

enabled

boolEnable 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)

Adapter

pop_parent

Used to control if an item has a child or not

since

1.7.0

Type(s)

int

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)

int

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)

bool

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 Updater

Type(s)

int

db

Database

inherited
since

1.6

Type(s)

\Joomla\Database\DatabaseDriver

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Type(s)

array