0 フォロワー

クラス yii\db\Constraint

継承	yii\db\Constraint » yii\base\BaseObject
実装	yii\base\Configurable
サブクラス	yii\db\CheckConstraint、yii\db\DefaultValueConstraint、yii\db\ForeignKeyConstraint、yii\db\IndexConstraint
利用可能なバージョン	2.0.13
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/db/Constraint.php

Constraint は、テーブル制約のメタデータを表します。

公開プロパティ

継承されたプロパティを非表示

プロパティ	型	説明	定義元
$columnNames	string[]\|null	制約が属する列名のリスト。	yii\db\Constraint
$name	string\|null	制約名。	yii\db\Constraint

公開メソッド

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

メソッド	説明	定義元
__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

プロパティの詳細

継承されたプロパティを非表示

$columnNames public property

制約が属する列名のリスト。

public string[]|null $columnNames = null

$name public property

制約名。

public string|null $name = null

メソッドの詳細

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

__call() public method

定義元: 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 method

定義元: 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()

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

これは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);
}

__isset() publicメソッド

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

プロパティが設定されているかどうか、つまり定義されていてnullでないかどうかをチェックします。

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

プロパティが定義されていない場合、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()

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

これは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);
    }
}

__unset() publicメソッド

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

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

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

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

参照: 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()
{
}