CDbTableSchema

Property Details

columnNames property read-only

public array getColumnNames()

list of column names

columns property

public array $columns;

column metadata of this table. Each array element is a CDbColumnSchema object, indexed by column names.

foreignKeys property

public array $foreignKeys;

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.

name property

public string $name;

name of this table.

primaryKey property

public string|array $primaryKey;

primary key name of this table. If composite key, an array of key names is returned.

rawName property

public string $rawName;

raw name of this table. This is the quoted version of table name with optional schema name. It can be directly used in SQLs.

sequenceName property

public string $sequenceName;

sequence name for the primary key. Null if no sequence.

Method Details

getColumn() method

public CDbColumnSchema getColumn(string $name)

public function getColumn($name)
{
    return isset($this->columns[$name]) ? $this->columns[$name] : null;
}

Gets the named column metadata. This is a convenient method for retrieving a named column even if it does not exist.

getColumnNames() method

public array getColumnNames()

public function getColumnNames()
{
    return array_keys($this->columns);
}