JDatabase

class JDatabase

Database connector class.

Methods

mixed
query()

Execute the SQL statement.

static  array
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.

string
getErrorMsg( boolean $escaped = false)

Gets the error message from the database connection.

integer
getErrorNum()

Gets the error number from the database connection.

static  JDatabaseDriver
getInstance( array $options = array())

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.

static  array
splitSql( string $query)

Splits a string of multiple queries into an array of individual queries.

string
stderr( boolean $showSQL = false)

Return the most recent error message for the database connector.

static  boolean
test()

Test to see if the connector is available.

Details

mixed query()

Execute the SQL statement.

Return Value

mixed A database cursor resource on success, boolean false on failure.

Exceptions

RuntimeException

static array 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.

Return Value

array An array of available database connectors.

string getErrorMsg( boolean $escaped = false)

Gets the error message from the database connection.

Parameters

boolean $escaped True to escape the message string for use in JavaScript.

Return Value

string The error message for the most recent query.

integer getErrorNum()

Gets the error number from the database connection.

Return Value

integer The error number for the most recent query.

static JDatabaseDriver getInstance( array $options = array())

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.

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.

Parameters

array $options Parameters to be passed to the database driver.

Return Value

JDatabaseDriver A database object.

static array splitSql( string $query)

Splits a string of multiple queries into an array of individual queries.

Parameters

string $query Input SQL string with which to split into individual queries.

Return Value

array The queries from the input string separated into an array.

string stderr( boolean $showSQL = false)

Return the most recent error message for the database connector.

Parameters

boolean $showSQL True to display the SQL statement sent to the database as well as the error.

Return Value

string The error message for the most recent query.

static boolean test()

Test to see if the connector is available.

Return Value

boolean True on success, false otherwise.