Joomla! API

Character Parser Function

_characterData( parser,  data) :

note	This is public because its called externally.
since	1.7.0

Arguments

parser: objectParser object.
data: objectThe data.

Response

void

Callback for closing the element

_endElement( parser,  name) :

note	This is public because it is called externally
since	1.7.0

Arguments

parser: objectParser object
name: stringName of element that was closed

Response

void

Get the last position in stack count

_getLastTag() :

since	1.7.0

Response

string

Gets the reference to the current direct parent

_getStackLocation() :

since	1.7.0

Response

string

XML Start Element callback

_startElement( parser,  name, mixed||string|int attrs = []) :

note	This is public because it is called externally
since	1.7.0

Arguments

parser: objectParser object
name: stringName of the tag found
attrs: array<string|int, mixed>Attributes of the tag

Response

void

Sets a default value if not already assigned

def( property,  default = null) :

inherited deprecated

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

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

get( property,  default = null) :

inherited deprecated

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.

Get the most recent error message.

getError( i = null,  toString = true) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.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

Return all errors, if any.

getErrors() : mixed||string|int

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int

inherited deprecated

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>

Get extension's Joomla! target version

getTargetVersion() :

since	5.1.1

Response

string

Loads update information from a TUF repo.

loadFromTuf(\Joomla\CMS\Table\Tuf metadataTable,  url,  minimumStability = Updater::STABILITY_STABLE,  channel = null) :

since	5.1.0

Arguments

metadataTable: TufThe metadata table
url: stringThe repo url
minimumStability: intThe minimum stability required for updating the extension {@see \Joomla\CMS\Updater\Updater}
channel: stringThe update channel

Response

boolTrue on success

Loads a XML file from a URL.

loadFromXml( url,  minimumStability = Updater::STABILITY_STABLE,  channel = null) :

since	1.7.0

Arguments

url: stringThe URL.
minimumStability: intThe minimum stability required for updating the extension {@see \Joomla\CMS\Updater\Updater}
channel: mixed

Response

boolTrue on success

Modifies a property of the object, creating it if it does not already exist.

set( property,  value = null) :

inherited deprecated

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.

Add an error message.

setError( error) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error: stringError message.

Response

void

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

setProperties( properties) :

inherited deprecated

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

Set extension's Joomla! target version

setTargetVersion( version) :

since	5.1.1

Arguments

version: stringThe target version

Response

void

If true then subclasses should throw exceptions rather than use getError and setError.

setUseExceptions( value) :

inherited deprecated

since	5.4.0
deprecated	7.0

Arguments

value: boolThe value to set for the field.

Response

void

If true then subclasses should throw exceptions rather than use getError and setError.

shouldUseExceptions() :

inherited deprecated

since	5.4.0
deprecated	7.0

Response

bool

Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of dev, alpha, beta, rc, stable) it is ignored.

stabilityTagToInteger( tag) :

since	3.4

Arguments

tag: stringThe tag string, e.g. dev, alpha, beta, rc, stable

Response

int

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<string|int, mixed>

Use exceptions rather than getError/setError.

inherited deprecated

since	5.4.0
deprecated	7.0

Type(s)

bool

Update manifest <name> element

since	1.7.0

Type(s)

string

Update manifest <description> element

since	1.7.0

Type(s)

string

Update manifest <element> element

since	1.7.0

Type(s)

string

Update manifest <type> element

since	1.7.0

Type(s)

string

Update manifest <version> element

since	1.7.0

Type(s)

string

Update manifest <infourl> element

since	1.7.0

Type(s)

string

Update manifest <client> element

since	1.7.0

Type(s)

string

Update manifest <group> element

since	1.7.0

Type(s)

string

Update manifest <downloads> element

since	1.7.0

Type(s)

string

Update manifest <downloadsource> elements

since	3.8.3

Type(s)

array<string|int, DownloadSource>

Update manifest <tags> element

since	1.7.0

Type(s)

string

Update manifest <maintainer> element

since	1.7.0

Type(s)

string

Update manifest <maintainerurl> element

since	1.7.0

Type(s)

string

Update manifest <category> element

since	1.7.0

Type(s)

string

Update manifest <relationships> element

since	1.7.0

Type(s)

string

Update manifest <targetplatform> element

since	1.7.0

Type(s)

string

Extra query for download URLs

since	3.2.0

Type(s)

string

Resource handle for the XML Parser

since	3.0.0

Type(s)

XMLParser

Element call stack

since	3.0.0

Type(s)

array<string|int, mixed>

Unused state array

since	3.0.0

Type(s)

array<string|int, mixed>

Object containing the current update data

since	3.0.0

Type(s)

stdClass

Object containing the latest update data which meets the requirements

since	3.0.0

Type(s)

stdClass

Object containing details if the latest update does not meet the PHP and DB version requirements

since	4.4.2

Type(s)

stdClass

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)

since	14.1
see	Updater

Type(s)

int

Current release channel

since	5.1.0

Type(s)

string

Array with compatible versions used by the pre-update check

since	3.10.2

Type(s)

array<string|int, mixed>

Joomla! target version used by the pre-update check

since	5.1.1

Type(s)

string

since	1.7.0
package	Joomla CMS

Update

Methods

_characterData

Arguments

Response

_endElement

Arguments

Response

_getLastTag

Response

_getStackLocation

Response

_startElement

Arguments

Response

def

Arguments

Response

get

Arguments

Response

getError

Arguments

Response

getErrors

Response

getProperties

Arguments

Response

getTargetVersion

Response

loadFromTuf

Arguments

Response

loadFromXml

Arguments

Response

set

Arguments

Response

setError

Arguments

Response

setProperties

Arguments

Response

setTargetVersion

Arguments

Response

setUseExceptions

Arguments

Response

shouldUseExceptions

Response

stabilityTagToInteger

Arguments

Response

Properties

_errors

Type(s)

useExceptions

Type(s)

name

Type(s)

description

Type(s)

element

Type(s)

type

Type(s)

version

Type(s)

infourl

Type(s)

client

Type(s)

group

Type(s)

downloads

Type(s)