ColumnSchemaBuilder.php
5.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<?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
{
/**
* @var string the column type definition such as INTEGER, VARCHAR, DATETIME, etc.
*/
protected $type;
/**
* @var integer|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 boolean whether the column is not nullable. If this is `true`, a `NOT NULL` constraint will be added.
*/
protected $isNotNull = false;
/**
* @var boolean 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;
/**
* Create a column schema builder instance giving the type and value precision.
*
* @param string $type type of the column. See [[$type]].
* @param integer|string|array $length length or precision of the column. See [[$length]].
* @param array $config name-value pairs that will be used to initialize the object properties
*/
public function __construct($type, $length = null, $config = [])
{
$this->type = $type;
$this->length = $length;
parent::__construct($config);
}
/**
* Adds a `NOT NULL` constraint to the column.
* @return $this
*/
public function notNull()
{
$this->isNotNull = true;
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)
{
$this->default = $default;
return $this;
}
/**
* Build full string for create the column's schema
* @return string
*/
public function __toString()
{
return
$this->type .
$this->buildLengthString() .
$this->buildNotNullString() .
$this->buildUniqueString() .
$this->buildDefaultString() .
$this->buildCheckString();
}
/**
* 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, otherwise it returns an empty string.
*/
protected function buildNotNullString()
{
return $this->isNotNull ? ' NOT NULL' : '';
}
/**
* 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 '';
}
$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;
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})" : '';
}
}