|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ColumnSchema class file.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright © 2008-2012 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\db\dao;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ColumnSchema class describes the column meta data of a database table.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*/
|
|
|
|
class ColumnSchema extends \yii\base\Component
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string name of this column (without quotes).
|
|
|
|
*/
|
|
|
|
public $name;
|
|
|
|
/**
|
|
|
|
* @var string raw name of this column. This is the quoted name that can be used in SQL queries.
|
|
|
|
*/
|
|
|
|
public $quotedName;
|
|
|
|
/**
|
|
|
|
* @var boolean whether this column can be null.
|
|
|
|
*/
|
|
|
|
public $allowNull;
|
|
|
|
/**
|
|
|
|
* @var string logical type of this column. Possible logic types include:
|
|
|
|
* string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binary
|
|
|
|
*/
|
|
|
|
public $type;
|
|
|
|
/**
|
|
|
|
* @var string the PHP type of this column. Possible PHP types include:
|
|
|
|
* string, boolean, integer, double.
|
|
|
|
*/
|
|
|
|
public $phpType;
|
|
|
|
/**
|
|
|
|
* @var string the DB type of this column.
|
|
|
|
*/
|
|
|
|
public $dbType;
|
|
|
|
/**
|
|
|
|
* @var mixed default value of this column
|
|
|
|
*/
|
|
|
|
public $defaultValue;
|
|
|
|
/**
|
|
|
|
* @var array enumerable values
|
|
|
|
*/
|
|
|
|
public $enumValues;
|
|
|
|
/**
|
|
|
|
* @var integer size of the column.
|
|
|
|
*/
|
|
|
|
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;
|
|
|
|
/**
|
|
|
|
* @var boolean whether this column is unsigned. This is only meaningful
|
|
|
|
* when [[type]] is `integer` or `bigint`.
|
|
|
|
*/
|
|
|
|
public $unsigned;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extracts the PHP type from DB type.
|
|
|
|
* @return string PHP type name.
|
|
|
|
*/
|
|
|
|
protected function getPhpType()
|
|
|
|
{
|
|
|
|
static $typeMap = array( // logical type => php type
|
|
|
|
'smallint' => 'integer',
|
|
|
|
'integer' => 'integer',
|
|
|
|
'bigint' => 'integer',
|
|
|
|
'boolean' => 'boolean',
|
|
|
|
'float' => 'double',
|
|
|
|
);
|
|
|
|
if (isset($typeMap[$this->type])) {
|
|
|
|
if ($this->type === 'bigint') {
|
|
|
|
return PHP_INT_SIZE == 8 && !$this->unsigned ? 'integer' : 'string';
|
|
|
|
}
|
|
|
|
elseif ($this->type === 'integer') {
|
|
|
|
return PHP_INT_SIZE == 4 && $this->unsigned ? 'string' : 'integer';
|
|
|
|
}
|
|
|
|
return $typeMap[$this->type];
|
|
|
|
}
|
|
|
|
return 'string';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts the input value to the type that this column is of.
|
|
|
|
* @param mixed $value input value
|
|
|
|
* @return mixed converted value
|
|
|
|
*/
|
|
|
|
public function typecast($value)
|
|
|
|
{
|
|
|
|
if ($value === null || gettype($value) === $this->phpType || $value instanceof Expression) {
|
|
|
|
return $value;
|
|
|
|
}
|
|
|
|
switch ($this->phpType) {
|
|
|
|
case 'string': return (string)$value;
|
|
|
|
case 'integer': return (integer)$value;
|
|
|
|
case 'boolean': return (boolean)$value;
|
|
|
|
}
|
|
|
|
return $value;
|
|
|
|
}
|
|
|
|
}
|