JAdapter
Extends \JObjectAdapter Class Retains common adapter pattern functions Class harvested from joomla.installer.installer
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Base |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| 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
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
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
| 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
| 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
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| 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
| since |
11.1 |
|---|---|
| see | \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
| 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
| 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
| 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
| since |
11.1 |
|---|
Arguments
- $name
stringAdapter name- $adapter
- $options
arrayAdapter options
Response
booleanTrue if successful
setError
Add an error message.
setError(string $error) : void
| 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
| 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
Properties
_adapters
Associative array of adapters
| since |
11.1 |
|---|
Type(s)
array
_adapterfolder
Adapter Folder
| since |
11.1 |
|---|
Type(s)
string
_classprefix
Adapter Class Prefix
| since |
11.1 |
|---|
Type(s)
string
_basepath
Base Path for the adapter instance
| since |
11.1 |
|---|
Type(s)
string
_errors
An array of error messages or Exception objects.