CDbColumnSchema

Подробное описание свойств

allowNull свойство

public boolean $allowNull;

может ли столбец быть NULL.

autoIncrement свойство (доступно с версии v1.1.7)

public boolean $autoIncrement;

является ли столбец автоинкрементируемым

comment свойство (доступно с версии v1.1.13)

public string $comment;

комментарий к столбцу. Значение по умолчанию — пустая строка, что означает отсутствие комментария. Значение NULL означает, что СУБД не поддерживает комментарии к столбцам (SQLite) или получение комментариев для активной СУБД пока не поддерживается фреймворком.

dbType свойство

public string $dbType;

тип столбца в СУБД.

defaultValue свойство

public mixed $defaultValue;

значение по умолчанию для столбца

isForeignKey свойство

public boolean $isForeignKey;

является ли столбец внешним ключом

isPrimaryKey свойство

public boolean $isPrimaryKey;

является ли столбец первичным ключом

name свойство

public string $name;

название столбца (без кавычек).

precision свойство

public integer $precision;

точность данных столбца, если это числовое значение.

rawName свойство

public string $rawName;

истинное имя этого столбца. Это имя в кавычках, которое можно использовать в запросах SQL.

scale свойство

public integer $scale;

разрядность данных столбца, если это числовое значение.

size свойство

public integer $size;

размер столбца.

type свойство

public string $type;

тип этого столбца в PHP.

Подробное описание методов

extractDefault() метод

protected void extractDefault(mixed $defaultValue)

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

Извлекает значение по умолчанию для столбца. Значение приводится к соответствующему типу PHP.

extractLimit() метод

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];
    }
}

Извлекает информацию о размере, точности и разрядности из типа столбца в базе данных.

extractType() метод

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';
}

Извлекает тип PHP из типа базы данных.

init() метод

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);
}

Инициализирует столбец с типом и значением по умолчанию из базы данных. Это устанавливает тип PHP, размер, точность, разрядность, а также значение по умолчанию столбца.

typecast() метод

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;
    }
}

Преобразует входное значение к типу этого столбца.