0 フォロワー

クラス yii\db\ColumnSchemaBuilder

すべてのクラス | プロパティ | メソッド | 定数
継承yii\db\ColumnSchemaBuilder » yii\base\BaseObject
実装yii\base\Configurable
サブクラスyii\db\cubrid\ColumnSchemaBuilder, yii\db\mssql\ColumnSchemaBuilder, yii\db\mysql\ColumnSchemaBuilder, yii\db\oci\ColumnSchemaBuilder, yii\db\sqlite\ColumnSchemaBuilder
利用可能なバージョン2.0.6
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/db/ColumnSchemaBuilder.php

ColumnSchemaBuilderは、PHPインターフェースを使用してデータベーススキーマ型を定義するのに役立ちます。

詳細な説明と使用例については、yii\db\SchemaBuilderTraitを参照してください。

パブリックプロパティ

継承されたプロパティを隠す

プロパティ 型 説明 定義元
$after string この列が追加される列の後。 yii\db\ColumnSchemaBuilder
$append mixed 列スキーマ定義に追加されるSQL文字列。 yii\db\ColumnSchemaBuilder
$categoryMap array 抽象列型（キー）から型カテゴリ（値）へのマッピング。 yii\db\ColumnSchemaBuilder
$check string 列のCHECK制約。 yii\db\ColumnSchemaBuilder
$comment string 列のコメント値。 yii\db\ColumnSchemaBuilder
$db yii\db\Connection 現在のデータベース接続。 yii\db\ColumnSchemaBuilder
$default mixed 列のデフォルト値。 yii\db\ColumnSchemaBuilder
$isFirst boolean この列をテーブルの先頭に挿入するかどうか。 yii\db\ColumnSchemaBuilder
$isNotNull boolean|null 列がnull許容かどうか。 yii\db\ColumnSchemaBuilder
$isUnique boolean 列の値が一意である必要があるかどうか。 yii\db\ColumnSchemaBuilder
$isUnsigned boolean 列の値が符号なしである必要があるかどうか。 yii\db\ColumnSchemaBuilder
$length integer|string|array 列のサイズまたは精度定義。 yii\db\ColumnSchemaBuilder
$type string INTEGER、VARCHAR、DATETIMEなどの列型定義。 yii\db\ColumnSchemaBuilder
$typeCategoryMap array 抽象列型（キー）から型カテゴリ（値）へのマッピング。 yii\db\ColumnSchemaBuilder

保護されたプロパティ

継承されたプロパティを隠す

プロパティ 型 説明 定義元

パブリックメソッド

継承されたメソッドを隠す

メソッド 説明 定義元
__call() クラスメソッドではない名前付きメソッドを呼び出します。 yii\base\BaseObject
__construct() 型と値の精度を指定して、列スキーマビルダーインスタンスを作成します。 yii\db\ColumnSchemaBuilder
__get() オブジェクトプロパティの値を返します。 yii\base\BaseObject
__isset() プロパティが設定されている、つまり定義されていてnullでないかどうかを確認します。 yii\base\BaseObject
__set() オブジェクトプロパティの値を設定します。 yii\base\BaseObject
__toString() 列のスキーマの完全な文字列を構築します。 yii\db\ColumnSchemaBuilder
__unset() オブジェクトプロパティをnullに設定します。 yii\base\BaseObject
after() 列にAFTER制約を追加します。 yii\db\ColumnSchemaBuilder
append() 列定義に追加する追加のSQLを指定します。 yii\db\ColumnSchemaBuilder
canGetProperty() プロパティを読み取ることができるかどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティを設定できるかどうかを示す値を返します。 yii\base\BaseObject
check() 列のCHECK制約を設定します。 yii\db\ColumnSchemaBuilder
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
comment() 列のコメントを指定します。 yii\db\ColumnSchemaBuilder
defaultExpression() 列のデフォルトのSQL式を指定します。 yii\db\ColumnSchemaBuilder
defaultValue() 列のデフォルト値を指定します。 yii\db\ColumnSchemaBuilder
first() 列にFIRST制約を追加します。 yii\db\ColumnSchemaBuilder
getCategoryMap() yii\db\ColumnSchemaBuilder
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
notNull() 列にNOT NULL制約を追加します。 yii\db\ColumnSchemaBuilder
null() 列にNULL制約を追加します。 yii\db\ColumnSchemaBuilder
setCategoryMap() yii\db\ColumnSchemaBuilder
unique() 列にUNIQUE制約を追加します。 yii\db\ColumnSchemaBuilder
unsigned() 列を符号なしとしてマークします。 yii\db\ColumnSchemaBuilder

