moodle_temptables Class Reference

Inheritance diagram for moodle_temptables:

Public Member Functions
	__construct ($mdb)
	Creates new moodle_temptables instance. More...
	add_temptable ($tablename)
	Add one temptable to the store. More...
	delete_temptable ($tablename)
	Delete one temptable from the store. More...
	dispose ()
	Dispose the temptables stuff, checking for wrong situations, informing and recovering from them.
	get_correct_name ($tablename)
	Given one tablename (no prefix), return the name of the corresponding temporary table, If the table isn't a "registered" temp table, returns null. More...
	get_temptables ()
	Returns all the tablenames (without prefix) existing in the store. More...
	is_temptable ($tablename)
	Returns if one table, based in the information present in the store, is a temp table. More...
	update_stats ()
	Analyze the data in temporary tables to force statistics collection after bulk data loads. More...

Protected Attributes
circular	$mdb
	reference, to be able to use DB facilities here if needed
prefix	$prefix
	to be used for all the DB objects
simple	$temptables
	array of moodle, not prefixed 'tablename' => DB, final (prefixed) 'tablename'

Constructor & Destructor Documentation

__construct()

moodle_temptables::__construct

(

$mdb

)

Creates new moodle_temptables instance.

Parameters

moodle_database

$mdb

An instance of moodle_database.

Member Function Documentation

add_temptable()

moodle_temptables::add_temptable

(

$tablename

)

Add one temptable to the store.

Given one moodle temptable name (without prefix), add it to the store, with the key being the original moodle name and the value being the real db temptable name already prefixed

Override and use this only if the database requires modification in the table name.

Parameters

string

$tablename

name without prefix of the table created as temptable

Reimplemented in sqlsrv_native_moodle_temptables, and oci_native_moodle_temptables.

delete_temptable()

moodle_temptables::delete_temptable

(

$tablename

)

Delete one temptable from the store.

Parameters

string

$tablename

name without prefix of the dropped temptable

get_correct_name()

moodle_temptables::get_correct_name

(

$tablename

)

Given one tablename (no prefix), return the name of the corresponding temporary table, If the table isn't a "registered" temp table, returns null.

Parameters

string

$tablename

name without prefix which corresponding temp tablename needs to know

Return values

mixed

DB name of the temp table or null if it isn't a temp table

get_temptables()

moodle_temptables::get_temptables

(

)

Returns all the tablenames (without prefix) existing in the store.

Return values

array

containing all the tablenames in the store (tablename both key and value)

is_temptable()

moodle_temptables::is_temptable

(

$tablename

)

Returns if one table, based in the information present in the store, is a temp table.

Parameters

string

$tablename

name without prefix of the table we are asking about

Return values

bool	true if the table is a temp table (based in the store info), false if not

update_stats()

moodle_temptables::update_stats

(

)

Analyze the data in temporary tables to force statistics collection after bulk data loads.

The database class detects all temporary tables and will automatically analyze all created tables

Return values

void

Reimplemented in pgsql_native_moodle_temptables.

---

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

• lib/dml/moodle_temptables.php