Inheritance diagram for DatabaseInterface:

Collaboration diagram for DatabaseInterface:

Public Member Functions
	forceMasterConnection ()
	setFetchMode ($fetchMode)
	getOne ($query, $parameters=array(), $executeOnSlave=true)
	getRow ($sqlSelect, $parameters=array(), $executeOnSlave=true)
	getCol ($sqlSelect, $parameters=array(), $executeOnSlave=true)
	getAll ($query, $parameters=array(), $executeOnSlave=true)
	select ($sqlSelect, $parameters=array(), $executeOnSlave=true)
	selectLimit ($sqlSelect, $rowCount=-1, $offset=-1, $parameters=array(), $executeOnSlave=true)
	execute ($query, $parameters=array())
	quote ($value)
	quoteArray ($array)
	metaColumns ($table)
	startTransaction ()
	commitTransaction ()
	rollbackTransaction ()
	setTransactionIsolationLevel ($level)

Public Attributes
const	FETCH_MODE_DEFAULT = 0
const	FETCH_MODE_NUM = 1
const	FETCH_MODE_ASSOC = 2
const	FETCH_MODE_BOTH = 3

Detailed Description

The database connection interface specifies how a database connection should look and act.

Definition at line 8 of file DatabaseInterface.php.

Member Function Documentation

DatabaseInterface::commitTransaction ( )

Commit a database transaction.

Exceptions

Exception

Implemented in oxLegacyDb.

DatabaseInterface::execute	(	$query,
		$parameters = `array()`
	)

Execute non read statements like INSERT, UPDATE, DELETE and return the number of rows affected by the statement.

Execute read statements like SELECT or SHOW and return the results as a ResultSet. (This behavior is deprecated since v5.3.0 (2016-06-06) This method has to be used EXCLUSIVELY for non read statements in v6.0)

