CDbColumnSchema

Property Details

allowNull property

public boolean $allowNull;

whether this column can be null.

autoIncrement property (available since v1.1.7)

public boolean $autoIncrement;

whether this column is auto-incremental

comment property (available since v1.1.13)

public string $comment;

comment of this column. Default value is empty string which means that no comment has been set for the column. Null value means that RDBMS does not support column comments at all (SQLite) or comment retrieval for the active RDBMS is not yet supported by the framework.

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)

protected function extractDefault($defaultValue)
{
    $this->defaultValue=$this->typecast($defaultValue);
}

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

extractLimit() method

protected void extractLimit(string $dbType)

protected function extractLimit($dbType)
{
    if(strpos($dbType,'(') && preg_match('/\((.*)\)/',$dbType,$matches))
    {
        $values=explode(',',$matches[1]);
        $this->size=$this->precision=(int)$values[0];
        if(isset($values[1]))
            $this->scale=(int)$values[1];
    }
}

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

extractType() method

protected void extractType(string $dbType)

protected function extractType($dbType)
{
    if(stripos($dbType,'int')!==false && stripos($dbType,'unsigned int')===false)
        $this->type='integer';
    elseif(stripos($dbType,'bool')!==false)
        $this->type='boolean';
    elseif(preg_match('/(real|floa|doub)/i',$dbType))
        $this->type='double';
    else
        $this->type='string';
}

Extracts the PHP type from DB type.

init() method

public void init(string $dbType, mixed $defaultValue)

public function init($dbType, $defaultValue)
{
    $this->dbType=$dbType;
    $this->extractType($dbType);
    $this->extractLimit($dbType);
    if($defaultValue!==null)
        $this->extractDefault($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

public mixed typecast(mixed $value)

public function typecast($value)
{
    if(gettype($value)===$this->type || $value===null || $value instanceof CDbExpression)
        return $value;
    if($value==='' && $this->allowNull)
        return $this->type==='string' ? '' : null;
    switch($this->type)
    {
        case 'string': return (string)$value;
        case 'integer': return (integer)$value;
        case 'boolean': return (boolean)$value;
        case 'double':
        default: return $value;
    }
}

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