Inheritance diagram for mysqli_native_moodle_database:

Collaboration diagram for mysqli_native_moodle_database:

Public Member Functions
	create_database ($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null)
	driver_installed ()
	get_dbfamily ()
	get_dbengine ()
	get_name ()
	get_configuration_help ()
	get_configuration_hints ()
	diagnose ()
	connect ($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null)
	dispose ()
	get_server_info ()
	get_last_error ()
	get_tables ($usecache=true)
	get_indexes ($table)
	get_columns ($table, $usecache=true)
	setup_is_unicodedb ()
	change_database_structure ($sql)
	execute ($sql, array $params=null)
	get_recordset_sql ($sql, array $params=null, $limitfrom=0, $limitnum=0)
	get_records_sql ($sql, array $params=null, $limitfrom=0, $limitnum=0)
	get_fieldset_sql ($sql, array $params=null)
	insert_record_raw ($table, $params, $returnid=true, $bulk=false, $customsequence=false)
	insert_record ($table, $dataobject, $returnid=true, $bulk=false)
	import_record ($table, $dataobject)
	update_record_raw ($table, $params, $bulk=false)
	update_record ($table, $dataobject, $bulk=false)
	set_field_select ($table, $newfield, $newvalue, $select, array $params=null)
	delete_records_select ($table, $select, array $params=null)
	sql_cast_char2int ($fieldname, $text=false)
	sql_cast_char2real ($fieldname, $text=false)
	sql_like ($fieldname, $param, $casesensitive=true, $accentsensitive=true, $notlike=false, $escapechar= '\\')
	sql_concat ()
	sql_concat_join ($separator="' '", $elements=array())
	sql_length ($fieldname)
	sql_regex_supported ()
	sql_regex ($positivematch=true)
	sql_cast_2signed ($fieldname)
	session_lock_supported ()
	session locking
	get_session_lock ($rowid, $timeout)
	release_session_lock ($rowid)
Protected Member Functions
	get_dbtype ()
	get_dblibrary ()
	allowed_param_types ()
	normalise_value ($column, $value)
	emulate_bound_params ($sql, array $params=null)
	create_recordset ($result)
	transactions_supported ()
	transactions
	begin_transaction ()
	commit_transaction ()
	rollback_transaction ()
Protected Attributes
	$mysqli = null

Detailed Description

Native mysqli class representing moodle database interface.

Definition at line 37 of file mysqli_native_moodle_database.php.

Member Function Documentation

allowed_param_types ( ) [protected]

Returns supported query parameter types

Returns:: int bitmask

Reimplemented from moodle_database.

Definition at line 353 of file mysqli_native_moodle_database.php.

begin_transaction ( ) [protected]

Driver specific start of real database transaction, this can not be used directly in code.

Returns:: void

Reimplemented from moodle_database.

Definition at line 1286 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

change_database_structure ( $ sql )

Do NOT use in code, to be used by database_manager only!

Parameters:

string $sql query

Returns:: bool true

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 664 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

commit_transaction ( ) [protected]

Driver specific commit of real database transaction, this can not be used directly in code.

Returns:: void

Reimplemented from moodle_database.

Definition at line 1307 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

connect	(	$	dbhost,
		$	dbuser,
		$	dbpass,
		$	dbname,
		$	prefix,
		array $	dboptions = `null`
	)

Connect to db Must be called before other methods.

Parameters:

string	$dbhost
string	$dbuser
string	$dbpass
string	$dbname
mixed	$prefix	string means moodle db prefix, false used for external databases where prefix not used
array	$dboptions	driver specific options

Returns:: bool success

Reimplemented from moodle_database.

Definition at line 269 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

create_database	(	$	dbhost,
		$	dbuser,
		$	dbpass,
		$	dbname,
		array $	dboptions = `null`
	)

Attempt to create the database

Parameters:

string	$dbhost
string	$dbuser
string	$dbpass
string	$dbname

Returns:: bool success

Exceptions:

dml_exception if error

Connect without db

Reimplemented from moodle_database.

Definition at line 52 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

create_recordset ( $ result ) [protected]

Definition at line 773 of file mysqli_native_moodle_database.php.

Here is the caller graph for this function:

delete_records_select	(	$	table,
		$	select,
		array $	params = `null`
	)

Delete one or more records from a table which match a particular WHERE clause.

