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 property

参照先のテーブルの列名のリスト。

public string[] $foreignColumnNames = null
$foreignSchemaName public property

参照先のテーブルのスキーマ名。

public string|null $foreignSchemaName = null
$foreignTableName public property

参照先のテーブル名。

public string $foreignTableName = null
$onDelete public プロパティ

参照先のテーブルの行が削除された場合の参照アクション。

public string|null $onDelete = null
$onUpdate public プロパティ

参照先のテーブルの行が更新された場合の参照アクション。

public string|null $onUpdate = null

メソッドの詳細

継承されたメソッドを非表示

__call() public メソッド

定義場所: yii\base\BaseObject::__call()

クラスメソッドではない名前付きメソッドを呼び出します。

これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。

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()");
}
__construct() public メソッド

定義場所: yii\base\BaseObject::__construct()

コンストラクタ。

デフォルトの実装では、次の2つの処理を行います。

  • 与えられた設定 `$config` を使用してオブジェクトを初期化します。
  • init() を呼び出します。

このメソッドを子クラスでオーバーライドする場合は、

  • コンストラクタの最後の引数を、ここに示す `$config` のように、設定配列にすることを推奨します。
  • コンストラクタの最後に、親クラスの実装を呼び出してください。
public void __construct ( $config = [] )
$config array

オブジェクトのプロパティを初期化するために使用される名前と値のペア

 

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

定義場所: yii\base\BaseObject::__get()

オブジェクトのプロパティの値を返します。

`$value = $object->property;` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

__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);
}
__isset() public メソッド

定義場所: yii\base\BaseObject::__isset()

プロパティが設定されているか（つまり、定義されていてnullではないか）を確認します。

`isset($object->property)` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合は、falseが返されることに注意してください。

https://www.php.net/manual/en/function.isset.php も参照してください。

public boolean __isset ( $name )
$name string[]

プロパティ名またはイベント名
戻り値 boolean

指定されたプロパティが設定されているかどうか（nullでないか）。

 

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

定義場所: yii\base\BaseObject::__set()

オブジェクトのプロパティの値を設定します。

`$object->property = $value;` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

__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);
    }
}
__unset() public メソッド

定義場所: yii\base\BaseObject::__unset()

オブジェクトのプロパティをnullに設定します。

`unset($object->property)` を実行した際に暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合は、このメソッドは何もしません。プロパティが読み取り専用の場合は、例外をスローします。

https://www.php.net/manual/en/function.unset.php も参照してください。

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);
    }
}
canGetProperty() public メソッド

定義場所: yii\base\BaseObject::canGetProperty()

プロパティを読み取ることができるかどうかを示す値を返します。

プロパティは、以下の場合に読み取り可能です。

  • クラスに、指定された名前（この場合はプロパティ名で、大文字小文字は区別されません）に関連付けられたゲッターメソッドが存在する場合。
  • クラスに、指定された名前のメンバ変数がある場合（`$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);
}
canSetProperty() public メソッド

定義場所: yii\base\BaseObject::canSetProperty()

プロパティを設定できるかどうかを示す値を返します。

プロパティは、以下の場合に書き込み可能です。

  • クラスに、指定された名前（この場合はプロパティ名で、大文字小文字は区別されません）に関連付けられたセッターメソッドが存在する場合。
  • クラスに、指定された名前のメンバ変数がある場合（`$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);
}
className() public static メソッド
2.0.14 以降非推奨。PHP >= 5.5 では、代わりに `::class` を使用してください。

定義済み: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
戻り値 string[]

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
hasMethod() public メソッド

定義済み: 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);
}
hasProperty() public メソッド

定義済み: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されています。

  • クラスが、指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスに、指定された名前のメンバ変数がある場合（`$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);
}
init() public メソッド

定義済み: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された設定で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}