保護されたメソッド

継承されたメソッドを隠す

メソッド 説明 定義元
buildAfterString() 列のafter制約を構築します。デフォルトではサポートされていません。 yii\db\ColumnSchemaBuilder
buildAppendString() 列定義に追加されるカスタム文字列を構築します。 yii\db\ColumnSchemaBuilder
buildCheckString() 列のチェック制約を構築します。 yii\db\ColumnSchemaBuilder
buildCommentString() 列のコメント仕様を構築します。 yii\db\ColumnSchemaBuilder
buildCompleteString() 入力形式から完全な列定義を返します。 yii\db\ColumnSchemaBuilder
buildDefaultString() 列のデフォルト値仕様を構築します。 yii\db\ColumnSchemaBuilder
buildDefaultValue() 列のデフォルト値を返します。 yii\db\ColumnSchemaBuilder
buildFirstString() 列の最初の制約を構築します。デフォルトではサポートされていません。 yii\db\ColumnSchemaBuilder
buildLengthString() 列の長さ/精度部分を構築します。 yii\db\ColumnSchemaBuilder
buildNotNullString() 列のnot null制約を構築します。 yii\db\ColumnSchemaBuilder
buildUniqueString() 列の一意の制約を構築します。 yii\db\ColumnSchemaBuilder
buildUnsignedString() 列の符号なし文字列を構築します。デフォルトではサポートされていません。 yii\db\ColumnSchemaBuilder
getTypeCategory() 列型のカテゴリを返します。 yii\db\ColumnSchemaBuilder

定数

継承された定数を隠す

定数 値 説明 定義元
CATEGORY_NUMERIC 'numeric' yii\db\ColumnSchemaBuilder
CATEGORY_OTHER 'other' yii\db\ColumnSchemaBuilder
CATEGORY_PK 'pk' yii\db\ColumnSchemaBuilder
CATEGORY_STRING 'string' yii\db\ColumnSchemaBuilder
CATEGORY_TIME 'time' yii\db\ColumnSchemaBuilder

プロパティの詳細

継承されたプロパティを隠す

$after 保護されたプロパティ (バージョン2.0.8以降で利用可能)

この列が追加される列の後。

protected string $after = null
$append 保護されたプロパティ (バージョン2.0.9以降で利用可能)

列スキーマ定義に追加されるSQL文字列。

protected mixed $append = null
$categoryMap パブリックプロパティ

抽象列型（キー）から型カテゴリ（値）へのマッピング。

public array $categoryMap = null
$check protected プロパティ

列のCHECK制約。

protected string $check = null
$comment public プロパティ (バージョン 2.0.8 以降)

列のコメント値。

public string $comment = null
$db public プロパティ (バージョン 2.0.8 以降)

現在のデータベース接続。主に最終的なカラムスキーマ文字列を構築する際に、文字列を安全にエスケープするために使用されます。

public yii\db\Connection $db = null
$default protected プロパティ

列のデフォルト値。

protected mixed $default = null
$isFirst protected プロパティ (バージョン 2.0.8 以降)

この列をテーブルの先頭に挿入するかどうか。

protected boolean $isFirst = null
$isNotNull protected プロパティ

カラムがnullableかどうか。これがtrueの場合、NOT NULL制約が追加されます。これがfalseの場合、NULL制約が追加されます。

protected boolean|null $isNotNull = null
$isUnique protected プロパティ

カラム値が一意であるべきかどうか。これがtrueの場合、UNIQUE制約が追加されます。

protected boolean $isUnique = false
$isUnsigned protected プロパティ (バージョン 2.0.7 以降)

カラム値が符号なしであるべきかどうか。これがtrueの場合、UNSIGNEDキーワードが追加されます。

protected boolean $isUnsigned = false
$length protected プロパティ

カラムのサイズまたは精度定義。これは、カラムタイプの後の括弧内に入るものです。これは、文字列、整数、または配列のいずれかです。配列の場合、配列の値はカンマで区切られた文字列に結合されます。

protected integer|string|array $length = null
$type protected プロパティ

INTEGER、VARCHAR、DATETIMEなどの列型定義。

