On this page
CMysqlColumnSchema
| Package | system.db.schema.mysql |
|---|---|
| Inheritance | class CMysqlColumnSchema » CDbColumnSchema » CComponent |
| Since | 1.0 |
| Source Code | framework/db/schema/mysql/CMysqlColumnSchema.php |
CMysqlColumnSchema class describes the column meta data of a MySQL 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. | CDbColumnSchema |
| raiseEvent() | Raises an event. | CComponent |
| typecast() | Converts the input value to the type that this column is of. | CDbColumnSchema |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| extractDefault() | Extracts the default value for the column. | CMysqlColumnSchema |
| extractLimit() | Extracts size, precision and scale information from column's DB type. | CMysqlColumnSchema |
| extractType() | Extracts the PHP type from DB type. | CMysqlColumnSchema |
Method Details
extractDefault() method
|
||
| $defaultValue | mixed | the default value obtained from metadata |
Source Code: framework/db/schema/mysql/CMysqlColumnSchema.php#43 (show)
protected function extractDefault($defaultValue)
{
if(strncmp($this->dbType,'bit',3)===0)
$this->defaultValue=bindec(trim($defaultValue,'b\''));
elseif(($this->dbType==='timestamp' || $this->dbType==='datetime') && $defaultValue==='CURRENT_TIMESTAMP')
$this->defaultValue=null;
else
parent::extractDefault($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/mysql/CMysqlColumnSchema.php#57 (show)
protected function extractLimit($dbType)
{
if (strncmp($dbType, 'enum', 4)===0 && preg_match('/\(([\'"])(.*)\\1\)/',$dbType,$matches))
{
// explode by (single or double) quote and comma (ENUM values may contain commas)
$values = explode($matches[1].','.$matches[1], $matches[2]);
$size = 0;
foreach($values as $value)
{
if(($n=strlen($value)) > $size)
$size=$n;
}
$this->size = $this->precision = $size;
}
else
parent::extractLimit($dbType);
}
Extracts size, precision and scale information from column's DB type.
extractType() method
|
||
| $dbType | string | DB type |
Source Code: framework/db/schema/mysql/CMysqlColumnSchema.php#24 (show)
protected function extractType($dbType)
{
if(strncmp($dbType,'enum',4)===0)
$this->type='string';
elseif(strpos($dbType,'float')!==false || strpos($dbType,'double')!==false)
$this->type='double';
elseif(strpos($dbType,'bool')!==false)
$this->type='boolean';
elseif(strpos($dbType,'int')===0 && strpos($dbType,'unsigned')===false || preg_match('/(bit|tinyint|smallint|mediumint)/',$dbType))
$this->type='integer';
else
$this->type='string';
}
Extracts the PHP type from DB type.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CMysqlColumnSchema