Home | Classes | Modules | Annotated | Functions | Files

DatabaseInfo Class Reference

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

List of all members.

Public Member Functions

• DatabaseInfo (&$conn)
• getName ()
• __sleep ()
• __wakeup ()
• & getConnection ()
• & getTable ($name)
• & getTables ()
• addTable (&$table)
• initTables ()
• initSequences ()
• isSequence ($key)
• getSequences ()

Public Attributes

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

---

Constructor & Destructor Documentation

DatabaseInfo::DatabaseInfo ( &$  conn)

Parameters: Connection  $conn

---

Member Function Documentation

DatabaseInfo::getName ()

Get name of database. Returns string

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.

& DatabaseInfo::getConnection ()

Returns Connection being used. Returns Connection

& DatabaseInfo::getTable ( $  name)

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

& DatabaseInfo::getTables ()

Gets array of TableInfo objects. Returns mixed array TableInfo[] on success, SQLException on failure.

DatabaseInfo::addTable ( &$  table)

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

DatabaseInfo::initTables ()

Returns void Exceptions: SQLException  Reimplemented in MSSQLDatabaseInfo, MySQLDatabaseInfo, and PgSQLDatabaseInfo.

DatabaseInfo::initSequences ()

Returns void Exceptions: SQLException  Reimplemented in MSSQLDatabaseInfo, MySQLDatabaseInfo, and PgSQLDatabaseInfo.

DatabaseInfo::isSequence ( $  key)

Returns boolean Exceptions: SQLException

DatabaseInfo::getSequences ()

Gets array of ? objects. Returns array ?[]

---

Member Data Documentation

DatabaseInfo::$tables = array()

DatabaseInfo::$sequences = array()

DatabaseInfo::$tablesLoaded = false

have tables been loaded

DatabaseInfo::$seqsLoaded = false

have sequences been loaded

DatabaseInfo::$conn

DatabaseInfo::$dbname

Database name. Reimplemented in MSSQLDatabaseInfo.

DatabaseInfo::$dblink

Reimplemented in MSSQLDatabaseInfo.

---

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