Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
moodle_temptables Class Reference
Inheritance diagram for moodle_temptables:
mysqli_native_moodle_temptables oci_native_moodle_temptables pgsql_native_moodle_temptables sqlsrv_native_moodle_temptables

Public Member Functions

 __construct ($mdb)
 Creates new moodle_temptables instance.
 
 add_temptable ($tablename)
 Add one temptable to the store.
 
 delete_temptable ($tablename)
 Delete one temptable from the store.
 
 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.
 
 get_temptables ()
 Returns all the tablenames (without prefix) existing in the store.
 
 is_temptable ($tablename)
 Returns if one table, based in the information present in the store, is a temp table.
 
 update_stats ()
 Analyze the data in temporary tables to force statistics collection after bulk data loads.
 

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$mdbAn 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$tablenamename without prefix of the table created as temptable

Reimplemented in oci_native_moodle_temptables, and sqlsrv_native_moodle_temptables.

◆ delete_temptable()

moodle_temptables::delete_temptable ( $tablename)

Delete one temptable from the store.

Parameters
string$tablenamename 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$tablenamename without prefix which corresponding temp tablename needs to know
Return values
mixedDB 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
arraycontaining 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$tablenamename without prefix of the table we are asking about
Return values
booltrue 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: