Moodle  2.2.1
http://www.collinsharper.com
moodle_temptables Class Reference
Inheritance diagram for moodle_temptables:

Public Member Functions

 __construct ($mdb)
 add_temptable ($tablename)
 delete_temptable ($tablename)
 get_temptables ()
 is_temptable ($tablename)
 get_correct_name ($tablename)
 dispose ()

Protected Attributes

 $mdb
 $prefix
 $temptables

Detailed Description

Definition at line 46 of file moodle_temptables.php.


Constructor & Destructor Documentation

__construct ( mdb)

Creates new moodle_temptables instance

Parameters:
objectmoodle_database instance

Definition at line 56 of file moodle_temptables.php.


Member Function Documentation

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 mssql_native_moodle_temptables.

Definition at line 73 of file moodle_temptables.php.

delete_temptable ( tablename)

Delete one temptable from the store

Parameters:
string$tablenamename without prefix of the dropped temptable

Definition at line 83 of file moodle_temptables.php.

dispose ( )

Dispose the temptables stuff, checking for wrong situations, informing and recovering from them

Definition at line 124 of file moodle_temptables.php.

Here is the call graph for this function:

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
Returns:
mixed DB name of the temp table or null if it isn't a temp table

Definition at line 114 of file moodle_temptables.php.

Here is the call graph for this function:

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

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

Definition at line 93 of file moodle_temptables.php.

Here is the caller graph for this function:

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
Returns:
bool true if the table is a temp table (based in the store info), false if not

Definition at line 103 of file moodle_temptables.php.

Here is the caller graph for this function:


Field Documentation

$mdb [protected]

Definition at line 48 of file moodle_temptables.php.

$prefix [protected]

Definition at line 49 of file moodle_temptables.php.

$temptables [protected]

Definition at line 50 of file moodle_temptables.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations