0 follower

CDbTableSchema

Package system.db.schema
Inheritance class CDbTableSchema » CComponent
Subclasses CMssqlTableSchema, CMysqlTableSchema, COciTableSchema, CPgsqlTableSchema
Since 1.0
Version $Id$
Source Code framework/db/schema/CDbTableSchema.php
CDbTableSchema 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.

CDbTableSchema provides the following information about a table:

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
columnNames array list of column names CDbTableSchema
columns array column metadata of this table. CDbTableSchema
foreignKeys array foreign keys of this table. CDbTableSchema
name string name of this table. CDbTableSchema
primaryKey string|array primary key name of this table. CDbTableSchema
rawName string raw name of this table. CDbTableSchema
sequenceName string sequence name for the primary key. CDbTableSchema

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
getColumn() Gets the named column metadata. CDbTableSchema
getColumnNames() Returns list of column names CDbTableSchema
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
raiseEvent() Raises an event. CComponent

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)
$name string column name
{return} CDbColumnSchema metadata of the named column. Null if the named column does not exist.
Source Code: framework/db/schema/CDbTableSchema.php#64 (show)
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()
{return} array list of column names
Source Code: framework/db/schema/CDbTableSchema.php#72 (show)
public function getColumnNames()
{
    return array_keys($this->columns);
}