summaryrefslogtreecommitdiff
path: root/framework/Db/Schema/TDbTableSchema.php
diff options
context:
space:
mode:
Diffstat (limited to 'framework/Db/Schema/TDbTableSchema.php')
-rwxr-xr-xframework/Db/Schema/TDbTableSchema.php76
1 files changed, 76 insertions, 0 deletions
diff --git a/framework/Db/Schema/TDbTableSchema.php b/framework/Db/Schema/TDbTableSchema.php
new file mode 100755
index 00000000..eaeda1b4
--- /dev/null
+++ b/framework/Db/Schema/TDbTableSchema.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * TDbTableSchema class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * TDbTableSchema is the base class for representing the metadata of a database table.
+ *
+ * It may be extended by different DBMS driver to provide DBMS-specific table metadata.
+ *
+ * TDbTableSchema provides the following information about a table:
+ * <ul>
+ * <li>{@link name}</li>
+ * <li>{@link rawName}</li>
+ * <li>{@link columns}</li>
+ * <li>{@link primaryKey}</li>
+ * <li>{@link foreignKeys}</li>
+ * <li>{@link sequenceName}</li>
+ * </ul>
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: TDbTableSchema.php 2679 2009-06-15 07:49:42Z Christophe.Boulain $
+ * @package system.db.schema
+ * @since 1.0
+ */
+class TDbTableSchema extends TComponent
+{
+ /**
+ * @var string name of this table.
+ */
+ public $name;
+ /**
+ * @var string raw name of this table. This is the quoted version of table name with optional schema name. It can be directly used in SQLs.
+ */
+ public $rawName;
+ /**
+ * @var string|array primary key name of this table. If composite key, an array of key names is returned.
+ */
+ public $primaryKey;
+ /**
+ * @var string sequence name for the primary key. Null if no sequence.
+ */
+ public $sequenceName;
+ /**
+ * @var array foreign keys of this table. The array is indexed by column name. Each value is an array of foreign table name and foreign column name.
+ */
+ public $foreignKeys=array();
+ /**
+ * @var array column metadata of this table. Each array element is a TDbColumnSchema object, indexed by column names.
+ */
+ public $columns=array();
+
+ /**
+ * Gets the named column metadata.
+ * This is a convenient method for retrieving a named column even if it does not exist.
+ * @param string column name
+ * @return TDbColumnSchema metadata of the named column. Null if the named column does not exist.
+ */
+ public function getColumn($name)
+ {
+ return isset($this->columns[$name]) ? $this->columns[$name] : null;
+ }
+
+ /**
+ * @return array list of column names
+ */
+ public function getColumnNames()
+ {
+ return array_keys($this->columns);
+ }
+}