WobSchemaBase Class Reference

Public Member Functions
	__construct ()

Static Public Member Functions
static	version ()
static	tableNames ()
static	configTable ()
static	configKeyColumn ()
static	configValueColumn ()
static	configVersionRow ()
static	hasTable ($t)
static	backupTables ()
static	backupKeyForTable ($table)
static	backupGroupSizeForTable ($table)
static	tableDefinition ($tab)
static	tableColumns ($tab)
static	tableHasColumn ($tab, $col)
static	tableDefaults ($tab)
static	columnType ($tab, $col)
static	columnFlags ($tab, $col)
static	isIntColumn ($tab, $col)
static	hasSequence ($tab)
static	isStringColumn ($tab, $col)
static	isBlobColumn ($tab, $col)
static	isBoolColumn ($tab, $col)
static	primaryKeyColumns ($tab)

Static Protected Attributes
static	$scheme
static	$preset
static	$sversion
static	$backup
static	$backupCfg
static	$config

Detailed Description

This class parses the high-level description of the database structure generated by woc; access it via WobScheme::*

Constructor & Destructor Documentation

WobSchemaBase::__construct

(

)

Member Function Documentation

static WobSchemaBase::backupGroupSizeForTable (   $table )

static

return the recommended group size for backups or <=0 for default

static WobSchemaBase::backupKeyForTable (   $table )

static

return the key by which backups should be grouped for a table, empty string if it should not be backed up or be backed up in full

static WobSchemaBase::backupTables ( )

static

return the tables that are included in the backup

static WobSchemaBase::columnFlags (   $tab,   $col  )

static

return the flags of a column, empty array if no flags are set, or false if the column does not exist

static WobSchemaBase::columnType (   $tab,   $col  )

static

return the type of a column, or false if it does not exist

static WobSchemaBase::configKeyColumn ( )

static

static WobSchemaBase::configTable ( )

static

static WobSchemaBase::configValueColumn ( )

static

static WobSchemaBase::configVersionRow ( )

static

static WobSchemaBase::hasSequence (   $tab )

static

returns the sequence column name if the table has a sequence, false otherwise

static WobSchemaBase::hasTable (   $t )

static

returns whether a table exists in the schema

static WobSchemaBase::isBlobColumn (   $tab,   $col  )

static

returns true if the given column is of a blob type

static WobSchemaBase::isBoolColumn (   $tab,   $col  )

static

returns true if the given column is of a bool type

static WobSchemaBase::isIntColumn (   $tab,   $col  )

static

returns true if the given column is of an integer type

static WobSchemaBase::isStringColumn (   $tab,   $col  )

static

returns true if the given column is of a string type

static WobSchemaBase::primaryKeyColumns (   $tab )

static

returns the names of all primary key columns of the table

static WobSchemaBase::tableColumns (   $tab )

static

return the names of all columns of a table, or false if the table does not exist

static WobSchemaBase::tableDefaults (   $tab )

static

return default lines of the table for the initialization; returns empty array if there are none

static WobSchemaBase::tableDefinition (   $tab )

static

return the full definition of a table, or false if it does not exist

static WobSchemaBase::tableHasColumn (   $tab,   $col  )

static

return whether the table has this column

static WobSchemaBase::tableNames ( )

static

return the tables to be created in order

static WobSchemaBase::version ( )

static

return the version of this scheme

Member Data Documentation

WobSchemaBase::$backup

staticprotected

WobSchemaBase::$backupCfg

staticprotected

WobSchemaBase::$config

staticprotected

WobSchemaBase::$preset

staticprotected

WobSchemaBase::$scheme

staticprotected

WobSchemaBase::$sversion

staticprotected

---

The documentation for this class was generated from the following file:

• schema.php