JUpdater
Extends \JAdapterUpdater 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
mixed
Either 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
string
The classname.
arrayUnique
Multidimensional array safe unique test
arrayUnique(array $myArray) : array
deprecated |
12.1 |
---|---|
note |
Use JArrayHelper::arrayUnique() instead. Borrowed from PHP.net |
see | |
since |
11.1 |
Arguments
- $myArray
array
The source array.
Response
array
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
findUpdates
Finds an update for an extension
findUpdates(integer $eid, integer $cacheTimeout) : boolean
since |
11.1 |
---|
Arguments
- $eid
integer
Extension Identifier; if zero use all sites- $cacheTimeout
integer
How many seconds to cache update information; if zero, force reload the update information
Response
boolean
True if there are updates
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
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
getAdapter
Return an adapter.
getAdapter(string $name, array $options = array()) : object
since |
11.1 |
---|
Arguments
- $name
string
Name of adapter to return- $options
array
Adapter options
Response
object
Adapter of type 'name' or false
getDBO
Get the database connector object
getDBO() : \JDatabase
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
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getInstance
Returns a reference to the global Installer object, only creating it if it doesn't already exist.
getInstance() : object
since |
11.1 |
---|
Response
object
An installer object
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If true, returns only the public properties.
Response
array
loadAllAdapters
Loads all adapters.
loadAllAdapters(array $options = array()) : void
since |
11.1 |
---|
Arguments
- $options
array
Adapter options
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
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setAdapter
Set an adapter by name
setAdapter(string $name, &$adapter = null, array $options = array()) : boolean
since |
11.1 |
---|
Arguments
- $name
string
Adapter name- $adapter
- $options
array
Adapter options
Response
boolean
True if successful
setError
Add an error message.
setError(string $error) : void
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
update
Finds an update for an extension
update(integer $id) : mixed
since |
11.1 |
---|
Arguments
- $id
integer
Id of the extension
Response
mixed
Properties
_adapters
Associative array of adapters
since |
11.1 |
---|
Type(s)
array
_adapterfolder
Adapter Folder
since |
11.1 |
---|
Type(s)
string
_classprefix
Adapter Class Prefix
since |
11.1 |
---|
Type(s)
string
_basepath
Base Path for the adapter instance
since |
11.1 |
---|
Type(s)
string
_errors
An array of error messages or Exception objects.