JDatabase
Database connector class.
since |
1.7.0 |
---|---|
deprecated |
4.0 |
package |
Joomla.Platform |
Methods
getConnectors
Get a list of available database connectors. The list will only be populated with connectors that both the class exists and the static test method returns true. This gives us the ability to have a multitude of connector classes that are self-aware as to whether or not they are able to be used on a given system.
getConnectors() : array
since |
1.7.0 |
---|---|
deprecated |
4.0 |
Response
array
An array of available database connectors.
getErrorMsg
Gets the error message from the database connection.
getErrorMsg(boolean $escaped = false) : string
deprecated |
4.0 |
---|---|
since |
1.7.0 |
Arguments
- $escaped
boolean
True to escape the message string for use in JavaScript.
Response
string
The error message for the most recent query.
getErrorNum
Gets the error number from the database connection.
getErrorNum() : integer
since |
1.7.0 |
---|---|
deprecated |
4.0 |
Response
integer
The error number for the most recent query.
getInstance
Method to return a JDatabaseDriver instance based on the given options. There are three global options and then the rest are specific to the database driver. The 'driver' option defines which JDatabaseDriver class is used for the connection -- the default is 'mysqli'. The 'database' option determines which database is to be used for the connection. The 'select' option determines whether the connector should automatically select the chosen database.
getInstance(array $options = array()) : \JDatabaseDriver
Instances are unique to the given options and new objects are only created when a unique options array is passed into the method. This ensures that we don't end up with unnecessary database connection resources.
since |
1.7.0 |
---|---|
deprecated |
4.0 |
Arguments
- $options
array
Parameters to be passed to the database driver.
Response
\JDatabaseDriver
A database object.
query
Execute the SQL statement.
query() : mixed
since |
1.7.0 |
---|---|
throws |
|
deprecated |
4.0 |
Response
mixed
A database cursor resource on success, boolean false on failure.
splitSql
Splits a string of multiple queries into an array of individual queries.
splitSql(string $query) : array
since |
1.7.0 |
---|---|
deprecated |
4.0 |
Arguments
- $query
string
Input SQL string with which to split into individual queries.
Response
array
The queries from the input string separated into an array.
stderr
Return the most recent error message for the database connector.
stderr(boolean $showSQL = false) : string
since |
1.7.0 |
---|---|
deprecated |
4.0 |
Arguments
- $showSQL
boolean
True to display the SQL statement sent to the database as well as the error.
Response
string
The error message for the most recent query.
test
Test to see if the connector is available.
test() : boolean
since |
1.7.0 |
---|---|
deprecated |
4.0 - Use JDatabaseDriver::isSupported() instead. |
Response
boolean
True on success, false otherwise.