Changelog
Extends CMSObjectChangelog class.
since |
4.0.0 |
---|---|
package |
Joomla CMS |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct( properties = null) :
since |
1.7.0 |
---|
Arguments
- properties
mixed
Either 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() :
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Classes should provide their own __toString() implementation. |
Response
string
The classname.
characterData
Character Parser Function
characterData( parser, data) :
note |
This is public because its called externally. |
---|---|
since |
1.7.0 |
Arguments
- parser
object
Parser object.- data
object
The 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 6.0 Defining dynamic properties should not be used anymore |
Arguments
- property
string
The name of the property.- default
mixed
The 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
object
Parser object- name
string
Name 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 6.0 Create a proper getter function for the property |
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError( i = null, toString = true) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError |
Arguments
- i
int
Option error index.- toString
bool
Indicates if Exception objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : mixed||string|int
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors |
Response
array<string|int, mixed>
Array of error messages.
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 6.0 Create a proper getter function for the property |
Arguments
- public
bool
If 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
string
The URL.
Response
bool
True 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 6.0 Create a proper setter function for the property |
Arguments
- property
string
The name of the property.- value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError( error) :
since |
1.7.0 |
---|---|
deprecated |
3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError |
Arguments
- error
string
Error message.
Response
void
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 6.0 Create a proper setter function for the property |
Arguments
- properties
mixed
Either an associative array or another object.
Response
bool
setVersion
Set the version to match.
setVersion( version) :
since |
4.0.0 |
---|
Arguments
- version
string
The 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
object
Parser object- name
string
Name of the tag found- attrs
array<string|int, mixed>
Attributes of the tag
Response
void
Properties
_errors
An array of error messages or Exception objects.
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Type(s)
array<string|int, mixed>
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)
resource
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