Abstract Class Dal_Table

Description

An abstract class defining the interface for creating Max database tables.

Note that only permanent tables are created with the table prefix defined in the configuration .ini file - temporary tables do NOT use the table prefix. This is because temporary tables are not defined in the table array in the configuration .ini file, and as such, must be referenced in the Data Access Layer code directly, and this is easier to do if the prefix doesn't have to be prepended in order to do so.

  • abstract:

Located in /maintenance/libraries/max/Dal/Table.php (line 50)


	
			
Direct descendents
Class Description
 class Dal_Table_Core A class for creating the core Max database tables.
 class Maintenance_Table_Statistics A class for creating the temporary Max database tables required for performing the maintenance statistics functions.
Variable Summary
 mixed $conf
 mixed $dal
 mixed $splitTables
 mixed $tables
Method Summary
 Dal_Table Dal_Table (string $file)
 string createTable (string $table, [Date $date = NULL])
 void dropTable (string $table)
 void dropTempTable (string $table)
Variables
mixed $conf (line 52)
mixed $dal (line 53)
mixed $splitTables (line 55)
mixed $tables (line 54)
Methods
Constructor Dal_Table (line 63)

The constructor method.

Dal_Table Dal_Table (string $file)
  • string $file: The name of the SQL file to parse for the table definitions.
createTable (line 120)

A factory method for creating tables.

  • return: The name of the table created.
string createTable (string $table, [Date $date = NULL])
  • string $table: The name of the table to create.
  • Date $date: An optional date for creating split tables. Will use current date if required and not supplied.
dropTable (line 158)

A method for dropping tables.

void dropTable (string $table)
  • string $table: The table name to drop. Use the table name WITH prefix (i.e. obtained from parsing the configuration .ini file).
dropTempTable (line 170)

A method for dropping temporary tables.

void dropTempTable (string $table)
  • string $table: The temporary table to drop.

Documentation generated on Fri, 3 Dec 2004 12:27:43 +0000 by phpDocumentor 1.3.0RC3