JDatabase/1.5

JDatabase

Description

JDatabase is an abstract class which is extended by specific database drivers. It provides database connections for Joomla.

Methods

Visibility	Method name	Description
public	__construct	Database object constructor.
public	__destruct	Database object destructor.
public	addQuoted	Adds a field or array of field names to the list that are to be quoted.
public	BeginTrans	ADODB compatability function.
public	CommitTrans	ADODB compatability function.
public	connected	Determines if the connection to the server is active.
public	debug	Sets the debug level on or off.
public	ErrorMsg	ADODB compatability function.
public	ErrorNo	ADODB compatability function.
public	Execute	ADODB compatability function.
public	explain	Diagnostic function.
public	GenID	ADODB compatability function.
public	getAffectedRows	Get the affected rows by the most recent query.
public	GetCol	ADODB compatability function.
public	getCollation	Get the database collation.
public	getConnectors	Get the database connectors.
public	getErrorMsg	Get the error message.
public	getErrorNum	Get the error number.
public	getEscaped	Get a database escaped string.
public	getInstance	Returns a reference to the global Database object, only creating it if it doesn't already exist.
public	getLog	Get a database error log.
public	getNullDate	Get the database null date.
public	getNumRows	Get the number of rows returned by the most recent query.
public	GetOne	ADODB compatability function.
public	getPrefix	Get the database table prefix.
public	getQuery	Get the active query.
public	GetRow	ADODB compatability function.
public	getTableCreate	Shows the CREATE TABLE statement that creates the given tables.
public	getTableFields	Retrieves information about the given tables.
public	getTableList	List tables in a database.
public	getTicker	Get the total number of queries made.
public	getUTFSupport	Get the database UTF-8 support.
public	getVersion	Get the version of the database connector.
public	hasUTF	Determines UTF support.
public	insertid	Get the ID generated from the previous INSERT operation.
public	insertObject	Inserts a row into a table based on an objects properties.
public	isQuoted	Checks if field name needs to be quoted.
public	loadAssoc	Fetch a result row as an associative array.
public	loadAssocList	Load a associactive list of database rows.
public	loadObject	This global function loads the first row of a query into an object.
public	loadObjectList	Load a list of database objects.
public	loadResult	This method loads the first field of the first row returned by the query.
public	loadResultArray	Load an array of single field results into an array.
public	loadRow	Load the first row returned by the query.
public	loadRowList	Load a list of database rows (numeric column indexing).
public	nameQuote	Quote an identifier name (field, table, etc).
public	PageExecute	ADODB compatability function.
public	query	Execute the query.
public	queryBatch	Execute a batch query.
public	Quote	Get a quoted database escaped string.
public	replacePrefix	This function replaces a string identifier with the string held is the class variable.
public	RollbackTrans	ADODB compatability function.
public	SelectLimit	ADODB compatability function.
public	setQuery	Sets the SQL query string for later execution.
public	setUTF	Custom settings for UTF support.
public	splitSql	Splits a string of queries into an array of individual queries.
public	stderr	Print out an error statement.
public	updateObject	Update an object in the database.
public	test	Test to see if the MySQLi connector is available.

• Defined in libraries/joomla/database/database.php
• Extends JObject
• Extended by
  • JDatabaseMySQL
  • JDatabaseMySQLi

Importing

jimport( 'joomla.database.database' );

See also

• JDatabase on api.joomla.org
• JDatabase source code on JoomlaCode
• Subpackage Database
• Other versions of JDatabase
• Accessing the database using JDatabase

User contributed notes

<CodeExamplesForm />