Docs For Class JAdapter

Description

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

since: 11.1

Located in /libraries/joomla/base/adapter.php (line 21)

JObject
   |
   --JAdapter

Direct descendents

Class	Description
JInstaller	Joomla base installer class
JUpdater	Updater Class

Variable Summary

string $_adapterfolder

array $_adapters

string $_basepath

string $_classprefix

JDatabaseDriver $_db

Method Summary

JAdapter __construct (string $basepath, [string $classprefix = null], [string $adapterfolder = null])

object Adapter getAdapter (string $name, [array $options = array()])

JDatabaseDriver getDBO ()

void loadAllAdapters ([array $options = array()])

boolean setAdapter (string $name, [object &$adapter = null], [array $options = array()])

Variables

string $_adapterfolder = 'adapters' (line 36)

Adapter Folder

since: 11.1
access: protected

array $_adapters = array() (line 29)

Associative array of adapters

since: 11.1
access: protected

string $_basepath = null (line 50)

Base Path for the adapter instance

since: 11.1
access: protected

string $_classprefix = 'J' (line 42)

var: Adapter Class Prefix
since: 11.1
access: protected

JDatabaseDriver $_db (line 58)

Database Connector Object

since: 11.1
access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 69)

Constructor

since: 11.1
access: public

JAdapter __construct (string $basepath, [string $classprefix = null], [string $adapterfolder = null])

string $basepath: Base Path of the adapters
string $classprefix: Class prefix of adapters
string $adapterfolder: Name of folder to append to base path

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

Redefined in descendants as:

JInstaller::__construct() : Constructor
JUpdater::__construct() : Constructor

getAdapter (line 140)

Return an adapter.

return: of type 'name' or false
since: 11.1
access: public

object Adapter getAdapter (string $name, [array $options = array()])

string $name: Name of adapter to return
array $options: Adapter options

getDBO (line 85)

Get the database connector object

return: Database connector object
since: 11.1
access: public

JDatabaseDriver getDBO ()

loadAllAdapters (line 164)

Loads all adapters.

since: 11.1
access: public

void loadAllAdapters ([array $options = array()])

array $options: Adapter options

setAdapter (line 101)

Set an adapter by name

return: True if successful
since: 11.1
access: public

boolean setAdapter (string $name, [object &$adapter = null], [array $options = array()])

string $name: Adapter name
object &$adapter: Adapter object
array $options: Adapter options

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()