MySQL database driver

• see: http://dev.mysql.com/doc/
• since: 12.1

Located in /libraries/joomla/database/driver/mysql.php (line 20)

JDatabase
   |
   --JDatabaseDriver
      |
      --JDatabaseDriverMysqli
         |
         --JDatabaseDriverMysql

string $name = 'mysql' (line 28)

The name of the database driver.

• since: 12.1
• access: public

---

Redefinition of:

JDatabaseDriverMysqli::$name

The name of the database driver.

Inherited Variables

Inherited from JDatabaseDriverMysqli

JDatabaseDriverMysqli::$dbMinimum
JDatabaseDriverMysqli::$nameQuote
JDatabaseDriverMysqli::$nullDate

Inherited from JDatabaseDriver

JDatabaseDriver::$callStacks
JDatabaseDriver::$connection
JDatabaseDriver::$count
JDatabaseDriver::$cursor
JDatabaseDriver::$debug
JDatabaseDriver::$disconnectHandlers
JDatabaseDriver::$errorMsg
JDatabaseDriver::$errorNum
JDatabaseDriver::$instances
JDatabaseDriver::$limit
JDatabaseDriver::$log
JDatabaseDriver::$offset
JDatabaseDriver::$options
JDatabaseDriver::$sql
JDatabaseDriver::$tablePrefix
JDatabaseDriver::$timings
JDatabaseDriver::$transactionDepth
JDatabaseDriver::$utf

static isSupported (line 160)

Test to see if the MySQL connector is available.

• return: True on success, false otherwise.
• since: 12.1
• access: public

static boolean isSupported ()

---

Redefinition of:

JDatabaseDriverMysqli::isSupported()

Test to see if the MySQL connector is available.

Constructor __construct (line 37)

Constructor.

• since: 12.1
• access: public

JDatabaseDriverMysql __construct (array $options)

• array $options: Array of database options with keys: host, user, password, database, select.

---

Redefinition of:

JDatabaseDriverMysqli::__construct()

Constructor.

Destructor __destruct (line 55)

Destructor.

• since: 12.1
• access: public

void __destruct ()

---

Redefinition of:

JDatabaseDriverMysqli::__destruct()

Destructor.

connect (line 68)

Connects to the database if needed.

• return: Returns void if the database connected successfully.
• since: 12.1
• throws: RuntimeException
• access: public

void connect ()

---

Redefinition of:

JDatabaseDriverMysqli::connect()

Connects to the database if needed.

connected (line 172)

Determines if the connection to the server is active.

• return: True if connected to the database engine.
• since: 12.1
• access: public

boolean connected ()

---

Redefinition of:

JDatabaseDriverMysqli::connected()

Determines if the connection to the server is active.

disconnect (line 113)

Disconnects the database.

• since: 12.1
• access: public

void disconnect ()

---

Redefinition of:

JDatabaseDriverMysqli::disconnect()

Disconnects the database.

escape (line 139)

Method to escape a string for usage in an SQL statement.

• return: The escaped string.
• since: 12.1
• access: public

string escape (string $text, [boolean $extra = false])

• string $text: The string to be escaped.
• boolean $extra: Optional parameter to provide extra escaping.

---

Redefinition of:

JDatabaseDriverMysqli::escape()

Method to escape a string for usage in an SQL statement.

execute (line 248)

Execute the SQL statement.

• return: A database cursor resource on success, boolean false on failure.
• since: 12.1
• throws: RuntimeException
• access: public

mixed execute ()

---

Redefinition of:

JDatabaseDriverMysqli::execute()

Execute the SQL statement.

fetchArray (line 394)

Method to fetch a row from the result set cursor as an array.

• return: Either the next row from the result set or false if there are no more rows.
• since: 12.1
• access: protected

mixed fetchArray ([mixed $cursor = null])

• mixed $cursor: The optional result set cursor from which to fetch the row.

---

Redefinition of:

JDatabaseDriverMysqli::fetchArray()

Method to fetch a row from the result set cursor as an array.

fetchAssoc (line 408)

