JUpdaterCollection
Extends \JUpdateAdapterCollection Update Adapter Class
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Updater |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
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
| since |
11.1 |
|---|---|
| deprecated |
12.3 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 |
11.1 |
|---|
Arguments
- $parser
objectParser object- $name
stringName of the element closing
_getLastTag
Gets the reference to the last tag
_getLastTag() : object
| since |
11.1 |
|---|
Response
object
_getParent
Get the parent tag
_getParent() : string
| since |
11.1 |
|---|
Response
stringparent
_getStackLocation
Gets the reference to the current direct parent
_getStackLocation() : object
| since |
11.1 |
|---|
Response
object
_startElement
Opening an XML element
_startElement(object $parser, string $name, array $attrs = array()) : void
| since |
11.1 |
|---|
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 alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
findUpdate
Finds an update
findUpdate(array $options) : array
| since |
11.1 |
|---|
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
| since |
11.1 |
|---|---|
| see | \JObject::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
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getParent
Retrieves the parent object
getParent() : object
| since |
11.1 |
|---|
Response
objectparent
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
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
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
base
Root of the tree
| since |
11.1 |
|---|
Type(s)
object
pop_parent
Used to control if an item has a child or not
| since |
11.1 |
|---|
Type(s)
boolean
update_sites
A list of discovered update sites
Type(s)
array
updates
A list of discovered updates
Type(s)
array
xml_parser
| since |
11.1 |
|---|
Type(s)
string
_stack
| since |
11.1 |
|---|
Type(s)
array
_update_site_id
ID of update site
| since |
11.1 |
|---|
Type(s)
string
_updatecols
Columns in the extensions table to be updated
| since |
11.1 |
|---|
Type(s)
array
_errors
An array of error messages or Exception objects.