Changelog
Changelog class.
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
characterData
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
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 7.0 Defining dynamic properties should not be used anymore |
Arguments
- property
stringThe name of the property.- default
mixedThe default value.
Response
mixed
endElement
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
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 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.
getLastTag
Get the last position in stack count
getLastTag() :
| since |
4.0.0 |
|---|
Response
string
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 7.0 Create a proper getter function for the property |
Arguments
- public
boolIf true, returns only the public properties.
Response
array<string|int, mixed>
getStackLocation
Gets the reference to the current direct parent
getStackLocation() :
| since |
4.0.0 |
|---|
Response
string
loadFromXml
Loads an XML file from a URL.
loadFromXml( url) :
| since |
4.0.0 |
|---|
Arguments
- url
stringThe URL.
Response
boolTrue on success
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 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.
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 7.0 Create a proper setter function for the property |
Arguments
- properties
mixedEither an associative array or another object.
Response
bool
setVersion
Set the version to match.
setVersion( version) :
| since |
4.0.0 |
|---|
Arguments
- version
stringThe version to match
Response
void
startElement
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
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<string|int, mixed>
fix
Update manifest <fix> element
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
language
Update manifest <language> element
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
addition
Update manifest <addition> element
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
change
Update manifest <change> elements
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
remove
Update manifest <remove> element
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
note
Update manifest <maintainer> element
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
items
List of node items
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
xmlParser
Resource handle for the XML Parser
| since |
4.0.0 |
|---|
Type(s)
XMLParser
stack
Element call stack
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
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
folder
Update manifest <folder> element
| since |
5.1.1 |
|---|
Type(s)
string