Joomla! API

Download
Launch

Adapter

Extends CMSObject

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

deprecated
since

1.6
deprecated

4.3 will be removed in 6.0 Will be removed without replacement
package

Joomla CMS

Methods

__construct

Constructor

__construct( basepath,  classprefix = null,  adapterfolder = null) :
since

1.6

Arguments

basepath

stringBase Path of the adapters

classprefix

stringClass prefix of adapters

adapterfolder

stringName of folder to append to base path

Response

mixed

__toString

Magic method to convert the object to a string gracefully.

__toString() :
inherited deprecated
since

1.7.0
deprecated

4.3 will be removed in 6.0 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not already assigned

def( property,  default = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Defining dynamic properties should not be used anymore

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( property,  default = null) :
inherited deprecated
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

stringThe name of the property.

default

mixedThe default value.

Response

mixedThe value of the property.

getAdapter

Return an adapter.

getAdapter( name, mixed||string|int options = []) : static|bool
since

1.6

Arguments

name

stringName of adapter to return

options

array<string|int, mixed>Adapter options

Response

static|boolAdapter of type 'name' or false

getDbo

Get the database connector object

getDbo() : \Joomla\Database\DatabaseDriver
since

1.6

Response

DatabaseDriverDatabase connector object

getError

Get the most recent error message.

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

intOption error index.

toString

boolIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : mixed||string|int
inherited deprecated
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.

getProperties

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int
inherited deprecated
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

boolIf true, returns only the public properties.

Response

array<string|int, mixed>

loadAllAdapters

Loads all adapters.

loadAllAdapters(mixed||string|int options = []) :
since

1.6

Arguments

options

array<string|int, mixed>Adapter options

Response

void

set

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

set( property,  value = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Create a proper setter function for the property

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( name,  &adapter = null, mixed||string|int options = []) :
since

1.6

Arguments

name

stringAdapter name

adapter

objectAdapter object

options

array<string|int, mixed>Adapter options

Response

boolTrue if successful

setError

Add an error message.

setError( error) :
inherited deprecated
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

stringError message.

Response

void

setProperties

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

setProperties( properties) :
inherited deprecated
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

mixedEither an associative array or another object.

Response

bool

Properties

_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<string|int, mixed>

_adapters

Associative array of adapters

since

1.6

Type(s)

array<string|int, 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)

DatabaseDriver
  • \ Joomla
  • \ CMS
  • \ Adapter
  • \ Adapter