Class: DB_Table_Generator

This class generates the php code necessary to use the DB_Table package to interact with an existing database. This requires the generation of a skeleton subclass definition be generated for each table in the database, in which the $col, $idx, and $auto_inc_col properties are constructed using a table schema that is obtained by querying the database.

The class can also generate a file, named 'Database.php' by default, that includes (require_once) each of the table subclass definitions, instantiates one object of each DB_Table subclass (i.e., one object for each table), instantiates a parent DB_Table_Database object, adds all the tables to that parent, attempts to guess foreign key relationships between tables based on the column names, and adds the inferred references to the parent object.

All of the code is written to a directory whose path is given by the property $class_write_path. By default, this is the current directory. By default, the name of the class constructed for a table named 'thing' is "Thing_Table". That is, the class name is the table name, with the first letter upper case, with a suffix '_Table'. This suffix can be changed by setting the $class_suffix property. The file containing a subclass definition is the subclass name with a php extension, e.g., 'Thing_Table.php'. The object instantiated from that subclass is the same as the table name, with no suffix, e.g., 'thing'.

To generate the code for all of the tables in a database named $database, instantiate a MDB2 or DB object named $db that connects to the database of interest, and execute the following code:

     $generator = new DB_Table_Generator($db, $database);

     $generator->class_write_path = $class_write_path;
     $generator->generateTableClassFiles();
     $generator->generateDatabaseFile();

By default, ->generateTableClassFiles() and ->generateDatabaseFiles() generate code for all of the tables in the current database. To generate code for a specified list of tables, set the value of the public $tables property to a sequential list of table names before calling either of these methods. Code can be generated for three tables named 'table1', 'table2', and 'table3' as follows:

     $generator = new DB_Table_Generator($db, $database);

     $generator->class_write_path = $class_write_path;
     $generator->tables = array('table1', 'table2', 'table3');
     $generator->generateTableClassFiles();
     $generator->generateDatabaseFile();

PHP version 4 and 5

$auto_inc_col = array()

[line 333]

Array $this->auto_inc_col[table_name] = auto-increment column

$class_include_path =  ''

[line 299]

Used to create require_once statements in the Database.php file, which is in the same directory as the class definition files. Leave as empty string if your PHP include_path contains ".". The value should not include a trailing "/", which is added automatically to values other than the empty string.

$class_suffix =  "_Table"

[line 275]

$class_write_path =  ''

[line 285]

Value should not include a trailing "/".

$col = array()

[line 311]

Array $this->col[table_name][column_name] = column definition. Column definition is an array with the same format as the $col property of a DB_Table object

$error =  null

[line 243]

This property is used only for errors encountered in the constructor at instantiation time. To check if there was an instantiation error...

     $obj =& new DB_Table_Generator();

     if ($obj->error) {
         // ... error handling code here ...
     }

$extends =  'DB_Table'

[line 259]

$extends_file =  'DB/Table.php'

[line 267]

$idx = array()

[line 323]

Array $this->idx[table_table][index_name] = Index definition. The index definition is an array with the same format as the DB_Table $idx property property array.

$idxname_format =  '%s'

[line 353]

For use in printf() formatting. Use '%s' to use index names as returned by getTableConstraints/Indexes, and '%s_idx' to add an '_idx' suffix. For MySQL, use the default value '%'.

$name =  null

[line 209]

$primary_key = array()

[line 341]

$tables = array()

[line 251]

DB_Table_Generator (Constructor)   [line 372]

buildTableClass   [line 807]

buildTableClasses   [line 956]

     $generator = new DB_Table_Generator($db, $database);

     echo $generator->buildTablesClasses();

classFileName   [line 1323]

className   [line 1285]

generateDatabaseFile   [line 1074]

     $generator = new DB_Table_Generator($db, $database);

     $generator->generateTableClassFiles();
     $generator->generateDatabaseFile();

generateTableClassFiles   [line 998]

     $generator = new DB_Table_Generator($db, $database);

     $generator->generateTableClassFiles();

getTableDefinition   [line 519]

getTableNames   [line 462]

setErrorMessage   [line 437]

tableName   [line 1305]

throwError   [line 407]