Class yii\db\ColumnSchema
Inheritance | yii\db\ColumnSchema » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Subclasses | yii\db\mssql\ColumnSchema, yii\db\mysql\ColumnSchema, yii\db\pgsql\ColumnSchema |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/ColumnSchema.php |
ColumnSchema class describes the metadata of a column in a database table.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$allowNull | boolean | Whether this column can be null. | yii\db\ColumnSchema |
$autoIncrement | boolean | Whether this column is auto-incremental | yii\db\ColumnSchema |
$comment | string | Comment of this column. | yii\db\ColumnSchema |
$dbType | string | The DB type of this column. | yii\db\ColumnSchema |
$defaultValue | mixed | Default value of this column | yii\db\ColumnSchema |
$enumValues | array | Enumerable values. | yii\db\ColumnSchema |
$isPrimaryKey | boolean | Whether this column is a primary key | yii\db\ColumnSchema |
$name | string | Name of this column (without quotes). | yii\db\ColumnSchema |
$phpType | string | The PHP type of this column. | yii\db\ColumnSchema |
$precision | integer | Precision of the column data, if it is numeric. | yii\db\ColumnSchema |
$scale | integer | Scale of the column data, if it is numeric. | yii\db\ColumnSchema |
$size | integer | Display size of the column. | yii\db\ColumnSchema |
$type | string | Abstract type of this column. | yii\db\ColumnSchema |
$unsigned | boolean | Whether this column is unsigned. | yii\db\ColumnSchema |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
dbTypecast() | Converts the input value according to $type and $dbType for use in a db query. | yii\db\ColumnSchema |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() | Initializes the object. | yii\base\BaseObject |
phpTypecast() | Converts the input value according to $phpType after retrieval from the database. | yii\db\ColumnSchema |
Protected Methods
Method | Description | Defined By |
---|---|---|
typecast() | Converts the input value according to $phpType after retrieval from the database. | yii\db\ColumnSchema |
Property Details
Whether this column can be null.
Whether this column is auto-incremental
Comment of this column. Not all DBMS support this.
The DB type of this column. Possible DB types vary according to the type of DBMS.
Default value of this column
Enumerable values. This is set only if the column is declared to be an enumerable type.
Whether this column is a primary key
Name of this column (without quotes).
The PHP type of this column. Possible PHP types include:
string
, boolean
, integer
, double
, array
.
Precision of the column data, if it is numeric.
Scale of the column data, if it is numeric.
Display size of the column.
Abstract type of this column. Possible abstract types include: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binary, and money.
Whether this column is unsigned. This is only meaningful
when $type is smallint
, integer
or bigint
.
Method Details
Converts the input value according to $type and $dbType for use in a db query.
If the value is null or an yii\db\Expression, it will not be converted.
public mixed dbTypecast ( $value ) | ||
$value | mixed | Input value |
return | mixed | Converted value. This may also be an array containing the value as the first element and the PDO type as the second element. |
---|
Converts the input value according to $phpType after retrieval from the database.
If the value is null or an yii\db\Expression, it will not be converted.
public mixed phpTypecast ( $value ) | ||
$value | mixed | Input value |
return | mixed | Converted value |
---|
Converts the input value according to $phpType after retrieval from the database.
If the value is null or an yii\db\Expression, it will not be converted.
protected mixed typecast ( $value ) | ||
$value | mixed | Input value |
return | mixed | Converted value |
---|