Adapter

Extends CMSObject

Adapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer

deprecated
since

1.6

deprecated

5.0 Will be removed without replacement

package

Application

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed properties = null) : mixed
inherited
since

1.7.0

Arguments

properties

mixedEither 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() : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not already assigned

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

1.7.0

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixed

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

1.7.0

see CMSObject::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()) : static|bool
since

1.6

Arguments

name

stringName of adapter to return

options

arrayAdapter options

Response

static|boolAdapter of type 'name' or false

getDbo

Get the database connector object

getDbo() : \Joomla\Database\DatabaseDriver
since

1.6

Response

\Joomla\Database\DatabaseDriverDatabase connector object

getError

Get the most recent error message.

getError(int i = null, bool toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

i

intOption error index.

toString

boolIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

getProperties

Returns an associative array of object properties.

getProperties(bool public = true) : array
inherited
since

1.7.0

see CMSObject::get()

Arguments

public

boolIf true, returns only the public properties.

Response

array

loadAllAdapters

Loads all adapters.

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

1.6

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

1.7.0

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, object &adapter = null, array options = array()) : bool
since

1.6

Arguments

name

stringAdapter name

adapter

objectAdapter object

options

arrayAdapter options

Response

boolTrue if successful

setError

Add an error message.

setError(string error) : void
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed properties) : bool
inherited
since

1.7.0

see CMSObject::set()

Arguments

properties

mixedEither an associative array or another object.

Response

bool

Properties

_adapters

Associative array of adapters

since

1.6

Type(s)

static[]

_adapterfolder

Adapter Folder

since

1.6

Type(s)

string

_classprefix

Adapter Class Prefix

since

1.6

Type(s)

string

_basepath

Base Path for the adapter instance

since

1.6

Type(s)

string

_db

Database Connector Object

since

1.6

Type(s)

\Joomla\Database\DatabaseDriver

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Type(s)

array