This class parses the high-level description of the database structure generated by woc; access it via $dbScheme. More...
Public Member Functions | |
| __construct () | |
| backupTables () | |
| return the tables that are included in the backup | |
| columnFlags ($tab, $col) | |
| return the flags of a column, empty array if no flags are set, or false if the column does not exist | |
| columnType ($tab, $col) | |
| return the type of a column, or false if it does not exist | |
| hasSequence ($tab) | |
| returns the sequence column name if the table has a sequence, false otherwise | |
| hasTable ($t) | |
| returns whether a table exists in the schema | |
| isBlobColumn ($tab, $col) | |
| returns true if the given column is of a blob type | |
| isBoolColumn ($tab, $col) | |
| returns true if the given column is of a bool type | |
| isIntColumn ($tab, $col) | |
| returns true if the given column is of an integer type | |
| isStringColumn ($tab, $col) | |
| returns true if the given column is of a string type | |
| primaryKeyColumns ($tab) | |
| returns the names of all primary key columns of the table | |
| tableColumns ($tab) | |
| return the names of all columns of a table, or false if the table does not exist | |
| tableDefaults ($tab) | |
| return default lines of the table for the initialization; returns empty array if there are none | |
| tableDefinition ($tab) | |
| return the full definition of a table, or false if it does not exist | |
| tableHasColumn ($tab, $col) | |
| return whether the table has this column | |
| tableNames () | |
| return the tables to be created in order | |
| version () | |
| return the version of this scheme | |
Static Protected Attributes | |
| static | $backup |
| static | $preset |
| static | $scheme |
| static | $sversion |
Detailed Description
This class parses the high-level description of the database structure generated by woc; access it via $dbScheme.
Constructor & Destructor Documentation
| WobSchemaBase::__construct | ( | ) |
Reimplemented in WobSchema.
Member Function Documentation
| WobSchemaBase::backupTables | ( | ) |
return the tables that are included in the backup
| WobSchemaBase::columnFlags | ( | $ | tab, | |
| $ | col | |||
| ) |
return the flags of a column, empty array if no flags are set, or false if the column does not exist
| WobSchemaBase::columnType | ( | $ | tab, | |
| $ | col | |||
| ) |
return the type of a column, or false if it does not exist
| WobSchemaBase::hasSequence | ( | $ | tab | ) |
returns the sequence column name if the table has a sequence, false otherwise
| WobSchemaBase::hasTable | ( | $ | t | ) |
returns whether a table exists in the schema
| WobSchemaBase::isBlobColumn | ( | $ | tab, | |
| $ | col | |||
| ) |
returns true if the given column is of a blob type
| WobSchemaBase::isBoolColumn | ( | $ | tab, | |
| $ | col | |||
| ) |
returns true if the given column is of a bool type
| WobSchemaBase::isIntColumn | ( | $ | tab, | |
| $ | col | |||
| ) |
returns true if the given column is of an integer type
| WobSchemaBase::isStringColumn | ( | $ | tab, | |
| $ | col | |||
| ) |
returns true if the given column is of a string type
| WobSchemaBase::primaryKeyColumns | ( | $ | tab | ) |
returns the names of all primary key columns of the table
| WobSchemaBase::tableColumns | ( | $ | tab | ) |
return the names of all columns of a table, or false if the table does not exist
| WobSchemaBase::tableDefaults | ( | $ | tab | ) |
return default lines of the table for the initialization; returns empty array if there are none
| WobSchemaBase::tableDefinition | ( | $ | tab | ) |
return the full definition of a table, or false if it does not exist
| WobSchemaBase::tableHasColumn | ( | $ | tab, | |
| $ | col | |||
| ) |
return whether the table has this column
| WobSchemaBase::tableNames | ( | ) |
return the tables to be created in order
| WobSchemaBase::version | ( | ) |
return the version of this scheme
Referenced by WobSchema::__construct().
Member Data Documentation
WobSchemaBase::$backup [static, protected] |
WobSchemaBase::$preset [static, protected] |
WobSchemaBase::$scheme [static, protected] |
WobSchemaBase::$sversion [static, protected] |
The documentation for this class was generated from the following file:
Generated on Sun Apr 15 2012 21:13:10 for MagicSmoke by
1.7.1