0 關注者

類別 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 布林值 指示此欄位是否可為空值。 yii\db\ColumnSchema
$autoIncrement 布林值 指示此欄位是否為自動遞增 yii\db\ColumnSchema
$comment 字串 此欄位的註解。 yii\db\ColumnSchema
$dbType 字串 此欄位的資料庫類型。 yii\db\ColumnSchema
$defaultValue 混合 此欄位的預設值 yii\db\ColumnSchema
$enumValues 陣列 可列舉的值。 yii\db\ColumnSchema
$isPrimaryKey 布林值 指示此欄位是否為主鍵 yii\db\ColumnSchema
$name 字串 此欄位的名稱 (不含引號)。 yii\db\ColumnSchema
$phpType 字串 此欄位的 PHP 類型。 yii\db\ColumnSchema
$precision 整數 欄位資料的精度，如果為數值類型。 yii\db\ColumnSchema
$scale 整數 欄位資料的刻度，如果為數值類型。 yii\db\ColumnSchema
$size 整數 欄位的顯示大小。 yii\db\ColumnSchema
$type 字串 此欄位的抽象類型。 yii\db\ColumnSchema
$unsigned 布林值 指示此欄位是否為無符號。 yii\db\ColumnSchema

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\BaseObject
__construct() 建構子。 yii\base\BaseObject
__get() 傳回物件屬性的值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定，即已定義且非空值。 yii\base\BaseObject
__set() 設定物件屬性的值。 yii\base\BaseObject
__unset() 將物件屬性設定為空值。 yii\base\BaseObject
canGetProperty() 傳回值，指示屬性是否可讀取。 yii\base\BaseObject
canSetProperty() 傳回值，指示屬性是否可設定。 yii\base\BaseObject
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
dbTypecast() 根據 $type 和 $dbType 轉換輸入值，以用於資料庫查詢。 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 boolean $allowNull = null
$autoIncrement 公開屬性

指示此欄位是否為自動遞增

public boolean $autoIncrement = false
$comment 公開屬性

此欄位的註解。並非所有 DBMS 皆支援此功能。

public string $comment = null
$dbType 公開屬性

此欄位的資料庫類型。可能的資料庫類型因 DBMS 類型而異。

public string $dbType = null
$defaultValue public property

此欄位的預設值

public mixed $defaultValue = null
$enumValues public property

可列舉的值。只有當欄位宣告為可列舉類型時才會設定。

public array $enumValues = null
$isPrimaryKey public property

指示此欄位是否為主鍵

public boolean $isPrimaryKey = null
$name public property

此欄位的名稱 (不含引號)。

public string $name = null
$phpType public property

此欄位的 PHP 類型。可能的 PHP 類型包括：string、boolean、integer、double、array。

public string $phpType = null
$precision public property

欄位資料的精度，如果為數值類型。

public integer $precision = null
$scale public property

欄位資料的刻度，如果為數值類型。

public integer $scale = null
$size public property

欄位的顯示大小。

public integer $size = null
$type public property

此欄位的抽象類型。可能的抽象類型包括：char、string、text、boolean、smallint、integer、bigint、float、decimal、datetime、timestamp、time、date、binary 和 money。

public string $type = null
$unsigned public property

此欄位是否為無符號。這只有在 $type 為 smallint、integer 或 bigint 時才有意義。

public boolean $unsigned = null

方法詳細資訊

隱藏繼承的方法

__call() public method

定義於： yii\base\BaseObject::__call()

呼叫指定的非類別方法。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當呼叫未知方法時會被隱式呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱
$params 陣列

方法參數
return 混合

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

定義於： yii\base\BaseObject::__construct()

建構子。

預設實作會做兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果這個方法在子類別中被覆寫，建議

  • 建構子的最後一個參數是一個組態陣列，就像這裡的 $config 一樣。
  • 在建構子的結尾呼叫父類別的實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值對

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

定義於： yii\base\BaseObject::__get()

傳回物件屬性的值。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 $value = $object->property; 時會被隱式呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name 字串

屬性名稱
return 混合

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws 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);
}
__isset() public method

定義於： yii\base\BaseObject::__isset()

檢查屬性是否已設定，即已定義且非空值。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 isset($object->property) 時會被隱式呼叫。

請注意，如果屬性未定義，將會傳回 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
return 布林值

具名屬性是否已設定（非 null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

定義於： yii\base\BaseObject::__set()

設定物件屬性的值。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 $object->property = $value; 時會被隱式呼叫。

另請參閱 __get()。

public void __set ( $name, $value )
$name 字串

屬性名稱或事件名稱
$value 混合

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws 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);
    }
}
__unset() public method

定義於： yii\base\BaseObject::__unset()

將物件屬性設定為空值。

請勿直接呼叫此方法，因為它是一個 PHP 魔術方法，當執行 unset($object->property) 時會被隱式呼叫。

請注意，如果屬性未定義，此方法將不會執行任何操作。如果屬性為唯讀，它將拋出例外。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name 字串

屬性名稱
throws 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);
    }
}
canGetProperty() public method

定義於： yii\base\BaseObject::canGetProperty()

傳回值，指示屬性是否可讀取。

如果屬性可讀取

  • 類別具有與指定名稱相關聯的 getter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

屬性是否可讀取

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

定義於： yii\base\BaseObject::canSetProperty()

傳回值，指示屬性是否可設定。

如果屬性可寫入

  • 類別具有與指定名稱相關聯的 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

屬性是否可寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
自 2.0.14 版本起已過時。在 PHP >=5.5 上，請改用 ::class。

定義於： yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return 字串

此類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
dbTypecast() public method

根據 $type 和 $dbType 轉換輸入值，以用於資料庫查詢。

如果值為 null 或 yii\db\Expression，則不會轉換。

public mixed dbTypecast ( $value )
$value 混合

輸入值
return 混合

轉換後的值。這也可能是一個陣列，其中包含值作為第一個元素，PDO 類型作為第二個元素。

 

                public function dbTypecast($value)
{
    // the default implementation does the same as casting for PHP, but it should be possible
    // to override this with annotation of explicit PDO type.
    return $this->typecast($value);
}
hasMethod() public method

定義於： yii\base\BaseObject::hasMethod()

傳回值，指示方法是否已定義。

預設實作是呼叫 php 函數 method_exists()。當您實作了 php 魔術方法 __call() 時，可以覆寫此方法。

public boolean hasMethod ( $name )
$name 字串

方法名稱
return 布林值

方法是否已定義

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

定義於： yii\base\BaseObject::hasProperty()

傳回值，指示屬性是否已定義。

如果屬性已定義

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱

public boolean hasProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars 布林值

是否將成員變數視為屬性
return 布林值

屬性是否已定義

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

定義於： yii\base\BaseObject::init()

初始化物件。

在物件使用給定的組態初始化後，此方法會在建構子的結尾被調用。

public void init ( )

                public function init()
{
}
phpTypecast() public method

從資料庫檢索後，根據 $phpType 轉換輸入值。

如果值為 null 或 yii\db\Expression，則不會轉換。

public mixed phpTypecast ( $value )
$value 混合

輸入值
return 混合

轉換後的值

 

                public function phpTypecast($value)
{
    return $this->typecast($value);
}
typecast() protected method (available since version 2.0.3)

從資料庫檢索後，根據 $phpType 轉換輸入值。

如果值為 null 或 yii\db\Expression，則不會轉換。

protected mixed typecast ( $value )
$value 混合

輸入值
return 混合

轉換後的值

 

                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;
}