|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 |
- <?php
- /**
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
-
- namespace yii\db;
-
- use yii\base\Object;
- use yii\base\InvalidParamException;
-
- /**
- * TableSchema represents the metadata of a database table.
- *
- * @property array $columnNames List of column names. This property is read-only.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @since 2.0
- */
- class TableSchema extends Object
- {
- /**
- * @var string the name of the schema that this table belongs to.
- */
- public $schemaName;
- /**
- * @var string the name of this table. The schema name is not included. Use [[fullName]] to get the name with schema name prefix.
- */
- public $name;
- /**
- * @var string the full name of this table, which includes the schema name prefix, if any.
- * Note that if the schema name is the same as the [[Schema::defaultSchema|default schema name]],
- * the schema name will not be included.
- */
- public $fullName;
- /**
- * @var string[] primary keys of this table.
- */
- public $primaryKey = [];
- /**
- * @var string sequence name for the primary key. Null if no sequence.
- */
- public $sequenceName;
- /**
- * @var array foreign keys of this table. Each array element is of the following structure:
- *
- * ```php
- * [
- * 'ForeignTableName',
- * 'fk1' => 'pk1', // pk1 is in foreign table
- * 'fk2' => 'pk2', // if composite foreign key
- * ]
- * ```
- */
- public $foreignKeys = [];
- /**
- * @var ColumnSchema[] column metadata of this table. Each array element is a [[ColumnSchema]] object, indexed by column names.
- */
- public $columns = [];
-
-
- /**
- * Gets the named column metadata.
- * This is a convenient method for retrieving a named column even if it does not exist.
- * @param string $name column name
- * @return ColumnSchema 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;
- }
-
- /**
- * Returns the names of all columns in this table.
- * @return array list of column names
- */
- public function getColumnNames()
- {
- return array_keys($this->columns);
- }
-
- /**
- * Manually specifies the primary key for this table.
- * @param string|array $keys the primary key (can be composite)
- * @throws InvalidParamException if the specified key cannot be found in the table.
- */
- public function fixPrimaryKey($keys)
- {
- $keys = (array) $keys;
- $this->primaryKey = $keys;
- foreach ($this->columns as $column) {
- $column->isPrimaryKey = false;
- }
- foreach ($keys as $key) {
- if (isset($this->columns[$key])) {
- $this->columns[$key]->isPrimaryKey = true;
- } else {
- throw new InvalidParamException("Primary key '$key' cannot be found in table '{$this->name}'.");
- }
- }
- }
- }
|