Parameters:

string	$table	The database table to be checked against.
string	$select	A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
array	$params	array of sql parameters

Returns:: bool true

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 1085 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

diagnose ( )

Diagnose database and tables, this function is used to verify database and driver settings, db engine types, etc.

Returns:: string null means everything ok, string means problem found.

Reimplemented from moodle_database.

Definition at line 234 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

dispose ( )

Close database connection and release all resources and memory (especially circular memory references). Do NOT use connect() again, create a new instance if needed.

Reimplemented from moodle_database.

Definition at line 333 of file mysqli_native_moodle_database.php.

driver_installed ( )

Detects if all needed PHP stuff installed. Note: can be used before connect()

Returns:: mixed true if ok, string if something

Reimplemented from moodle_database.

Definition at line 100 of file mysqli_native_moodle_database.php.

Here is the caller graph for this function:

emulate_bound_params	(	$	sql,
		array $	params = `null`
	)		`[protected]`

Very ugly hack which emulates bound parameters in queries because prepared statements do not use query cache.

ok, we have verified sql statement with ? and correct number of params

Definition at line 678 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

execute	(	$	sql,
		array $	params = `null`
	)

Execute general sql query. Should be used only when no other method suitable. Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!

Parameters:

string	$sql	query
array	$params	query parameters

Returns:: bool true

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 711 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_columns	(	$	table,
		$	usecache = `true`
	)

Returns detailed information about columns in table. This information is cached internally.

Parameters:

string	$table	name
bool	$usecache

Returns:: array array of database_column_info objects indexed with column names

Reimplemented from moodle_database.

Definition at line 428 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_configuration_help ( )

Returns localised database configuration help. Note: can be used before connect()

Returns:: string

Reimplemented from moodle_database.

Definition at line 215 of file mysqli_native_moodle_database.php.

get_configuration_hints ( )

Returns localised database description Note: can be used before connect()

Returns:: string

Reimplemented from moodle_database.

Definition at line 224 of file mysqli_native_moodle_database.php.

get_dbengine ( )

Returns the current MySQL db engine.

This is an ugly workaround for MySQL default engine problems, Moodle is designed to work best on ACID compliant databases with full transaction support. Do not use MyISAM.

Returns:: string or null MySQL engine name

Definition at line 143 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_dbfamily ( )

Returns database family type - describes SQL dialect Note: can be used before connect()

Returns:: string db family name (mysql, postgres, mssql, oracle, etc.)

Reimplemented from moodle_database.

Definition at line 112 of file mysqli_native_moodle_database.php.

get_dblibrary ( ) [protected]

Returns general database library name Note: can be used before connect()

Returns:: string db type pdo, native

Reimplemented from moodle_database.

Definition at line 130 of file mysqli_native_moodle_database.php.

get_dbtype ( ) [protected]

Returns more specific database driver type Note: can be used before connect()

Returns:: string db type mysqli, pgsql, oci, mssql, sqlsrv

Reimplemented from moodle_database.

Definition at line 121 of file mysqli_native_moodle_database.php.

get_fieldset_sql	(	$	sql,
		array $	params = `null`
	)

Selects records and return values (first field) as an array using a SQL statement.

Parameters:

string	$sql	The SQL query
array	$params	array of sql parameters

Returns:: array of values

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 835 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_indexes ( $ table )

Return table indexes - everything lowercased

Returns:: array of arrays

Reimplemented from moodle_database.

Definition at line 401 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_last_error ( )

Returns last error reported by database engine.

Returns:: string error message

Reimplemented from moodle_database.

Definition at line 361 of file mysqli_native_moodle_database.php.

get_name ( )

Returns localised database type name Note: can be used before connect()

Returns:: string

Reimplemented from moodle_database.

Definition at line 206 of file mysqli_native_moodle_database.php.

get_records_sql	(	$	sql,
		array $	params = `null`,
		$	limitfrom = `0`,
		$	limitnum = `0`
	)

Get a number of records as an array of objects using a SQL statement.

Return value as for

See also:: function get_records.

Parameters:

string	$sql	the SQL select query to execute. The first column of this SELECT statement must be a unique value (usually the 'id' field), as it will be used as the key of the returned array.
array	$params	array of sql parameters
int	$limitfrom	return a subset of records, starting at this point (optional, required if $limitnum is set).
int	$limitnum	return a subset comprising this many records (optional, required if $limitfrom is set).

