You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
2.5 KiB

13 years ago
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
namespace yii\db;
13 years ago
use yii\base\Object;
13 years ago
/**
13 years ago
* ColumnSchema class describes the metadata of a column in a database table.
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
13 years ago
* @since 2.0
13 years ago
*/
class ColumnSchema extends Object
13 years ago
{
/**
* @var string name of this column (without quotes).
*/
public $name;
/**
* @var boolean whether this column can be null.
*/
public $allowNull;
/**
12 years ago
* @var string abstract type of this column. Possible abstract types include:
13 years ago
* string, text, boolean, smallint, integer, bigint, float, decimal, datetime,
* timestamp, time, date, binary, and money.
13 years ago
*/
13 years ago
public $type;
13 years ago
/**
13 years ago
* @var string the PHP type of this column. Possible PHP types include:
* string, boolean, integer, double.
13 years ago
*/
13 years ago
public $phpType;
/**
13 years ago
* @var string the DB type of this column. Possible DB types vary according to the type of DBMS.
13 years ago
*/
public $dbType;
13 years ago
/**
* @var mixed default value of this column
*/
public $defaultValue;
/**
13 years ago
* @var array enumerable values. This is set only if the column is declared to be an enumerable type.
13 years ago
*/
public $enumValues;
/**
13 years ago
* @var integer display size of the column.
13 years ago
*/
public $size;
/**
* @var integer precision of the column data, if it is numeric.
*/
public $precision;
/**
* @var integer scale of the column data, if it is numeric.
*/
public $scale;
/**
* @var boolean whether this column is a primary key
*/
public $isPrimaryKey;
/**
* @var boolean whether this column is auto-incremental
*/
public $autoIncrement = false;
/**
13 years ago
* @var boolean whether this column is unsigned. This is only meaningful
13 years ago
* when [[type]] is `smallint`, `integer` or `bigint`.
13 years ago
*/
13 years ago
public $unsigned;
13 years ago
/**
12 years ago
* @var string comment of this column. Not all DBMS support this.
13 years ago
*/
12 years ago
public $comment;
13 years ago
/**
13 years ago
* Converts the input value according to [[phpType]].
* If the value is null or an [[Expression]], it will not be converted.
13 years ago
* @param mixed $value input value
* @return mixed converted value
*/
public function typecast($value)
{
13 years ago
if ($value === null || gettype($value) === $this->phpType || $value instanceof Expression) {
13 years ago
return $value;
13 years ago
}
if ($value === '' && $this->type !== Schema::TYPE_TEXT && $this->type !== Schema::TYPE_STRING) {
return null;
}
13 years ago
switch ($this->phpType) {
13 years ago
case 'string':
return (string)$value;
case 'integer':
return (integer)$value;
case 'boolean':
return (boolean)$value;
13 years ago
}
13 years ago
return $value;
13 years ago
}
}