IMPORTANT: You are strongly encouraged to use prepared statements like this: $resultSet = DatabaseInterfaceImplementation::getDb->execute( 'DELETE * FROM mytable WHERE id = ? OR id = ?', array($id1, $id2) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$query	The sql statement we want to execute.
array	$parameters	The parameters array.

Returns: object

Deprecated:: since v5.3.0 (2016-06-06) This method will return an integer as the number of rows affected by the statement for non read statements. An exception will be thrown, if a read statement is passed to this function.

Implemented in oxLegacyDb.

DatabaseInterface::forceMasterConnection ( )

Force database master connection.

Hint: this method is here to have an easier update path. It will be implemented in the OXID eShop version 6.0.

Implemented in oxLegacyDb.

DatabaseInterface::getAll	(	$query,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Get an multi-dimensional array of arrays with the values of the all rows of a given sql SELECT or SHOW statement. Returns an empty array for any other statement.

The keys of the first level array are numeric. The keys of the second level arrays may be numeric, strings or both, depending on the FETCH_MODE_* of the connection. Set the desired fetch mode with DatabaseInterface::setFetchMode() before calling this method.

IMPORTANT: You are strongly encouraged to use prepared statements like this: $result = DatabaseInterfaceImplementation::getDb->getAll( 'SELECT * FROM mytable WHERE id = ? OR id = ? LIMIT 0, 1', array($id1, $id2) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$query	If parameters are given, the "?" in the string will be replaced by the values in the array
array	$parameters	Array of parameters, for the given sql statement.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

See Also: DatabaseInterface::setFetchMode(); Doctrine::$fetchMode

Returns: array

Implemented in oxLegacyDb.

DatabaseInterface::getCol	(	$sqlSelect,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Return the first column of all rows of the results of a given sql SELECT or SHOW statement as an numeric array. Throws an exception for any other statement.

IMPORTANT: You are strongly encouraged to use prepared statements like this: $result = DatabaseInterfaceImplementation::getDb->getRow( 'SELECT * FROM mytable WHERE id = ? LIMIT 0, 1', array($id1) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$sqlSelect	The sql select statement
array	$parameters	The parameters array.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

Returns: array The values of the first column of a corresponding sql query.

Implemented in oxLegacyDb.

DatabaseInterface::getOne	(	$query,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Get the first value of the first row of the result set of a given sql SELECT or SHOW statement. Returns false for any other statement.

NOTE: Although you might pass any SELECT or SHOW statement to this method, try to limit the result of the statement to one single row, as the rest of the rows is simply discarded.

Parameters

string	$query	The sql SELECT or SHOW statement.
array	$parameters	Array of parameters for the given sql statement.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

Returns: string|false Returns a string for SELECT or SHOW statements and FALSE for any other statement.

Implemented in oxLegacyDb.

DatabaseInterface::getRow	(	$sqlSelect,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Get an array with the values of the first row of a given sql SELECT or SHOW statement . Returns an empty array for any other statement.

The keys of the array may be numeric, strings or both, depending on the FETCH_MODE_* of the connection. Set the desired fetch mode with DatabaseInterface::setFetchMode() before calling this method.

NOTE: Although you might pass any SELECT or SHOW statement to this method, try to limit the result of the statement to one single row, as the rest of the rows is simply discarded.

IMPORTANT: You are strongly encouraged to use prepared statements like this: $result = DatabaseInterfaceImplementation::getDb->getOne( 'SELECT id FROM mytable WHERE id = ? LIMIT 0, 1', array($id1) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$sqlSelect	The sql select statement we want to execute.
array	$parameters	Array of parameters, for the given sql statement.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

Returns: array

Implemented in oxLegacyDb.

DatabaseInterface::metaColumns ( $table )

Return the meta data for the columns of a table.

Parameters

string $table The name of the table.

Returns: array The meta information about the columns.

Implemented in oxLegacyDb.

DatabaseInterface::quote ( $value )

Quote a string or a numeric value in a way, that it might be used as a value in a sql statement. Returns false for values that cannot be quoted.

NOTE: It is not safe to use the return value of this function in a query. There will be no risk of SQL injection, but when the statement is executed and the value could not have been quoted, a DatabaseException is thrown. You are strongly encouraged to always use prepared statements instead of quoting the values on your own. E.g. use $resultSet = DatabaseInterfaceImplementation::getDb->select( 'SELECT * FROM mytable WHERE id = ? OR id = ?', array($id1, $id2) ); instead of $resultSet = DatabaseInterfaceImplementation::getDb->select( 'SELECT * FROM mytable WHERE id = ' . DatabaseInterfaceImplementation::getDb->quote($id1) . ' OR id = ' . DatabaseInterfaceImplementation::getDb->quote($id1) );

Parameters

mixed $value The string or numeric value to be quoted.

Returns: false|string The given string or numeric value converted to a string surrounded by single quotes or set to false, if the value could not have been quoted.

Implemented in oxLegacyDb.

DatabaseInterface::quoteArray ( $array )

Quote every value in a given array in a way, that it might be used as a value in a sql statement and return the result as a new array. Numeric values will be converted to strings which quotes. The keys and their order of the returned array will be the same as of the input array.

NOTE: It is not safe to use the return value of this function in a query. There will be no risk of SQL injection, but when the statement is executed and the value could not have been quoted, a DatabaseException is thrown. You are strongly encouraged to always use prepared statements instead of quoting the values on your own.

Parameters

array $array The strings to quote as an array.

Returns: array Array with all string and numeric values quoted with single quotes or set to false, if the value could not have been quoted.

Implemented in oxLegacyDb.

DatabaseInterface::rollbackTransaction ( )

RollBack a database transaction.

Exceptions

Exception

Implemented in oxLegacyDb.

DatabaseInterface::select	(	$sqlSelect,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Return the results of a given sql SELECT or SHOW statement as a ResultSet. Throws an exception for any other statement.

The values of first row of the result may be via resultSet's fields property. This property is an array, which keys may be numeric, strings or both, depending on the FETCH_MODE_* of the connection. All further rows can be accessed via the specific methods of ResultSet.

IMPORTANT: You are strongly encouraged to use prepared statements like this: $resultSet = DatabaseInterfaceImplementation::getDb->select( 'SELECT * FROM mytable WHERE id = ? OR id = ?', array($id1, $id2) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$sqlSelect	The sql select statement
array	$parameters	The parameters array.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

Exceptions

Exception The exception, that can occur while executing the sql statement.

Returns: object The result of the given query.

Deprecated:: since v5.3.0 (2016-06-16) This method will return an instance of ResultSetInterface in v6.0.

Implemented in oxLegacyDb.

DatabaseInterface::selectLimit	(	$sqlSelect,
		$rowCount = `-1`,
		$offset = `-1`,
		$parameters = `array()`,
		$executeOnSlave = `true`
	)

Return the results of a given sql SELECT or SHOW statement limited by a LIMIT clause as a ResultSet. Throws an exception for any other statement.

The values of first row of the result may be via resultSet's fields property. This property is an array, which keys may be numeric, strings or both, depending on the FETCH_MODE_* of the connection. All further rows can be accessed via the specific methods of ResultSet.

IMPORTANT: You are strongly encouraged to use prepared statements like this: $resultSet = DatabaseInterfaceImplementation::getDb->selectLimit( 'SELECT * FROM mytable WHERE id = ? OR id = ?', $rowCount, $offset, array($id1, $id2) ); If you will not use prepared statements, you MUST quote variables the values with quote(), otherwise you create a SQL injection vulnerability.

Parameters

string	$sqlSelect	The sql select statement
int	$rowCount	Maximum number of rows to return
int	$offset	Offset of the first row to return
array	$parameters	The parameters array.
bool	$executeOnSlave	Execute this statement on the slave database. Only evaluated in a master-slave setup. This parameter is deprecated since v5.3.0 (2016-06-17). Different solution in 6.0.

Exceptions

Exception The exception, that can occur while executing the sql statement.

Returns: object The result of the given query.

Deprecated:: since v5.3.0 (2016-06-16) This method will return an instance of ResultSetInterface in v6.0.

Implemented in oxLegacyDb.

DatabaseInterface::setFetchMode ( $fetchMode )

Set the fetch mode of an open database connection.

After the connection has been opened, this method may be used to set the fetch mode to any of the valid fetch modes as defined in DatabaseInterface::FETCH_MODE_*

NOTE: This implies, that it is not safe to make any assumptions about the current fetch mode of the connection.

Parameters

int $fetchMode See DatabaseInterface::FETCH_MODE_* for valid values

Implemented in oxLegacyDb.

DatabaseInterface::setTransactionIsolationLevel ( $level )

Set the transaction isolation level. Allowed values 'READ UNCOMMITTED', 'READ COMMITTED', 'REPEATABLE READ' and 'SERIALIZABLE'.

NOTE: Currently the transaction isolation level is set on the database session and not globally. Setting the transaction isolation level globally requires root privileges in MySQL an this application should not be executed with root privileges. If you need to set the transaction isolation level globally, ask your database administrator to do so,

Parameters

string $level The transaction isolation level

Exceptions

Exception

Implemented in oxLegacyDb.

DatabaseInterface::startTransaction ( )

Start a database transaction.

Exceptions

Exception

Implemented in oxLegacyDb.

Member Data Documentation

const DatabaseInterface::FETCH_MODE_ASSOC = 2

Fetch the query result into an array with string keys

Definition at line 25 of file DatabaseInterface.php.

const DatabaseInterface::FETCH_MODE_BOTH = 3

Fetch the query result into a mixed array with both integer and string keys

Definition at line 28 of file DatabaseInterface.php.

const DatabaseInterface::FETCH_MODE_DEFAULT = 0

The default fetch mode as implemented by the database driver, in Doctrine this is usually FETCH_MODE_BOTH

Deprecated:: since 6.0 (2016-04-19); This constant is confusing as the shop uses a different default fetch mode.

Definition at line 16 of file DatabaseInterface.php.

const DatabaseInterface::FETCH_MODE_NUM = 1

Fetch the query result into an array with integer keys. This is the default fetch mode as it is set by OXID eShop on opening a database connection.

Definition at line 22 of file DatabaseInterface.php.

The documentation for this interface was generated from the following file:

core/interface/DatabaseInterface.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation