Home » Documentation » Class Reference » CDbColumnSchema

CDbColumnSchema

Package	system.db.schema
Inheritance	class CDbColumnSchema » CComponent
Subclasses	CMssqlColumnSchema, CMysqlColumnSchema, COciColumnSchema, CPgsqlColumnSchema, CSqliteColumnSchema
Since	1.0
Version	$Id: CDbColumnSchema.php 2130 2010-05-13 00:24:11Z qiang.xue $

CDbColumnSchema class describes the column meta data of a database table.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
allowNull	boolean	whether this column can be null.	CDbColumnSchema
dbType	string	the DB type of this column.	CDbColumnSchema
defaultValue	mixed	default value of this column	CDbColumnSchema
isForeignKey	boolean	whether this column is a foreign key	CDbColumnSchema
isPrimaryKey	boolean	whether this column is a primary key	CDbColumnSchema
name	string	name of this column (without quotes).	CDbColumnSchema
precision	integer	precision of the column data, if it is numeric.	CDbColumnSchema
rawName	string	raw name of this column.	CDbColumnSchema
scale	integer	scale of the column data, if it is numeric.	CDbColumnSchema
size	integer	size of the column.	CDbColumnSchema
type	string	the PHP type of this column.	CDbColumnSchema

Public Methods

Hide inherited methods

Method	Description	Defined 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
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
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
init()	Initializes the column with its DB type and default value.	CDbColumnSchema
raiseEvent()	Raises an event.	CComponent
typecast()	Converts the input value to the type that this column is of.	CDbColumnSchema

Protected Methods

Hide inherited methods

Method	Description	Defined By
extractDefault()	Extracts the default value for the column.	CDbColumnSchema
extractLimit()	Extracts size, precision and scale information from column's DB type.	CDbColumnSchema
extractType()	Extracts the PHP type from DB type.	CDbColumnSchema

Property Details

allowNull property

public boolean $allowNull;

whether this column can be null.

dbType property

public string $dbType;

the DB type of this column.

defaultValue property

public mixed $defaultValue;

default value of this column

isForeignKey property

public boolean $isForeignKey;

whether this column is a foreign key

isPrimaryKey property

public boolean $isPrimaryKey;

whether this column is a primary key

name property

public string $name;

name of this column (without quotes).

precision property

public integer $precision;

precision of the column data, if it is numeric.

rawName property

public string $rawName;

raw name of this column. This is the quoted name that can be used in SQL queries.

scale property

public integer $scale;

scale of the column data, if it is numeric.

size property

public integer $size;

size of the column.

type property

public string $type;

the PHP type of this column.

Method Details

extractDefault() method

protected void extractDefault(mixed $defaultValue)
$defaultValue	mixed	the default value obtained from metadata

Extracts the default value for the column. The value is typecasted to correct PHP type.

extractLimit() method

protected void extractLimit(string $dbType)
$dbType	string	the column's DB type

Extracts size, precision and scale information from column's DB type.

extractType() method

protected void extractType(string $dbType)
$dbType	string	DB type

Extracts the PHP type from DB type.

init() method

public void init(string $dbType, mixed $defaultValue)
$dbType	string	the column's DB type
$defaultValue	mixed	the default value

Initializes the column with its DB type and default value. This sets up the column's PHP type, size, precision, scale as well as default value.

typecast() method

public mixed typecast(mixed $value)
$value	mixed	input value
{return}	mixed	converted value

Converts the input value to the type that this column is of.