Class JDatabaseMySQLi

Description

MySQLi database driver

Located in /libraries/joomla/database/database/mysqli.php (line 25)

JDatabase
   |
   --JDatabaseMySQL
      |
      --JDatabaseMySQLi
Variable Summary
string $name
Method Summary
static boolean test ()
JDatabaseMySQLi __construct (array $options)
void __destruct ()
boolean connected ()
string escape (string $text, [boolean $extra = false])
mixed execute ()
mixed fetchArray ([mixed $cursor = null])
mixed fetchAssoc ([mixed $cursor = null])
mixed fetchObject ([mixed $cursor = null], [string $class = 'stdClass'])
void freeResult ([mixed $cursor = null])
integer getAffectedRows ()
integer getNumRows ([resource $cursor = null])
mixed getQuery ([boolean $new = false])
string getVersion ()
boolean hasUTF ()
integer insertid ()
mixed queryBatch ([boolean $abortOnError = true], [boolean $transactionSafe = false])
boolean select (string $database)
boolean setUTF ()
Variables
Methods
static method test (line 174)

Test to see if the MySQL connector is available.

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
static boolean test ()

Redefinition of:
JDatabaseMySQL::test()
Test to see if the MySQL connector is available.
Constructor __construct (line 42)

Constructor.

  • since: 11.1
  • access: protected
JDatabaseMySQLi __construct (array $options)
  • array $options: List of options used to configure the connection

Redefinition of:
JDatabaseMySQL::__construct()
Constructor.
Destructor __destruct (line 137)

Destructor.

  • since: 11.1
  • access: public
void __destruct ()

Redefinition of:
JDatabaseMySQL::__destruct()
Destructor.
connected (line 186)

Determines if the connection to the server is active.

  • return: True if connected to the database engine.
  • since: 11.1
  • access: public
boolean connected ()

Redefinition of:
JDatabaseMySQL::connected()
Determines if the connection to the server is active.
escape (line 155)

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

  • return: The escaped string.
  • since: 11.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:
JDatabaseMySQL::escape()
Method to escape a string for usage in an SQL statement.
execute (line 339)

Execute the SQL statement.

  • return: A database cursor resource on success, boolean false on failure.
  • since: 11.1
  • throws: JDatabaseException
  • access: public
mixed execute ()

Redefinition of:
JDatabaseMySQL::execute()
Execute the SQL statement.
fetchArray (line 467)

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: 11.1
  • access: protected
mixed fetchArray ([mixed $cursor = null])
  • mixed $cursor: The optional result set cursor from which to fetch the row.

Redefinition of:
JDatabaseMySQL::fetchArray()
Method to fetch a row from the result set cursor as an array.
fetchAssoc (line 481)

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: 11.1
  • access: protected
mixed fetchAssoc ([mixed $cursor = null])
  • mixed $cursor: The optional result set cursor from which to fetch the row.

Redefinition of:
JDatabaseMySQL::fetchAssoc()
Method to fetch a row from the result set cursor as an associative array.
fetchObject (line 496)

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: 11.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:
JDatabaseMySQL::fetchObject()
Method to fetch a row from the result set cursor as an object.
freeResult (line 510)

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

  • since: 11.1
  • access: protected
void freeResult ([mixed $cursor = null])
  • mixed $cursor: The optional result set cursor from which to fetch the row.

Redefinition of:
JDatabaseMySQL::freeResult()
Method to free up the memory used for the result set.
getAffectedRows (line 203)

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

  • return: The number of affected rows.
  • since: 11.1
  • access: public
integer getAffectedRows ()

Redefinition of:
JDatabaseMySQL::getAffectedRows()
Get the number of affected rows for the previous executed SQL statement.
getExporter (line 216)

Gets an exporter class object.

  • return: An exporter object.
  • since: 11.1
  • throws: JDatabaseException
  • access: public
JDatabaseExporterMySQLi getExporter ()

Redefinition of:
JDatabaseMySQL::getExporter()
Gets an exporter class object.
getImporter (line 238)

Gets an importer class object.

  • return: An importer object.
  • since: 11.1
  • throws: JDatabaseException
  • access: public
JDatabaseImporterMySQLi getImporter ()

Redefinition of:
JDatabaseMySQL::getImporter()
Gets an importer class object.
getNumRows (line 261)

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

  • return: The number of returned rows.
  • since: 11.1
  • access: public
integer getNumRows ([resource $cursor = null])
  • resource $cursor: An optional database cursor resource to extract the row count from.

Redefinition of:
JDatabaseMySQL::getNumRows()
Get the number of returned rows for the previous executed SQL statement.
getQuery (line 276)

Get the current or query, or new JDatabaseQuery object.

  • return: The current value of the internal SQL variable or a new JDatabaseQuery object.
  • since: 11.1
  • throws: JDatabaseException
  • access: public
mixed getQuery ([boolean $new = false])
  • boolean $new: False to return the last query set, True to return a new JDatabaseQuery object.

Redefinition of:
JDatabaseMySQL::getQuery()
Get the current or query, or new JDatabaseQuery object.
getVersion (line 300)

Get the version of the database connector.

  • return: The database connector version.
  • since: 11.1
  • access: public
string getVersion ()

Redefinition of:
JDatabaseMySQL::getVersion()
Get the version of the database connector.
hasUTF (line 313)

Determines if the database engine supports UTF-8 character encoding.

  • return: True if supported.
  • deprecated: 12.1
  • since: 11.1
  • access: public
boolean hasUTF ()

Redefinition of:
JDatabaseMySQL::hasUTF()
Determines if the database engine supports UTF-8 character encoding.
insertid (line 326)

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: 11.1
  • access: public
integer insertid ()

Redefinition of:
JDatabaseMySQL::insertid()
Method to get the auto-incremented value from the last INSERT statement.
queryBatch (line 526)

Execute a query batch.

  • return: A database resource if successful, false if not.
  • deprecated: 12.1
  • since: 11.1
  • access: public
mixed queryBatch ([boolean $abortOnError = true], [boolean $transactionSafe = false])
  • boolean $abortOnError: Abort on error.
  • boolean $transactionSafe: Transaction safe queries.

Redefinition of:
JDatabaseMySQL::queryBatch()
Execute a query batch.
select (line 420)

Select a database for use.

  • return: True if the database was successfully selected.
  • since: 11.1
  • throws: JDatabaseException
  • access: public
boolean select (string $database)
  • string $database: The name of the database to select for use.

Redefinition of:
JDatabaseMySQL::select()
Select a database for use.
setUTF (line 453)

Set the connection to use UTF-8 character encoding.

  • return: True on success.
  • since: 11.1
  • access: public
boolean setUTF ()

Redefinition of:
JDatabaseMySQL::setUTF()
Set the connection to use UTF-8 character encoding.

Inherited Methods

Inherited From JDatabaseMySQL

JDatabaseMySQL::__construct()
JDatabaseMySQL::connected()
JDatabaseMySQL::dropTable()
JDatabaseMySQL::escape()
JDatabaseMySQL::execute()
JDatabaseMySQL::explain()
JDatabaseMySQL::fetchArray()
JDatabaseMySQL::fetchAssoc()
JDatabaseMySQL::fetchObject()
JDatabaseMySQL::freeResult()
JDatabaseMySQL::getAffectedRows()
JDatabaseMySQL::getCollation()
JDatabaseMySQL::getExporter()
JDatabaseMySQL::getImporter()
JDatabaseMySQL::getNumRows()
JDatabaseMySQL::getQuery()
JDatabaseMySQL::getTableColumns()
JDatabaseMySQL::getTableCreate()
JDatabaseMySQL::getTableKeys()
JDatabaseMySQL::getTableList()
JDatabaseMySQL::getVersion()
JDatabaseMySQL::hasUTF()
JDatabaseMySQL::insertid()
JDatabaseMySQL::lockTable()
JDatabaseMySQL::queryBatch()
JDatabaseMySQL::renameTable()
JDatabaseMySQL::select()
JDatabaseMySQL::setUTF()
JDatabaseMySQL::test()
JDatabaseMySQL::transactionCommit()
JDatabaseMySQL::transactionRollback()
JDatabaseMySQL::transactionStart()
JDatabaseMySQL::unlockTables()
JDatabaseMySQL::__destruct()

Inherited From JDatabase

JDatabase::__construct()
JDatabase::addQuoted()
JDatabase::connected()
JDatabase::debug()
JDatabase::dropTable()
JDatabase::escape()
JDatabase::execute()
JDatabase::explain()
JDatabase::fetchArray()
JDatabase::fetchAssoc()
JDatabase::fetchObject()
JDatabase::freeResult()
JDatabase::getAffectedRows()
JDatabase::getCollation()
JDatabase::getConnection()
JDatabase::getConnectors()
JDatabase::getCount()
JDatabase::getDatabase()
JDatabase::getDateFormat()
JDatabase::getErrorMsg()
JDatabase::getErrorNum()
JDatabase::getEscaped()
JDatabase::getInstance()
JDatabase::getLog()
JDatabase::getMinimum()
JDatabase::getNullDate()
JDatabase::getNumRows()
JDatabase::getPrefix()
JDatabase::getQuery()
JDatabase::getTableColumns()
JDatabase::getTableCreate()
JDatabase::getTableFields()
JDatabase::getTableKeys()
JDatabase::getTableList()
JDatabase::getTicker()
JDatabase::getUTFSupport()
JDatabase::getVersion()
JDatabase::hasUTF()
JDatabase::insertid()
JDatabase::insertObject()
JDatabase::isMinimumVersion()
JDatabase::isQuoted()
JDatabase::loadAssoc()
JDatabase::loadAssocList()
JDatabase::loadColumn()
JDatabase::loadNextObject()
JDatabase::loadNextRow()
JDatabase::loadObject()
JDatabase::loadObjectList()
JDatabase::loadResult()
JDatabase::loadResultArray()
JDatabase::loadRow()
JDatabase::loadRowList()
JDatabase::lockTable()
JDatabase::nameQuote()
JDatabase::query()
JDatabase::queryBatch()
JDatabase::quote()
JDatabase::quoteName()
JDatabase::quoteNameStr()
JDatabase::renameTable()
JDatabase::replacePrefix()
JDatabase::select()
JDatabase::setDebug()
JDatabase::setQuery()
JDatabase::setUTF()
JDatabase::splitSql()
JDatabase::stderr()
JDatabase::transactionCommit()
JDatabase::transactionRollback()
JDatabase::transactionStart()
JDatabase::truncateTable()
JDatabase::unlockTables()
JDatabase::updateObject()
JDatabase::__call()

Documentation generated on Mon, 25 Jun 2012 13:58:01 -0500 by phpDocumentor 1.4.4