类 yii\db\mysql\ColumnSchema
继承关系 | yii\db\mysql\ColumnSchema » yii\db\ColumnSchema » yii\base\BaseObject |
---|---|
实现接口 | yii\base\Configurable |
可用版本 | 2.0.14.1 |
源代码 | https://github.com/yiisoft/yii2/blob/master/framework/db/mysql/ColumnSchema.php |
MySQL 数据库的 ColumnSchema 类
公有属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$allowNull | boolean | 此列是否可以为 null。 | yii\db\ColumnSchema |
$autoIncrement | boolean | 此列是否为自动递增 | yii\db\ColumnSchema |
$comment | string | 此列的注释。 | yii\db\ColumnSchema |
$dbType | string | 此列的数据库类型。 | yii\db\ColumnSchema |
$defaultValue | mixed | 此列的默认值 | yii\db\ColumnSchema |
$disableJsonSupport | boolean | 列模式是否应省略使用 JSON 支持功能。 | yii\db\mysql\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 转换输入值,以便在数据库查询中使用。 | yii\db\mysql\ColumnSchema |
hasMethod() | 返回一个值,指示方法是否已定义。 | yii\base\BaseObject |
hasProperty() | 返回一个值,指示属性是否已定义。 | yii\base\BaseObject |
init() | 初始化对象。 | yii\base\BaseObject |
phpTypecast() | 从数据库检索后,根据 $phpType 转换输入值。 | yii\db\mysql\ColumnSchema |
属性详情
列模式是否应省略使用 JSON 支持功能。您可以使用此属性使升级到 Yii 2.0.14 更容易。默认为 false
,表示启用 JSON 支持。
方法详情
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | array |
方法参数 |
返回值 | mixed |
方法返回值 |
---|---|---|
抛出异常 | yii\base\UnknownMethodException |
调用未知方法时 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现执行两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果此方法在子类中被重写,建议
- 构造函数的最后一个参数是一个配置数组,就像这里的
$config
一样。 - 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] ) | ||
$config | array |
将用于初始化对象属性的名称-值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于: yii\base\BaseObject::__get()
返回对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $object->property;
时会隐式调用。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
返回值 | mixed |
属性值 |
---|---|---|
抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
抛出异常 | yii\base\InvalidCallException |
如果属性为只写 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\BaseObject::__isset()
检查属性是否已设置,即已定义且不为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($object->property)
时会被隐式调用。
请注意,如果属性未定义,则将返回 false。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | boolean |
命名的属性是否已设置(非空)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定义于: yii\base\BaseObject::__set()
设置对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $object->property = $value;
时会被隐式调用。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
---|---|---|
抛出异常 | yii\base\InvalidCallException |
如果属性是只读的 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定义于: yii\base\BaseObject::__unset()
将对象属性设置为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($object->property)
时会被隐式调用。
请注意,如果属性未定义,则此方法将不执行任何操作。如果属性是只读的,则会抛出异常。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
抛出异常 | yii\base\InvalidCallException |
如果属性是只读的。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定义于: yii\base\BaseObject::canGetProperty()
返回一个值,指示是否可以读取属性。
如果属性可读,则
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定义于: yii\base\BaseObject::canSetProperty()
返回一个值,指示是否可以设置属性。
如果属性可写,则
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
根据 $type 和 $dbType 转换输入值,以便在数据库查询中使用。
如果值为 null 或 yii\db\Expression,则不会进行转换。
public mixed dbTypecast ( $value ) | ||
$value | mixed |
输入值 |
返回值 | mixed |
转换后的值。这可能也是一个数组,其中第一个元素是值,第二个元素是 PDO 类型。 |
---|
public function dbTypecast($value)
{
if ($value === null) {
return $value;
}
if ($value instanceof ExpressionInterface) {
return $value;
}
if (!$this->disableJsonSupport && $this->dbType === Schema::TYPE_JSON) {
return new JsonExpression($value, $this->type);
}
return $this->typecast($value);
}
定义于: yii\base\BaseObject::hasMethod()
返回一个值,指示方法是否已定义。
默认实现是调用 php 函数 method_exists()
。当您实现 php 魔术方法 __call()
时,您可以覆盖此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名称 |
返回值 | boolean |
方法是否已定义 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定义于: yii\base\BaseObject::hasProperty()
返回一个值,指示属性是否已定义。
如果属性已定义,则
- 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
从数据库检索后,根据 $phpType 转换输入值。
如果值为 null 或 yii\db\Expression,则不会进行转换。
public mixed phpTypecast ( $value ) | ||
$value | mixed |
输入值 |
返回值 | mixed |
转换后的值 |
---|
public function phpTypecast($value)
{
if ($value === null) {
return null;
}
if (!$this->disableJsonSupport && $this->type === Schema::TYPE_JSON) {
return json_decode($value, true);
}
return parent::phpTypecast($value);
}
定义于: yii\db\ColumnSchema::typecast()
从数据库检索后,根据 $phpType 转换输入值。
如果值为 null 或 yii\db\Expression,则不会进行转换。
受保护 混合 typecast ( $value ) | ||
$value | mixed |
输入值 |
返回值 | mixed |
转换后的值 |
---|
protected function typecast($value)
{
if (
$value === ''
&& !in_array(
$this->type,
[
Schema::TYPE_TEXT,
Schema::TYPE_STRING,
Schema::TYPE_BINARY,
Schema::TYPE_CHAR
],
true
)
) {
return null;
}
if (
$value === null
|| gettype($value) === $this->phpType
|| $value instanceof ExpressionInterface
|| $value instanceof Query
) {
return $value;
}
if (
is_array($value)
&& count($value) === 2
&& isset($value[1])
&& in_array($value[1], $this->getPdoParamTypes(), true)
) {
return new PdoValue($value[0], $value[1]);
}
switch ($this->phpType) {
case 'resource':
case 'string':
if (is_resource($value)) {
return $value;
}
if (is_float($value)) {
// ensure type cast always has . as decimal separator in all locales
return StringHelper::floatToString($value);
}
if (
is_numeric($value)
&& ColumnSchemaBuilder::CATEGORY_NUMERIC === ColumnSchemaBuilder::$typeCategoryMap[$this->type]
) {
// https://github.com/yiisoft/yii2/issues/14663
return $value;
}
if (PHP_VERSION_ID >= 80100 && is_object($value) && $value instanceof \BackedEnum) {
return (string) $value->value;
}
return (string) $value;
case 'integer':
if (PHP_VERSION_ID >= 80100 && is_object($value) && $value instanceof \BackedEnum) {
return (int) $value->value;
}
return (int) $value;
case 'boolean':
// treating a 0 bit value as false too
// https://github.com/yiisoft/yii2/issues/9006
return (bool) $value && $value !== "\0" && strtolower($value) !== 'false';
case 'double':
return (float) $value;
}
return $value;
}
注册 或 登录 以发表评论。