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.
452 lines
13 KiB
452 lines
13 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\db; |
|
|
|
use Yii; |
|
use yii\base\Object; |
|
|
|
/** |
|
* ColumnSchemaBuilder helps to define database schema types using a PHP interface. |
|
* |
|
* See [[SchemaBuilderTrait]] for more detailed description and usage examples. |
|
* |
|
* @author Vasenin Matvey <vaseninm@gmail.com> |
|
* @since 2.0.6 |
|
*/ |
|
class ColumnSchemaBuilder extends Object |
|
{ |
|
// Internally used constants representing categories that abstract column types fall under. |
|
// See [[$categoryMap]] for mappings of abstract column types to category. |
|
// @since 2.0.8 |
|
const CATEGORY_PK = 'pk'; |
|
const CATEGORY_STRING = 'string'; |
|
const CATEGORY_NUMERIC = 'numeric'; |
|
const CATEGORY_TIME = 'time'; |
|
const CATEGORY_OTHER = 'other'; |
|
|
|
/** |
|
* @var string the column type definition such as INTEGER, VARCHAR, DATETIME, etc. |
|
*/ |
|
protected $type; |
|
/** |
|
* @var int|string|array column size or precision definition. This is what goes into the parenthesis after |
|
* the column type. This can be either a string, an integer or an array. If it is an array, the array values will |
|
* be joined into a string separated by comma. |
|
*/ |
|
protected $length; |
|
/** |
|
* @var bool|null whether the column is or not nullable. If this is `true`, a `NOT NULL` constraint will be added. |
|
* If this is `false`, a `NULL` constraint will be added. |
|
*/ |
|
protected $isNotNull; |
|
/** |
|
* @var bool whether the column values should be unique. If this is `true`, a `UNIQUE` constraint will be added. |
|
*/ |
|
protected $isUnique = false; |
|
/** |
|
* @var string the `CHECK` constraint for the column. |
|
*/ |
|
protected $check; |
|
/** |
|
* @var mixed default value of the column. |
|
*/ |
|
protected $default; |
|
/** |
|
* @var mixed SQL string to be appended to column schema definition. |
|
* @since 2.0.9 |
|
*/ |
|
protected $append; |
|
/** |
|
* @var bool whether the column values should be unsigned. If this is `true`, an `UNSIGNED` keyword will be added. |
|
* @since 2.0.7 |
|
*/ |
|
protected $isUnsigned = false; |
|
/** |
|
* @var string the column after which this column will be added. |
|
* @since 2.0.8 |
|
*/ |
|
protected $after; |
|
/** |
|
* @var bool whether this column is to be inserted at the beginning of the table. |
|
* @since 2.0.8 |
|
*/ |
|
protected $isFirst; |
|
|
|
|
|
/** |
|
* @var array mapping of abstract column types (keys) to type categories (values). |
|
* @since 2.0.8 |
|
*/ |
|
public $categoryMap = [ |
|
Schema::TYPE_PK => self::CATEGORY_PK, |
|
Schema::TYPE_UPK => self::CATEGORY_PK, |
|
Schema::TYPE_BIGPK => self::CATEGORY_PK, |
|
Schema::TYPE_UBIGPK => self::CATEGORY_PK, |
|
Schema::TYPE_CHAR => self::CATEGORY_STRING, |
|
Schema::TYPE_STRING => self::CATEGORY_STRING, |
|
Schema::TYPE_TEXT => self::CATEGORY_STRING, |
|
Schema::TYPE_SMALLINT => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_INTEGER => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_BIGINT => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_FLOAT => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_DOUBLE => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_DECIMAL => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_DATETIME => self::CATEGORY_TIME, |
|
Schema::TYPE_TIMESTAMP => self::CATEGORY_TIME, |
|
Schema::TYPE_TIME => self::CATEGORY_TIME, |
|
Schema::TYPE_DATE => self::CATEGORY_TIME, |
|
Schema::TYPE_BINARY => self::CATEGORY_OTHER, |
|
Schema::TYPE_BOOLEAN => self::CATEGORY_NUMERIC, |
|
Schema::TYPE_MONEY => self::CATEGORY_NUMERIC, |
|
]; |
|
/** |
|
* @var \yii\db\Connection the current database connection. It is used mainly to escape strings |
|
* safely when building the final column schema string. |
|
* @since 2.0.8 |
|
*/ |
|
public $db; |
|
/** |
|
* @var string comment value of the column. |
|
* @since 2.0.8 |
|
*/ |
|
public $comment; |
|
|
|
/** |
|
* Create a column schema builder instance giving the type and value precision. |
|
* |
|
* @param string $type type of the column. See [[$type]]. |
|
* @param int|string|array $length length or precision of the column. See [[$length]]. |
|
* @param \yii\db\Connection $db the current database connection. See [[$db]]. |
|
* @param array $config name-value pairs that will be used to initialize the object properties |
|
*/ |
|
public function __construct($type, $length = null, $db = null, $config = []) |
|
{ |
|
$this->type = $type; |
|
$this->length = $length; |
|
$this->db = $db; |
|
parent::__construct($config); |
|
} |
|
|
|
/** |
|
* Adds a `NOT NULL` constraint to the column. |
|
* @return $this |
|
*/ |
|
public function notNull() |
|
{ |
|
$this->isNotNull = true; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Adds a `NULL` constraint to the column |
|
* @return $this |
|
* @since 2.0.9 |
|
*/ |
|
public function null() |
|
{ |
|
$this->isNotNull = false; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Adds a `UNIQUE` constraint to the column. |
|
* @return $this |
|
*/ |
|
public function unique() |
|
{ |
|
$this->isUnique = true; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Sets a `CHECK` constraint for the column. |
|
* @param string $check the SQL of the `CHECK` constraint to be added. |
|
* @return $this |
|
*/ |
|
public function check($check) |
|
{ |
|
$this->check = $check; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Specify the default value for the column. |
|
* @param mixed $default the default value. |
|
* @return $this |
|
*/ |
|
public function defaultValue($default) |
|
{ |
|
if ($default === null) { |
|
$this->null(); |
|
} |
|
|
|
$this->default = $default; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Specifies the comment for column. |
|
* @param string $comment the comment |
|
* @return $this |
|
* @since 2.0.8 |
|
*/ |
|
public function comment($comment) |
|
{ |
|
$this->comment = $comment; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Marks column as unsigned. |
|
* @return $this |
|
* @since 2.0.7 |
|
*/ |
|
public function unsigned() |
|
{ |
|
switch ($this->type) { |
|
case Schema::TYPE_PK: |
|
$this->type = Schema::TYPE_UPK; |
|
break; |
|
case Schema::TYPE_BIGPK: |
|
$this->type = Schema::TYPE_UBIGPK; |
|
break; |
|
} |
|
$this->isUnsigned = true; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Adds an `AFTER` constraint to the column. |
|
* Note: MySQL, Oracle and Cubrid support only. |
|
* @param string $after the column after which $this column will be added. |
|
* @return $this |
|
* @since 2.0.8 |
|
*/ |
|
public function after($after) |
|
{ |
|
$this->after = $after; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Adds an `FIRST` constraint to the column. |
|
* Note: MySQL, Oracle and Cubrid support only. |
|
* @return $this |
|
* @since 2.0.8 |
|
*/ |
|
public function first() |
|
{ |
|
$this->isFirst = true; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Specify the default SQL expression for the column. |
|
* @param string $default the default value expression. |
|
* @return $this |
|
* @since 2.0.7 |
|
*/ |
|
public function defaultExpression($default) |
|
{ |
|
$this->default = new Expression($default); |
|
return $this; |
|
} |
|
|
|
/** |
|
* Specify additional SQL to be appended to column definition. |
|
* Position modifiers will be appended after column definition in databases that support them. |
|
* @param string $sql the SQL string to be appended. |
|
* @return $this |
|
* @since 2.0.9 |
|
*/ |
|
public function append($sql) |
|
{ |
|
$this->append = $sql; |
|
return $this; |
|
} |
|
|
|
/** |
|
* Builds the full string for the column's schema |
|
* @return string |
|
*/ |
|
public function __toString() |
|
{ |
|
switch ($this->getTypeCategory()) { |
|
case self::CATEGORY_PK: |
|
$format = '{type}{check}{comment}{append}'; |
|
break; |
|
default: |
|
$format = '{type}{length}{notnull}{unique}{default}{check}{comment}{append}'; |
|
} |
|
return $this->buildCompleteString($format); |
|
} |
|
|
|
/** |
|
* Builds the length/precision part of the column. |
|
* @return string |
|
*/ |
|
protected function buildLengthString() |
|
{ |
|
if ($this->length === null || $this->length === []) { |
|
return ''; |
|
} |
|
if (is_array($this->length)) { |
|
$this->length = implode(',', $this->length); |
|
} |
|
return "({$this->length})"; |
|
} |
|
|
|
/** |
|
* Builds the not null constraint for the column. |
|
* @return string returns 'NOT NULL' if [[isNotNull]] is true, |
|
* 'NULL' if [[isNotNull]] is false or an empty string otherwise. |
|
*/ |
|
protected function buildNotNullString() |
|
{ |
|
if ($this->isNotNull === true) { |
|
return ' NOT NULL'; |
|
} elseif ($this->isNotNull === false) { |
|
return ' NULL'; |
|
} |
|
|
|
return ''; |
|
} |
|
|
|
/** |
|
* Builds the unique constraint for the column. |
|
* @return string returns string 'UNIQUE' if [[isUnique]] is true, otherwise it returns an empty string. |
|
*/ |
|
protected function buildUniqueString() |
|
{ |
|
return $this->isUnique ? ' UNIQUE' : ''; |
|
} |
|
|
|
/** |
|
* Builds the default value specification for the column. |
|
* @return string string with default value of column. |
|
*/ |
|
protected function buildDefaultString() |
|
{ |
|
if ($this->default === null) { |
|
return $this->isNotNull === false ? ' DEFAULT NULL' : ''; |
|
} |
|
|
|
$string = ' DEFAULT '; |
|
switch (gettype($this->default)) { |
|
case 'integer': |
|
$string .= (string) $this->default; |
|
break; |
|
case 'double': |
|
// ensure type cast always has . as decimal separator in all locales |
|
$string .= str_replace(',', '.', (string) $this->default); |
|
break; |
|
case 'boolean': |
|
$string .= $this->default ? 'TRUE' : 'FALSE'; |
|
break; |
|
case 'object': |
|
$string .= (string) $this->default; |
|
break; |
|
default: |
|
$string .= "'{$this->default}'"; |
|
} |
|
|
|
return $string; |
|
} |
|
|
|
/** |
|
* Builds the check constraint for the column. |
|
* @return string a string containing the CHECK constraint. |
|
*/ |
|
protected function buildCheckString() |
|
{ |
|
return $this->check !== null ? " CHECK ({$this->check})" : ''; |
|
} |
|
|
|
/** |
|
* Builds the unsigned string for column. Defaults to unsupported. |
|
* @return string a string containing UNSIGNED keyword. |
|
* @since 2.0.7 |
|
*/ |
|
protected function buildUnsignedString() |
|
{ |
|
return ''; |
|
} |
|
|
|
/** |
|
* Builds the after constraint for the column. Defaults to unsupported. |
|
* @return string a string containing the AFTER constraint. |
|
* @since 2.0.8 |
|
*/ |
|
protected function buildAfterString() |
|
{ |
|
return ''; |
|
} |
|
|
|
/** |
|
* Builds the first constraint for the column. Defaults to unsupported. |
|
* @return string a string containing the FIRST constraint. |
|
* @since 2.0.8 |
|
*/ |
|
protected function buildFirstString() |
|
{ |
|
return ''; |
|
} |
|
|
|
/** |
|
* Builds the custom string that's appended to column definition. |
|
* @return string custom string to append. |
|
* @since 2.0.9 |
|
*/ |
|
protected function buildAppendString() |
|
{ |
|
return $this->append !== null ? ' ' . $this->append : ''; |
|
} |
|
|
|
/** |
|
* Returns the category of the column type. |
|
* @return string a string containing the column type category name. |
|
* @since 2.0.8 |
|
*/ |
|
protected function getTypeCategory() |
|
{ |
|
return isset($this->categoryMap[$this->type]) ? $this->categoryMap[$this->type] : null; |
|
} |
|
|
|
/** |
|
* Builds the comment specification for the column. |
|
* @return string a string containing the COMMENT keyword and the comment itself |
|
* @since 2.0.8 |
|
*/ |
|
protected function buildCommentString() |
|
{ |
|
return ''; |
|
} |
|
|
|
/** |
|
* Returns the complete column definition from input format |
|
* @param string $format the format of the definition. |
|
* @return string a string containing the complete column definition. |
|
* @since 2.0.8 |
|
*/ |
|
protected function buildCompleteString($format) |
|
{ |
|
$placeholderValues = [ |
|
'{type}' => $this->type, |
|
'{length}' => $this->buildLengthString(), |
|
'{unsigned}' => $this->buildUnsignedString(), |
|
'{notnull}' => $this->buildNotNullString(), |
|
'{unique}' => $this->buildUniqueString(), |
|
'{default}' => $this->buildDefaultString(), |
|
'{check}' => $this->buildCheckString(), |
|
'{comment}' => $this->buildCommentString(), |
|
'{pos}' => $this->isFirst ? $this->buildFirstString() : $this->buildAfterString(), |
|
'{append}' => $this->buildAppendString(), |
|
]; |
|
return strtr($format, $placeholderValues); |
|
} |
|
}
|
|
|