Class yii\db\ColumnSchema

继承yii\db\ColumnSchema » yii\base\BaseObject
实现yii\base\Configurable
子类yii\db\mssql\ColumnSchema, yii\db\mysql\ColumnSchema, yii\db\pgsql\ColumnSchema
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/ColumnSchema.php

ColumnSchema 类描述数据库表中列的元数据.

公共属性

隐藏继承的属性

属性类型描述定义在
$allowNull boolean 该列是否可以为null. yii\db\ColumnSchema
$autoIncrement boolean 该列是否是自动增量的. yii\db\ColumnSchema
$comment string 该列的注释. yii\db\ColumnSchema
$dbType string 该列的数据库(DB)类型. yii\db\ColumnSchema
$defaultValue mixed Default 该列的默认值. yii\db\ColumnSchema
$enumValues array 可枚举值. yii\db\ColumnSchema
$isPrimaryKey boolean 该列是否是主键. yii\db\ColumnSchema
$name string 该列的名称(不含引号). yii\db\ColumnSchema
$phpType string 该列的 PHP 类型. yii\db\ColumnSchema
$precision integer 列数据的精度(如果为数字). yii\db\ColumnSchema
$scale integer 列数据的小数位数(如果为数字). yii\db\ColumnSchema
$size integer 显示列的大小. yii\db\ColumnSchema
$type string 该列的抽象类型. yii\db\ColumnSchema
$unsigned boolean 该列是否未签名. yii\db\ColumnSchema

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
dbTypecast() 根据 $type$dbType 转换输入值, 以用于数据库(db)查询. yii\db\ColumnSchema
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
phpTypecast() 从数据库中检索后, 根据 $phpType 转换输入值. yii\db\ColumnSchema

受保护的方法

隐藏继承的方法

方法描述定义在
typecast() 从数据库中检索后, 根据 $phpType 转换输入值. yii\db\ColumnSchema

属性详情

$allowNull public 属性

该列是否可以为null.

public boolean $allowNull null
$autoIncrement public 属性

该列是否是自动增量的.

public boolean $autoIncrement false
$comment public 属性

该列的注释. 并不是所有的 DBMS 都支持此功能.

public string $comment null
$dbType public 属性

该列的数据库(DB)类型. 可能的 DB 类型根据 DBMS 的类型而有所不同.

public string $dbType null
$defaultValue public 属性

Default 该列的默认值.

public mixed $defaultValue null
$enumValues public 属性

可枚举值. 仅当该列被声明为可枚举类型时才设置此值.

public array $enumValues null
$isPrimaryKey public 属性

该列是否是主键.

public boolean $isPrimaryKey null
$name public 属性

该列的名称(不含引号).

public string $name null
$phpType public 属性

该列的 PHP 类型. 可能的 PHP 类型包括: string, boolean, integer, double, array.

public string $phpType null
$precision public 属性

列数据的精度(如果为数字).

public integer $precision null
$scale public 属性

列数据的小数位数(如果为数字).

public integer $scale null
$size public 属性

显示列的大小.

public integer $size null
$type public 属性

该列的抽象类型. 可能的抽象类型包括: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binarymoney.

public string $type null
$unsigned public 属性

该列是否未签名. 仅当 $typesmallint, integerbigint时才有意义.

public boolean $unsigned null

方法详情

dbTypecast() public 方法

根据 $type$dbType 转换输入值, 以用于数据库(db)查询.

如果该值为null表达式, 则不会进行转换.

public mixed dbTypecast ( $value )
$value mixed

输入的值.

return mixed

转换后的值. 这也可以是包含值作为第一个元素和 PDO 类型作为第二个元素的数组.

phpTypecast() public 方法

从数据库中检索后, 根据 $phpType 转换输入值.

如果该值为null表达式, 则不会进行转换.

public mixed phpTypecast ( $value )
$value mixed

输入的值.

return mixed

转换后的值.

typecast() protected 方法 (可用自版本: 2.0.3)

从数据库中检索后, 根据 $phpType 转换输入值.

如果该值为null表达式, 则不会进行转换.

protected mixed typecast ( $value )
$value mixed

输入的值.

return mixed

转换后的值.