protected string $type = null
$typeCategoryMap public static プロパティ (バージョン 2.0.43 以降)

抽象列型（キー）から型カテゴリ（値）へのマッピング。

public static array $typeCategoryMap = [
    \yii\db\Schema::TYPE_PK => self::CATEGORY_PK,
    \yii\db\Schema::TYPE_UPK => self::CATEGORY_PK,
    \yii\db\Schema::TYPE_BIGPK => self::CATEGORY_PK,
    \yii\db\Schema::TYPE_UBIGPK => self::CATEGORY_PK,
    \yii\db\Schema::TYPE_CHAR => self::CATEGORY_STRING,
    \yii\db\Schema::TYPE_STRING => self::CATEGORY_STRING,
    \yii\db\Schema::TYPE_TEXT => self::CATEGORY_STRING,
    \yii\db\Schema::TYPE_TINYINT => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_SMALLINT => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_INTEGER => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_BIGINT => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_FLOAT => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_DOUBLE => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_DECIMAL => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_DATETIME => self::CATEGORY_TIME,
    \yii\db\Schema::TYPE_TIMESTAMP => self::CATEGORY_TIME,
    \yii\db\Schema::TYPE_TIME => self::CATEGORY_TIME,
    \yii\db\Schema::TYPE_DATE => self::CATEGORY_TIME,
    \yii\db\Schema::TYPE_BINARY => self::CATEGORY_OTHER,
    \yii\db\Schema::TYPE_BOOLEAN => self::CATEGORY_NUMERIC,
    \yii\db\Schema::TYPE_MONEY => self::CATEGORY_NUMERIC,
]

メソッドの詳細

継承されたメソッドを隠す

__call() public メソッド

定義元: 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() public メソッド

型と値の精度を指定して、列スキーマビルダーインスタンスを作成します。

public void __construct ( $type, $length = null, $db = null, $config = [] )
$type string

カラムの型。$typeを参照してください。
$length integer|string|array|null

カラムの長さまたは精度。$lengthを参照してください。
$db yii\db\Connection|null

現在のデータベース接続。$dbを参照してください。
$config array

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

 

                public function __construct($type, $length = null, $db = null, $config = [])
{
    $this->type = $type;
    $this->length = $length;
    $this->db = $db;
    parent::__construct($config);
}
__get() public メソッド

定義元: yii\base\BaseObject::__get()

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

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

こちらも参照してください: __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() public method

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

プロパティ名またはイベント名
return boolean

指定されたプロパティが設定されているか（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()

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

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

参考: __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);
    }
}
__toString() public method

列のスキーマの完全な文字列を構築します。

public string __toString ( )

                public function __toString()
{
    switch ($this->getTypeCategory()) {
        case self::CATEGORY_PK:
            $format = '{type}{check}{comment}{append}';
            break;
        default:
            $format = '{type}{length}{notnull}{unique}{default}{check}{comment}{append}';
    }
    return $this->buildCompleteString($format);
}
__unset() public method

定義元: yii\base\BaseObject::__unset()

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

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

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

参考: https://www.php.net/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);
    }
}
after() public method (バージョン 2.0.8 から利用可能)

列にAFTER制約を追加します。

注: MySQL、Oracle、Cubrid のみがサポートしています。

public $this after ( $after )
$after string

この列が追加される列。

 

                public function after($after)
{
    $this->after = $after;
    return $this;
}
append() public method (バージョン 2.0.9 から利用可能)

列定義に追加する追加のSQLを指定します。

位置修飾子は、それらをサポートするデータベース内の列定義の後に追加されます。

public $this append ( $sql )
$sql string

追加される SQL 文字列。

 

                public function append($sql)
{
    $this->append = $sql;
    return $this;
}
buildAfterString() protected method (バージョン 2.0.8 から利用可能)

列のafter制約を構築します。デフォルトではサポートされていません。

protected string buildAfterString ( )
return string

AFTER 制約を含む文字列。

 

                protected function buildAfterString()
{
    return '';
}
buildAppendString() protected method (バージョン 2.0.9 から利用可能)

列定義に追加されるカスタム文字列を構築します。

protected string buildAppendString ( )
return string

追加するカスタム文字列。

 

                protected function buildAppendString()
{
    return $this->append !== null ? ' ' . $this->append : '';
}
buildCheckString() protected method

列のチェック制約を構築します。

protected string buildCheckString ( )
return string