Returns:: array of objects, or empty array if no records were found

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 791 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_recordset_sql	(	$	sql,
		array $	params = `null`,
		$	limitfrom = `0`,
		$	limitnum = `0`
	)

Get a number of records as a moodle_recordset using a SQL statement.

Since this method is a little less readable, use of it should be restricted to code where it's possible there might be large datasets being returned. For known small datasets use get_records_sql - it leads to simpler code.

The return type is as for

See also:: function get_recordset.

Parameters:

string	$sql	the SQL select query to execute.
array	$params	array of sql parameters
int	$limitfrom	return a subset of records, starting at this point (optional, required if $limitnum is set).
int	$limitnum	return a subset comprising this many records (optional, required if $limitfrom is set).

Returns:: moodle_recordset instance

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 749 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_server_info ( )

Returns database server info array

Returns:: array

Reimplemented from moodle_database.

Definition at line 345 of file mysqli_native_moodle_database.php.

Here is the caller graph for this function:

get_session_lock	(	$	rowid,
		$	timeout
	)

Obtain session lock

Parameters:

int	$rowid	id of the row with session record
int	$timeout	max allowed time to wait for the lock in seconds

Returns:: bool success

Reimplemented from moodle_database.

Definition at line 1212 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

get_tables ( $ usecache = true )

Return tables in database WITHOUT current prefix

Returns:: array of table names in lowercase and without prefix

Reimplemented from moodle_database.

Definition at line 369 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

import_record	(	$	table,
		$	dataobject
	)

Import a record into a table, id field is required. Safety checks are NOT carried out. Lobs are supported.

Parameters:

string	$table	name of database table to be inserted into
object	$dataobject	A data object with values for one or more fields in the record

Returns:: bool true

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 947 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

insert_record	(	$	table,
		$	dataobject,
		$	returnid = `true`,
		$	bulk = `false`
	)

Insert a record into a table and return the "id" field if required.

Some conversions and safety checks are carried out. Lobs are supported. If the return ID isn't required, then this just reports success as true/false. $data is an object containing needed data

Parameters:

string	$table	The database table to be inserted into
object	$data	A data object with values for one or more fields in the record
bool	$returnid	Should the id of the newly created record entry be returned? If this option is not requested then true/false is returned.

Returns:: bool|int true or new id

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 918 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

insert_record_raw	(	$	table,
		$	params,
		$	returnid = `true`,
		$	bulk = `false`,
		$	customsequence = `false`
	)

Insert new record into database, as fast as possible, no safety checks, lobs not supported.

Parameters:

string	$table	name
mixed	$params	data record as object or array
bool	$returnit	return it of inserted record
bool	$bulk	true means repeated inserts expected
bool	$customsequence	true if 'id' included in $params, disables $returnid

Returns:: bool|int true or new id

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 863 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

normalise_value	(	$	column,
		$	value
	)		`[protected]`

Normalise values based in RDBMS dependencies (booleans, LOBs...)

Parameters:

database_column_info	$column	column metadata corresponding with the value we are going to normalise
mixed	$value	value we are going to normalise

Returns:: mixed the normalised value

Reimplemented from moodle_database.

Definition at line 588 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

release_session_lock ( $ rowid )

Release session lock

Parameters:

int $rowid id of the row with session record

Returns:: bool success

Reimplemented from moodle_database.

Definition at line 1233 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

rollback_transaction ( ) [protected]

Driver specific abort of real database transaction, this can not be used directly in code.

Returns:: void

Reimplemented from moodle_database.

Definition at line 1323 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

session_lock_supported ( )

session locking

Reimplemented from moodle_database.

Definition at line 1202 of file mysqli_native_moodle_database.php.

set_field_select	(	$	table,
		$	newfield,
		$	newvalue,
		$	select,
		array $	params = `null`
	)

Set a single field in every table record which match a particular WHERE clause.

Parameters:

string	$table	The database table to be checked against.
string	$newfield	the field to set.
string	$newvalue	the value to set the field to.
string	$select	A fragment of SQL to be used in a where clause in the SQL call.
array	$params	array of sql parameters

Returns:: bool true

Exceptions:

dml_exception if error

Reimplemented from moodle_database.

