Changelog

Extends \Joomla\CMS\Object\CMSObject

Changelog class.

This class allows for simple but smart objects with get and set methods and an internal error handler.

since

4.0.0

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

Arguments

$properties

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

__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.

characterData

Character Parser Function

characterData(object $parser, object $data) : void
note

This is public because its called externally.

since

1.7.0

Arguments

$parser

objectParser object.

$data

objectThe data.

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

endElement

Callback for closing the element

endElement(object $parser, string $name) : void
note

This is public because it is called externally

since

1.7.0

Arguments

$parser

objectParser object

$name

stringName of element that was closed

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 \Joomla\CMS\Object\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(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates 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.

getLastTag

Get the last position in stack count

getLastTag() : string
since

4.0.0

Response

string

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

getStackLocation

Gets the reference to the current direct parent

getStackLocation() : object
since

4.0.0

Response

object

loadFromXml

Loads an XML file from a URL.

loadFromXml(string $url) : boolean
since

4.0.0

Arguments

$url

stringThe URL.

Response

booleanTrue on success

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) : boolean
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

setVersion

Set the version to match.

setVersion(string $version) : void
since

4.0.0

Arguments

$version

stringThe version to match

startElement

XML Start Element callback

startElement(object $parser, string $name, array $attrs = array()) : void
note

This is public because it is called externally

since

1.7.0

Arguments

$parser

objectParser object

$name

stringName of the tag found

$attrs

arrayAttributes of the tag

Properties

element

Update manifest <element> element

since

4.0.0

Type(s)

string

type

Update manifest <type> element

since

4.0.0

Type(s)

string

version

Update manifest <version> element

since

4.0.0

Type(s)

string

security

Update manifest <security> element

since

4.0.0

Type(s)

array

fix

Update manifest <fix> element

since

4.0.0

Type(s)

array

language

Update manifest <language> element

since

4.0.0

Type(s)

array

addition

Update manifest <addition> element

since

4.0.0

Type(s)

array

change

Update manifest <change> elements

since

4.0.0

Type(s)

array

remove

Update manifest <remove> element

since

4.0.0

Type(s)

array

note

Update manifest <maintainer> element

since

4.0.0

Type(s)

array

items

List of node items

since

4.0.0

Type(s)

array

xmlParser

Resource handle for the XML Parser

since

4.0.0

Type(s)

resource

stack

Element call stack

since

4.0.0

Type(s)

array

currentChangelog

Object containing the current update data

since

4.0.0

Type(s)

\stdClass

matchVersion

The version to match the changelog

since

4.0.0

Type(s)

string

latest

Object containing the latest changelog data

since

4.0.0

Type(s)

\stdClass

_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