CHECK 制約を含む文字列。

 

                protected function buildCheckString()
{
    return $this->check !== null ? " CHECK ({$this->check})" : '';
}
buildCommentString() protected method (バージョン 2.0.8 から利用可能)

列のコメント仕様を構築します。

protected string buildCommentString ( )
return string

COMMENT キーワードとコメント自体を含む文字列

 

                protected function buildCommentString()
{
    return '';
}
buildCompleteString() protected method (バージョン 2.0.8 から利用可能)

入力形式から完全な列定義を返します。

protected string buildCompleteString ( $format )
$format string

定義の形式。
return string

完全な列定義を含む文字列。

 

                protected function buildCompleteString($format)
{
    $placeholderValues = [
        '{type}' => $this->type,
        '{length}' => $this->buildLengthString(),
        '{unsigned}' => $this->buildUnsignedString(),
        '{notnull}' => $this->buildNotNullString(),
        '{unique}' => $this->buildUniqueString(),
        '{default}' => $this->buildDefaultString(),
        '{check}' => $this->buildCheckString(),
        '{comment}' => $this->buildCommentString(),
        '{pos}' => $this->isFirst ? $this->buildFirstString() : $this->buildAfterString(),
        '{append}' => $this->buildAppendString(),
    ];
    return strtr($format, $placeholderValues);
}
buildDefaultString() protected メソッド

列のデフォルト値仕様を構築します。

protected string buildDefaultString ( )
return string

カラムのデフォルト値を持つ文字列。

 

                protected function buildDefaultString()
{
    $defaultValue = $this->buildDefaultValue();
    if ($defaultValue === null) {
        return '';
    }
    return ' DEFAULT ' . $defaultValue;
}
buildDefaultValue() protected メソッド

列のデフォルト値を返します。

protected string|null buildDefaultValue ( )
return string|null

カラムのデフォルト値を持つ文字列。

 

                protected function buildDefaultValue()
{
    if ($this->default === null) {
        return $this->isNotNull === false ? 'NULL' : null;
    }
    switch (gettype($this->default)) {
        case 'double':
            // ensure type cast always has . as decimal separator in all locales
            $defaultValue = StringHelper::floatToString($this->default);
            break;
        case 'boolean':
            $defaultValue = $this->default ? 'TRUE' : 'FALSE';
            break;
        case 'integer':
        case 'object':
            $defaultValue = (string) $this->default;
            break;
        default:
            $defaultValue = "'{$this->default}'";
    }
    return $defaultValue;
}
buildFirstString() protected メソッド (バージョン 2.0.8 から利用可能)

列の最初の制約を構築します。デフォルトではサポートされていません。

protected string buildFirstString ( )
return string

FIRST制約を含む文字列。

 

                protected function buildFirstString()
{
    return '';
}
buildLengthString() protected メソッド

列の長さ/精度部分を構築します。

protected string buildLengthString ( )

                protected function buildLengthString()
{
    if ($this->length === null || $this->length === []) {
        return '';
    }
    if (is_array($this->length)) {
        $this->length = implode(',', $this->length);
    }
    return "({$this->length})";
}
buildNotNullString() protected メソッド

列のnot null制約を構築します。

protected string buildNotNullString ( )
return string

$isNotNull が true の場合は 'NOT NULL' を、$isNotNull が false の場合は 'NULL' を、それ以外の場合は空の文字列を返します。

 

                protected function buildNotNullString()
{
    if ($this->isNotNull === true) {
        return ' NOT NULL';
    } elseif ($this->isNotNull === false) {
        return ' NULL';
    }
    return '';
}
buildUniqueString() protected メソッド

列の一意の制約を構築します。

protected string buildUniqueString ( )
return string

$isUnique が true の場合は文字列 'UNIQUE' を返し、それ以外の場合は空の文字列を返します。

 

                protected function buildUniqueString()
{
    return $this->isUnique ? ' UNIQUE' : '';
}
buildUnsignedString() protected メソッド (バージョン 2.0.7 から利用可能)

列の符号なし文字列を構築します。デフォルトではサポートされていません。

protected string buildUnsignedString ( )
return string

UNSIGNED キーワードを含む文字列。

 

                protected function buildUnsignedString()
{
    return '';
}
canGetProperty() public メソッド

定義元: yii\base\BaseObject::canGetProperty()

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

プロパティが読み取り可能となるのは、

  • クラスが指定された名前に関連付けられたゲッターメソッドを持っている場合 (この場合、プロパティ名は大文字と小文字を区別しません)。
  • クラスが指定された名前のメンバ変数を持っている場合 ($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() public メソッド

定義元: yii\base\BaseObject::canSetProperty()

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

プロパティが書き込み可能となるのは、

  • クラスが指定された名前に関連付けられたセッターメソッドを持っている場合 (この場合、プロパティ名は大文字と小文字を区別しません)。
  • クラスが指定された名前のメンバ変数を持っている場合 ($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);
}
check() public メソッド

列のCHECK制約を設定します。

public $this check ( $check )
$check string

追加される CHECK 制約の SQL。

 

                public function check($check)
{
    $this->check = $check;
    return $this;
}
className() public static メソッド
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();
}
comment() public メソッド (バージョン 2.0.8 から利用可能)

列のコメントを指定します。

public $this comment ( $comment )
$comment string

コメント

 

                public function comment($comment)
{
    $this->comment = $comment;
    return $this;
}
defaultExpression() public メソッド (バージョン 2.0.7 から利用可能)

列のデフォルトのSQL式を指定します。

public $this defaultExpression ( $default )
$default string

デフォルト値の式。

 

                public function defaultExpression($default)
{
    $this->default = new Expression($default);
    return $this;
}
defaultValue() public メソッド

列のデフォルト値を指定します。

public $this defaultValue ( $default )
$default mixed

デフォルト値。

 

                public function defaultValue($default)
{
    if ($default === null) {
        $this->null();
    }
    $this->default = $default;
    return $this;
}
first() public メソッド (バージョン 2.0.8 から利用可能)

列にFIRST制約を追加します。

注: MySQL、Oracle、Cubrid のみがサポートしています。

public $this first ( )

                public function first()
{
    $this->isFirst = true;
    return $this;
}
getCategoryMap() public メソッド (バージョン 2.0.43 から利用可能)

public array getCategoryMap ( )
return array

抽象列型（キー）から型カテゴリ（値）へのマッピング。

 

                public function getCategoryMap()
{
    return static::$typeCategoryMap;
}
getTypeCategory() protected メソッド (バージョン 2.0.8 から利用可能)

列型のカテゴリを返します。

protected string getTypeCategory ( )
return string

カラム型カテゴリ名を含む文字列。

 

                protected function getTypeCategory()
{
    return isset($this->categoryMap[$this->type]) ? $this->categoryMap[$this->type] : null;
}
hasMethod() public メソッド

定義元: 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() public メソッド

定義元: yii\base\BaseObject::hasProperty()

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

プロパティが定義されているのは、次の場合です。

  • クラスが、指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合 (この場合、プロパティ名は大文字と小文字を区別しません)。
  • クラスが指定された名前のメンバ変数を持っている場合 ($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() public メソッド

定義元: yii\base\BaseObject::init()

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

このメソッドは、オブジェクトが与えられた構成で初期化された後、コンストラクターの最後で呼び出されます。

public void init ( )

                public function init()
{
}
notNull() public メソッド

列にNOT NULL制約を追加します。

public $this notNull ( )

                public function notNull()
{
    $this->isNotNull = true;
    return $this;
}
null() public メソッド (バージョン 2.0.9 から利用可能)

列にNULL制約を追加します。

public $this null ( )

                public function null()
{
    $this->isNotNull = false;
    return $this;
}
setCategoryMap() public メソッド (バージョン 2.0.43 から利用可能)

public void setCategoryMap ( $categoryMap )
$categoryMap array

抽象列型（キー）から型カテゴリ（値）へのマッピング。

 

                public function setCategoryMap($categoryMap)
{
    static::$typeCategoryMap = $categoryMap;
}
unique() public メソッド

列にUNIQUE制約を追加します。

public $this unique ( )

                public function unique()
{
    $this->isUnique = true;
    return $this;
}
unsigned() public メソッド (バージョン 2.0.7 から利用可能)

列を符号なしとしてマークします。

public $this unsigned ( )

                public function unsigned()
{
    switch ($this->type) {
        case Schema::TYPE_PK:
            $this->type = Schema::TYPE_UPK;
            break;
        case Schema::TYPE_BIGPK:
            $this->type = Schema::TYPE_UBIGPK;
            break;
    }
    $this->isUnsigned = true;
    return $this;
}