Adapter

Extends \Joomla\CMS\Object\CMSObject

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

deprecated

This class allows for simple but smart objects with get and set methods and an internal error handler.

since

1.6

deprecated

5.0 Will be removed without replacement

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

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

1.7.0

deprecated

12.3 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 \Joomla\CMS\Object\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|boolean
since

1.6

Arguments

$name

stringName of adapter to return

$options

arrayAdapter options

Response

static|booleanAdapter of type 'name' or false

getDbo

Get the database connector object

getDbo() : \JDatabaseDriver
since

1.6

Response

\JDatabaseDriverDatabase connector object

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

see \Joomla\CMS\Object\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

1.7.0

see \Joomla\CMS\Object\JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getProperties

Returns an associative array of object properties.

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

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf 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,  &$adapter = null, array $options = array()) : boolean
since

1.6

Arguments

$name

stringAdapter name

$adapter

$options

arrayAdapter options

Response

booleanTrue if successful

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

1.7.0

see \Joomla\CMS\Object\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

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

Properties

_adapters

Associative array of adapters

since

1.6

Type(s)

array<mixed,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)

\JDatabaseDriver

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

see \Joomla\CMS\Object\JError
deprecated

12.3 JError has been deprecated

Type(s)

array