Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

DatabaseInfo Class Reference

Inherited by MSSQLDatabaseInfo, MySQLDatabaseInfo, OCI8DatabaseInfo, PgSQLDatabaseInfo, and SQLiteDatabaseInfo.

List of all members.

Public Member Functions

• __construct ( Connection $conn )
• string getName ()
• array __sleep ()
• __wakeup ()
• Connection getConnection ()
• TableInfo getTable ( $name )
• array getTables ()
• addTable ( TableInfo $table )
• boolean isSequence ( $key )
• array getSequences ()

Protected Member Functions

• void initTables ()
• void initSequences ()

Protected Attributes

• $tables = array()
• $sequences = array()
• $tablesLoaded = false
• $seqsLoaded = false
• $conn
• $dbname
• $dblink

---

Member Function Documentation

DatabaseInfo::__construct ( Connection $conn )

Parameters Connection  $dbh Reimplemented in MSSQLDatabaseInfo, and OCI8DatabaseInfo.

string DatabaseInfo::getName ( )

Get name of database. Returns string

array DatabaseInfo::__sleep ( )

This method is invoked upon serialize(). Because the Info class hierarchy is recursive, we must handle the serialization and unserialization of this object. Returns array The class variables that should be serialized (all must be public!).

DatabaseInfo::__wakeup ( )

This method is invoked upon unserialize(). This method re-hydrates the object and restores the recursive hierarchy.

Connection DatabaseInfo::getConnection ( )

Returns Connection being used. Returns Connection

TableInfo DatabaseInfo::getTable ( $name )

Get the TableInfo object for specified table name. Parameters string  $name The name of the table to retrieve. Returns TableInfo Exceptions SQLException  - if table does not exist in this db.

array DatabaseInfo::getTables ( )

Gets array of TableInfo objects. Returns array TableInfo[]

DatabaseInfo::addTable ( TableInfo $table )

Adds a table to this db. Table name is case-insensitive. Parameters TableInfo  $table

void DatabaseInfo::initTables ( ) [protected, pure virtual]

Returns void Exceptions SQLException  Implemented in MSSQLDatabaseInfo, MySQLDatabaseInfo, OCI8DatabaseInfo, PgSQLDatabaseInfo, and SQLiteDatabaseInfo.

void DatabaseInfo::initSequences ( ) [protected, pure virtual]

Returns void Exceptions SQLException  Implemented in MSSQLDatabaseInfo, MySQLDatabaseInfo, OCI8DatabaseInfo, PgSQLDatabaseInfo, and SQLiteDatabaseInfo.

boolean DatabaseInfo::isSequence ( $key )

Returns boolean Exceptions SQLException

array DatabaseInfo::getSequences ( )

Gets array of ? objects. Returns array ?[]

---

Member Data Documentation

DatabaseInfo::$tables = array() [protected]

DatabaseInfo::$sequences = array() [protected]

DatabaseInfo::$tablesLoaded = false [protected]

have tables been loaded

DatabaseInfo::$seqsLoaded = false [protected]

have sequences been loaded

DatabaseInfo::$conn [protected]

DatabaseInfo::$dbname [protected]

Database name.

DatabaseInfo::$dblink [protected]

---

This file is part of the Creole[php5] library.