0 關注者

類別 yii\db\ForeignKeyConstraint

所有類別 | 屬性 | 方法
繼承yii\db\ForeignKeyConstraint » yii\db\Constraint » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0.13
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/db/ForeignKeyConstraint.php

ForeignKeyConstraint 代表資料表 FOREIGN KEY 約束的元數據。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$columnNames string[]|null 約束所屬的欄位名稱列表。 yii\db\Constraint
$foreignColumnNames string[] 參考表格欄位名稱列表。 yii\db\ForeignKeyConstraint
$foreignSchemaName string|null 參考表格綱要名稱。 yii\db\ForeignKeyConstraint
$foreignTableName string 參考表格名稱。 yii\db\ForeignKeyConstraint
$name string|null 約束名稱。 yii\db\Constraint
$onDelete string|null 若要刪除參考表格中的資料列時的參考動作。 yii\db\ForeignKeyConstraint
$onUpdate string|null 若要更新參考表格中的資料列時的參考動作。 yii\db\ForeignKeyConstraint

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
hasMethod() 傳回值，指出方法是否已定義。 yii\base\BaseObject
hasProperty() 傳回值，指出屬性是否已定義。 yii\base\BaseObject
init() 初始化物件。 yii\base\BaseObject

屬性詳細資訊

隱藏繼承的屬性

$foreignColumnNames 公開屬性

參考表格欄位名稱列表。

public string[] $foreignColumnNames = null
$foreignSchemaName 公開屬性

參考表格綱要名稱。

public string|null $foreignSchemaName = null
$foreignTableName 公開屬性

參考表格名稱。

public string $foreignTableName = null
$onDelete 公開屬性

若要刪除參考表格中的資料列時的參考動作。

public string|null $onDelete = null
$onUpdate 公開屬性

若要更新參考表格中的資料列時的參考動作。

public string|null $onUpdate = null

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

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

呼叫未定義為類別方法的具名方法。

請勿直接呼叫此方法，因為它是 PHP 的魔術方法，當未知的的方法被調用時，它會被隱含地呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱
$params array

方法參數
return mixed

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

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

定義於： 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();
}
__get() 公開方法

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

傳回物件屬性的值。

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

另請參閱 __set()。

public mixed __get ( $name )
$name string

屬性名稱
return mixed

屬性值
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() 公開方法

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

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

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

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return boolean

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

 

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

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

設定物件屬性的值。

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

另請參閱 __get()。

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱
$value mixed

屬性值
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() 公開方法

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

將物件屬性設定為 null。

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

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

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

public void __unset ( $name )
$name string

屬性名稱
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() 公開方法

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

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

如果符合以下條件，屬性即可讀取：

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

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可以讀取

 

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

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

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

如果符合以下條件，屬性即可寫入：

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

另請參閱 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可以寫入

 

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

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

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

public static string className ( )
return string

此類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
hasMethod() 公開方法

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

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

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

public boolean hasMethod ( $name )
$name string

方法名稱
return boolean

方法是否已定義

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公開方法

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

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

如果符合以下條件，屬性即已定義：

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

另請參閱

public boolean hasProperty ( $name, $checkVars = true )
$name string

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否已定義

 

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

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

初始化物件。

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

public void init ( )

                public function init()
{
}