Definition at line 1045 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

setup_is_unicodedb ( )

Is db in unicode mode?

Returns:: bool

Reimplemented from moodle_database.

Definition at line 618 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

sql_cast_2signed ( $ fieldname )

Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.

(Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615 if the 1 comes from an unsigned column).

Parameters:

string $fieldname the name of the field to be cast

Returns:: string the piece of SQL code to be used in your statement.

Reimplemented from moodle_database.

Definition at line 1197 of file mysqli_native_moodle_database.php.

sql_cast_char2int	(	$	fieldname,
		$	text = `false`
	)

Returns the SQL to be used in order to CAST one CHAR column to INTEGER.

Be aware that the CHAR column you're trying to cast contains really int values or the RDBMS will throw an error!

Parameters:

string	$fieldname	the name of the field to be casted
bool	$text	to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.

Returns:: string the piece of SQL code to be used in your statement.

Reimplemented from moodle_database.

Definition at line 1101 of file mysqli_native_moodle_database.php.

sql_cast_char2real	(	$	fieldname,
		$	text = `false`
	)

Returns the SQL to be used in order to CAST one CHAR column to REAL number.

Be aware that the CHAR column you're trying to cast contains really numbers or the RDBMS will throw an error!

Parameters:

string	$fieldname	the name of the field to be casted
bool	$text	to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.

Returns:: string the piece of SQL code to be used in your statement.

Reimplemented from moodle_database.

Definition at line 1105 of file mysqli_native_moodle_database.php.

sql_concat ( )

Returns the proper SQL to do CONCAT between the elements passed Can take many parameters

Parameters:

string $str,... 1 or more fields/strings to concat

Returns:: string The concat sql

Reimplemented from moodle_database.

Definition at line 1146 of file mysqli_native_moodle_database.php.

sql_concat_join	(	$	separator = `"' '"`,
		$	elements = `array()`
	)

Returns the proper SQL to do CONCAT between the elements passed with a given separator

Parameters:

string	$separator	The string to use as the separator
array	$elements	An array of items to concatenate

Returns:: string The concat SQL

Reimplemented from moodle_database.

Definition at line 1163 of file mysqli_native_moodle_database.php.

sql_length ( $ fieldname )

Returns the SQL text to be used to calculate the length in characters of one expression.

Parameters:

string fieldname or expression to calculate its length in characters.

Returns:: string the piece of SQL code to be used in the statement.

Reimplemented from moodle_database.

Definition at line 1177 of file mysqli_native_moodle_database.php.

sql_like	(	$	fieldname,
		$	param,
		$	casesensitive = `true`,
		$	accentsensitive = `true`,
		$	notlike = `false`,
		$	escapechar = `'\\'`
	)

Returns 'LIKE' part of a query.

Parameters:

string	$fieldname	usually name of the table column
string	$param	usually bound query parameter (?, :named)
bool	$casesensitive	use case sensitive search
bool	$accensensitive	use accent sensitive search (not all databases support accent insensitive)
bool	$notlike	true means "NOT LIKE"
string	$escapechar	escape char for '' and '_'

Returns:: string SQL code fragment

Reimplemented from moodle_database.

Definition at line 1120 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

sql_regex ( $ positivematch = true )

Return regex positive or negative match sql

Parameters:

bool $positivematch

Returns:: string or empty if not supported

Reimplemented from moodle_database.

Definition at line 1193 of file mysqli_native_moodle_database.php.

sql_regex_supported ( )

Does this driver support regex syntax when searching

Reimplemented from moodle_database.

Definition at line 1184 of file mysqli_native_moodle_database.php.

transactions_supported ( ) [protected]

transactions

Are transactions supported? It is not responsible to run productions servers on databases without transaction support ;-)

MyISAM does not support support transactions.

You can override this via the dbtransactions option.

Returns:: bool

Reimplemented from moodle_database.

Definition at line 1258 of file mysqli_native_moodle_database.php.

Here is the call graph for this function:

Here is the caller graph for this function:

update_record	(	$	table,
		$	dataobject,
		$	bulk = `false`
	)

Update a record in a table

$dataobject is an object containing needed data Relies on $dataobject having a variable "id" to specify the record to update

Parameters:

string	$table	The database table to be checked against.
object	$dataobject	An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
	bool	true means repeated updates expected