Method to fetch a row from the result set cursor as an associative array.

• return: Either the next row from the result set or false if there are no more rows.
• since: 12.1
• access: protected

mixed fetchAssoc ([mixed $cursor = null])

• mixed $cursor: The optional result set cursor from which to fetch the row.

---

Redefinition of:

JDatabaseDriverMysqli::fetchAssoc()

Method to fetch a row from the result set cursor as an associative array.

fetchObject (line 423)

Method to fetch a row from the result set cursor as an object.

• return: Either the next row from the result set or false if there are no more rows.
• since: 12.1
• access: protected

mixed fetchObject ([mixed $cursor = null], [string $class = 'stdClass'])

• mixed $cursor: The optional result set cursor from which to fetch the row.
• string $class: The class name to use for the returned row object.

---

Redefinition of:

JDatabaseDriverMysqli::fetchObject()

Method to fetch a row from the result set cursor as an object.

freeResult (line 437)

Method to free up the memory used for the result set.

• since: 12.1
• access: protected

void freeResult ([mixed $cursor = null])

• mixed $cursor: The optional result set cursor from which to fetch the row.

---

Redefinition of:

JDatabaseDriverMysqli::freeResult()

Method to free up the memory used for the result set.

getAffectedRows (line 189)

Get the number of affected rows for the previous executed SQL statement.

• return: The number of affected rows.
• since: 12.1
• access: public

integer getAffectedRows ()

---

Redefinition of:

JDatabaseDriverMysqli::getAffectedRows()

Get the number of affected rows for the previous executed SQL statement.

getNumRows (line 205)

Get the number of returned rows for the previous executed SQL statement.

• return: The number of returned rows.
• since: 12.1
• access: public

integer getNumRows ([resource $cursor = null])

• resource $cursor: An optional database cursor resource to extract the row count from.

---

Redefinition of:

JDatabaseDriverMysqli::getNumRows()

Get the number of returned rows for the previous executed SQL statement.

getVersion (line 219)

Get the version of the database connector.

• return: The database connector version.
• since: 12.1
• access: public

string getVersion ()

---

Redefinition of:

JDatabaseDriverMysqli::getVersion()

Get the version of the database connector.

insertid (line 233)

Method to get the auto-incremented value from the last INSERT statement.

• return: The value of the auto-increment field from the last inserted row.
• since: 12.1
• access: public

integer insertid ()

---

Redefinition of:

JDatabaseDriverMysqli::insertid()

Method to get the auto-incremented value from the last INSERT statement.

select (line 354)

Select a database for use.

• return: True if the database was successfully selected.
• since: 12.1
• throws: RuntimeException
• access: public

boolean select (string $database)

• string $database: The name of the database to select for use.

---

Redefinition of:

JDatabaseDriverMysqli::select()

Select a database for use.

setUTF (line 378)

Set the connection to use UTF-8 character encoding.

• return: True on success.
• since: 12.1
• access: public

boolean setUTF ()

---

Redefinition of:

JDatabaseDriverMysqli::setUTF()

Set the connection to use UTF-8 character encoding.

Inherited Methods

Inherited From JDatabaseDriverMysqli

JDatabaseDriverMysqli::__construct()
JDatabaseDriverMysqli::connect()
JDatabaseDriverMysqli::connected()
JDatabaseDriverMysqli::disconnect()
JDatabaseDriverMysqli::dropTable()
JDatabaseDriverMysqli::escape()
JDatabaseDriverMysqli::execute()
JDatabaseDriverMysqli::fetchArray()
JDatabaseDriverMysqli::fetchAssoc()
JDatabaseDriverMysqli::fetchObject()
JDatabaseDriverMysqli::freeResult()
JDatabaseDriverMysqli::getAffectedRows()
JDatabaseDriverMysqli::getCollation()
JDatabaseDriverMysqli::getNumRows()
JDatabaseDriverMysqli::getTableColumns()
JDatabaseDriverMysqli::getTableCreate()
JDatabaseDriverMysqli::getTableKeys()
JDatabaseDriverMysqli::getTableList()
JDatabaseDriverMysqli::getVersion()
JDatabaseDriverMysqli::insertid()
JDatabaseDriverMysqli::isSupported()
JDatabaseDriverMysqli::lockTable()
JDatabaseDriverMysqli::renameTable()
JDatabaseDriverMysqli::select()
JDatabaseDriverMysqli::setUTF()
JDatabaseDriverMysqli::transactionCommit()
JDatabaseDriverMysqli::transactionRollback()
JDatabaseDriverMysqli::transactionStart()
JDatabaseDriverMysqli::unlockTables()
JDatabaseDriverMysqli::__destruct()

Inherited From JDatabaseDriver

JDatabaseDriver::__construct()
JDatabaseDriver::addDisconnectHandler()
JDatabaseDriver::alterDbCharacterSet()
JDatabaseDriver::connect()
JDatabaseDriver::connected()
JDatabaseDriver::createDatabase()
JDatabaseDriver::disconnect()
JDatabaseDriver::dropTable()
JDatabaseDriver::escape()
JDatabaseDriver::execute()
JDatabaseDriver::fetchArray()
JDatabaseDriver::fetchAssoc()
JDatabaseDriver::fetchObject()
JDatabaseDriver::freeResult()
JDatabaseDriver::getAffectedRows()
JDatabaseDriver::getAlterDbCharacterSet()
JDatabaseDriver::getCallStacks()
JDatabaseDriver::getCollation()
JDatabaseDriver::getConnection()
JDatabaseDriver::getConnectors()
JDatabaseDriver::getCount()
JDatabaseDriver::getCreateDatabaseQuery()
JDatabaseDriver::getDatabase()
JDatabaseDriver::getDateFormat()
JDatabaseDriver::getExporter()
JDatabaseDriver::getImporter()
JDatabaseDriver::getInstance()
JDatabaseDriver::getIterator()
JDatabaseDriver::getLog()
JDatabaseDriver::getMinimum()
JDatabaseDriver::getNullDate()
JDatabaseDriver::getNumRows()
JDatabaseDriver::getPrefix()
JDatabaseDriver::getQuery()
JDatabaseDriver::getTableColumns()
JDatabaseDriver::getTableCreate()
JDatabaseDriver::getTableKeys()
JDatabaseDriver::getTableList()
JDatabaseDriver::getTimings()
JDatabaseDriver::getUTFSupport()
JDatabaseDriver::getVersion()
JDatabaseDriver::hasUTFSupport()
JDatabaseDriver::insertid()
JDatabaseDriver::insertObject()
JDatabaseDriver::isMinimumVersion()
JDatabaseDriver::loadAssoc()
JDatabaseDriver::loadAssocList()
JDatabaseDriver::loadColumn()
JDatabaseDriver::loadNextObject()
JDatabaseDriver::loadNextRow()
JDatabaseDriver::loadObject()
JDatabaseDriver::loadObjectList()
JDatabaseDriver::loadResult()
JDatabaseDriver::loadRow()
JDatabaseDriver::loadRowList()
JDatabaseDriver::lockTable()
JDatabaseDriver::quote()
JDatabaseDriver::quoteName()
JDatabaseDriver::quoteNameStr()
JDatabaseDriver::renameTable()
JDatabaseDriver::replacePrefix()
JDatabaseDriver::select()
JDatabaseDriver::setDebug()
JDatabaseDriver::setQuery()
JDatabaseDriver::setUTF()
JDatabaseDriver::splitSql()
JDatabaseDriver::transactionCommit()
JDatabaseDriver::transactionRollback()
JDatabaseDriver::transactionStart()
JDatabaseDriver::truncateTable()
JDatabaseDriver::unlockTables()
JDatabaseDriver::updateObject()
JDatabaseDriver::__call()

Inherited From JDatabase

JDatabase::getConnectors()
JDatabase::getErrorMsg()
JDatabase::getErrorNum()
JDatabase::getInstance()
JDatabase::query()
JDatabase::splitSql()
JDatabase::stderr()
JDatabase::test()