Docs For Class TDbMetaDataInspector

Description

Base class for database meta data inspectors.

abstract:
since: 3.1
version: $Id: TDbMetaDataInspector.php 1545 2006-12-03 22:26:04Z wei $
author: Wei Zhuo <weizho[at]gmail[dot]com>

Located in /Data/ActiveRecord/Vendor/TDbMetaDataInspector.php (line 21)

Direct descendents

Class	Description
TMysqlMetaDataInspector	TMysqlMetaDataInspector class.
TPgsqlMetaDataInspector	Table meta data inspector for Postgres database 7.3 or later.
TSqliteMetaDataInspector	Table meta data inspector for Sqlite database.

Method Summary

TDbMetaDataInspector __construct (mixed $conn)

TDbMetaData createMetaData (string $table, array $columns, array $primary, array $foreign)

array getColumnDefinitions (string $table)

array getConstraintKeys (string $table)

TDbConnection getDbConnection ()

TDbMetaData getTableMetaData (string $table)

void setDbConnection (TDbConnection $conn)

Methods

Constructor __construct (line 25)

access: public

TDbMetaDataInspector __construct (mixed $conn)

createMetaData (line 79)

Create a new instance of meta data.

return: table meta data.
access: protected
abstract:

TDbMetaData createMetaData (string $table, array $columns, array $primary, array $foreign)

string $table: table name
array $columns: column meta data
array $primary: primary key meta data
array $foreign: foreign key meta data.

Redefined in descendants as:

TMysqlMetaDataInspector::createMetaData() : Create a new instance of meta data.
TPgsqlMetaDataInspector::createMetaData() : Create a new instance of meta data.
TSqliteMetaDataInspector::createMetaData() : Create a new instance of meta data.

getColumnDefinitions (line 62)

Get the column definitions for given table.

return: column name value pairs of column meta data.
access: protected
abstract:

array getColumnDefinitions (string $table)

string $table: table name.

Redefined in descendants as:

TMysqlMetaDataInspector::getColumnDefinitions() : Get the column definitions for given table.
TPgsqlMetaDataInspector::getColumnDefinitions() : Get the column definitions for given table.
TSqliteMetaDataInspector::getColumnDefinitions() : Get the column definitions for given table.

getConstraintKeys (line 69)

Gets the primary and foreign key details for the given table.

return: key value pairs with keys 'primary' and 'foreign'.
access: protected
abstract:

array getConstraintKeys (string $table)

string $table: table name.

Redefined in descendants as:

TMysqlMetaDataInspector::getConstraintKeys() : Not implemented, Mysql does not always have foreign key constraints.
TPgsqlMetaDataInspector::getConstraintKeys() : Gets the primary and foreign key details for the given table.
TSqliteMetaDataInspector::getConstraintKeys() : Not implemented, sqlite does not have foreign key constraints.

getDbConnection (line 41)

return: database connection.
access: public

TDbConnection getDbConnection ()

getTableMetaData (line 50)

return: table meta data.
access: public

TDbMetaData getTableMetaData (string $table)

string $table: table name

setDbConnection (line 33)

access: public

void setDbConnection (TDbConnection $conn)

TDbConnection $conn: database connection.