CMssqlColumnSchema
| Package | system.db.schema.mssql |
|---|---|
| Inheritance | class CMssqlColumnSchema » CDbColumnSchema » CComponent |
| Source Code | framework/db/schema/mssql/CMssqlColumnSchema.php |
CMssqlColumnSchema class describes the column meta data of a MSSQL table.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| allowNull | boolean | whether this column can be null. | CDbColumnSchema |
| autoIncrement | boolean | whether this column is auto-incremental | CDbColumnSchema |
| comment | string | comment of this column. | 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
| 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. | CMssqlColumnSchema |
| raiseEvent() | Raises an event. | CComponent |
| typecast() | Converts the input value to the type that this column is of. | CMssqlColumnSchema |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| extractDefault() | Extracts the default value for the column. | CMssqlColumnSchema |
| extractLimit() | Extracts size, precision and scale information from column's DB type. | CMssqlColumnSchema |
| extractType() | Extracts the PHP type from DB type. | CMssqlColumnSchema |
Method Details
extractDefault() method
|
||
| $defaultValue | mixed | the default value obtained from metadata |
Source Code: framework/db/schema/mssql/CMssqlColumnSchema.php#59 (show)
protected function extractDefault($defaultValue)
{
if($this->dbType==='timestamp' )
$this->defaultValue=null;
else
parent::extractDefault(str_replace(array('(',')',"'"), '', $defaultValue));
}Extracts the default value for the column. The value is typecasted to correct PHP type.
extractLimit() method
|
||
| $dbType | string | the column's DB type |
Source Code: framework/db/schema/mssql/CMssqlColumnSchema.php#72 (show)
protected function extractLimit($dbType)
{
}Extracts size, precision and scale information from column's DB type. We do nothing here, since sizes and precisions have been computed before.
extractType() method
|
||
| $dbType | string | DB type |
Source Code: framework/db/schema/mssql/CMssqlColumnSchema.php#42 (show)
protected function extractType($dbType)
{
if(strpos($dbType,'float')!==false || strpos($dbType,'real')!==false)
$this->type='double';
elseif(strpos($dbType,'bigint')===false && (strpos($dbType,'int')!==false || strpos($dbType,'smallint')!==false || strpos($dbType,'tinyint')))
$this->type='integer';
elseif(strpos($dbType,'bit')!==false)
$this->type='boolean';
else
$this->type='string';
}Extracts the PHP type from DB type.
init() method
|
||
| $dbType | string | the column's DB type |
| $defaultValue | mixed | the default value |
Source Code: framework/db/schema/mssql/CMssqlColumnSchema.php#28 (show)
public function init($dbType, $defaultValue)
{
if ($defaultValue=='(NULL)')
{
$defaultValue=null;
}
parent::init($dbType, $defaultValue);
}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
|
||
| $value | mixed | input value |
| {return} | mixed | converted value |
Source Code: framework/db/schema/mssql/CMssqlColumnSchema.php#81 (show)
public function typecast($value)
{
if($this->type==='boolean')
return $value ? 1 : 0;
else
return parent::typecast($value);
}Converts the input value to the type that this column is of.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CMssqlColumnSchema