Joomla! API

Download
Launch

JUpdater

Extends \JAdapter

Updater 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)
inherited
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
inherited deprecated
since

11.1
deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

arrayUnique

Multidimensional array safe unique test

arrayUnique(array $myArray) : array
deprecated
deprecated

12.1

note

Use JArrayHelper::arrayUnique() instead.

Borrowed from PHP.net
see

http://au2.php.net/manual/en/function.array-unique.php
since

11.1

Arguments

$myArray

arrayThe source array.

Response

array

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

findUpdates

Finds an update for an extension

findUpdates(integer $eid, integer $cacheTimeout) : boolean
since

11.1

Arguments

$eid

integerExtension Identifier; if zero use all sites

$cacheTimeout

integerHow many seconds to cache update information; if zero, force reload the update information

Response

booleanTrue 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
inherited
since

11.1
see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getAdapter

Return an adapter.

getAdapter(string $name, array $options = array()) : object
inherited
since

11.1

Arguments

$name

stringName of adapter to return

$options

arrayAdapter options

Response

objectAdapter of type 'name' or false

getDBO

Get the database connector object

getDBO() : \JDatabase
inherited
since

11.1

Response

\JDatabaseDatabase connector object

getError

Get the most recent error message.

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

11.1
see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray 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
static
since

11.1

Response

objectAn installer object

getProperties

Returns an associative array of object properties.

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

11.1
see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

loadAllAdapters

Loads all adapters.

loadAllAdapters(array $options = array()) : void
inherited
since

11.1

Arguments

$options

arrayAdapter options

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setAdapter

Set an adapter by name

setAdapter(string $name,  &$adapter = null, array $options = array()) : boolean
inherited
since

11.1

Arguments

$name

stringAdapter name

$adapter

$options

arrayAdapter options

Response

booleanTrue if successful

setError

Add an error message.

setError(string $error) : void
inherited deprecated
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
inherited
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
inherited deprecated
since

11.1
deprecated

12.1 Use magic method __toString()
see \JObject::__toString()

Response

string

update

Finds an update for an extension

update(integer $id) : mixed
since

11.1

Arguments

$id

integerId of the extension

Response

mixed

Properties

instance

JUpdater instance container.

static
since

11.3

Type(s)

\JUpdater

_adapters

Associative array of adapters

inherited
since

11.1

Type(s)

array

_adapterfolder

Adapter Folder

inherited
since

11.1

Type(s)

string

_classprefix

Adapter Class Prefix

inherited
since

11.1

Type(s)

string

_basepath

Base Path for the adapter instance

inherited
since

11.1

Type(s)

string

_db

Database Connector Object

inherited
since

11.1

Type(s)

\JDatabase

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array
  • \ \
  • \ JUpdater