0 フォロワー

クラス yii\db\pgsql\ColumnSchema

継承yii\db\pgsql\ColumnSchema » yii\db\ColumnSchema » yii\base\BaseObject
実装yii\base\Configurable
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/db/pgsql/ColumnSchema.php

PostgreSQLデータベース用のColumnSchemaクラスです。

パブリックプロパティ

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

プロパティ 説明 定義元
$allowNull boolean このカラムがNULLを許容するかどうか。 yii\db\ColumnSchema
$autoIncrement boolean このカラムが自動インクリメントかどうか yii\db\ColumnSchema
$comment string このカラムのコメント。 yii\db\ColumnSchema
$dbType string このカラムのDB型。 yii\db\ColumnSchema
$defaultValue mixed このカラムのデフォルト値 yii\db\ColumnSchema
$deserializeArrayColumnToArrayExpression boolean 配列カラムの値をyii\db\ArrayExpressionオブジェクトにアンシリアライズするかどうか。 yii\db\pgsql\ColumnSchema
$dimension integer 配列の次元。 yii\db\pgsql\ColumnSchema
$disableArraySupport boolean カラムスキーマがPgSQL配列サポート機能の使用を省略するかどうか。 yii\db\pgsql\ColumnSchema
$disableJsonSupport boolean カラムスキーマがJSONサポート機能の使用を省略するかどうか。 yii\db\pgsql\ColumnSchema
$enumValues array 列挙可能な値。 yii\db\ColumnSchema
$isPrimaryKey boolean このカラムが主キーかどうか yii\db\ColumnSchema
$name string このカラムの名前(引用符なし)。 yii\db\ColumnSchema
$phpType string このカラムのPHP型。 yii\db\ColumnSchema
$precision integer 数値型の場合のカラムデータの精度。 yii\db\ColumnSchema
$scale integer 数値型の場合のカラムデータのスケール。 yii\db\ColumnSchema
$sequenceName string カラムが自動インクリメントの場合の関連するシーケンスの名前 yii\db\pgsql\ColumnSchema
$size integer カラムの表示サイズ。 yii\db\ColumnSchema
$type string このカラムの抽象型。 yii\db\ColumnSchema
$unsigned boolean このカラムが符号なしかどうか。 yii\db\ColumnSchema

パブリックメソッド

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

メソッド 説明 定義元
__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
dbTypecast() $typeおよび$dbTypeに従って、データベースクエリで使用するために入力値を変換します。 yii\db\pgsql\ColumnSchema
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
phpTypecast() データベースからの取得後、$phpTypeに従って入力値を変換します。 yii\db\pgsql\ColumnSchema

保護されたメソッド

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

メソッド 説明 定義元
getArrayParser() ArrayParserのインスタンスを作成します yii\db\pgsql\ColumnSchema
phpTypecastValue() DBMSから取得した後の$valueをPHP表現にキャストします。 yii\db\pgsql\ColumnSchema
typecast() データベースからの取得後、$phpTypeに従って入力値を変換します。 yii\db\ColumnSchema

プロパティの詳細

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

$deserializeArrayColumnToArrayExpression パブリックプロパティ(バージョン2.0.14.1以降で利用可能)
2.0.14.1以降非推奨となり、2.1で削除される予定です。

配列カラムの値をyii\db\ArrayExpressionオブジェクトにアンシリアライズするかどうか。このプロパティを使用して、Yii 2.0.14へのアップグレードを容易にすることができます。デフォルトはtrueで、配列がyii\db\ArrayExpressionオブジェクトにアンシリアライズされることを意味します。

$dimension パブリックプロパティ

配列の次元。デフォルトは0で、このカラムが配列ではないことを意味します。

public integer $dimension 0
$disableArraySupport パブリックプロパティ(バージョン2.0.14.1以降で利用可能)
2.0.14.1以降非推奨となり、2.1で削除される予定です。

カラムスキーマがPgSQL配列サポート機能の使用を省略するかどうか。このプロパティを使用して、Yii 2.0.14へのアップグレードを容易にすることができます。デフォルトはfalseで、配列サポートが有効になっていることを意味します。

$disableJsonSupport public プロパティ (バージョン 2.0.14.1 から利用可能)
2.0.14.1以降非推奨となり、2.1で削除される予定です。

カラムスキーマがJSONサポート機能を使用しないようにするかどうか。このプロパティを使用すると、Yii 2.0.14へのアップグレードが容易になります。デフォルトはfalseで、JSONサポートが有効であることを意味します。

$sequenceName public プロパティ (バージョン 2.0.29 から利用可能)

カラムが自動インクリメントの場合の関連するシーケンスの名前

public string $sequenceName null

メソッド詳細

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

__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 メソッド

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

プロパティ名

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 メソッド

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

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

            
__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

プロパティ名

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 メソッド

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

            
className() public static method
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();
}

            
dbTypecast() public method

$typeおよび$dbTypeに従って、データベースクエリで使用するために入力値を変換します。

値が null または yii\db\Expression の場合、変換は行われません。

public mixed dbTypecast ( $value )
$value mixed

入力値

return mixed

変換された値。これは、最初の要素として値、2番目の要素として PDO タイプを含む配列になる場合もあります。

                public function dbTypecast($value)
{
    if ($value === null) {
        return $value;
    }
    if ($value instanceof ExpressionInterface) {
        return $value;
    }
    if ($this->dimension > 0) {
        return $this->disableArraySupport
            ? (string) $value
            : new ArrayExpression($value, $this->dbType, $this->dimension);
    }
    if (!$this->disableJsonSupport && in_array($this->dbType, [Schema::TYPE_JSON, Schema::TYPE_JSONB], true)) {
        return new JsonExpression($value, $this->dbType);
    }
    return $this->typecast($value);
}

            
getArrayParser() protected method

ArrayParserのインスタンスを作成します

protected yii\db\pgsql\ArrayParser getArrayParser ( )

                protected function getArrayParser()
{
    static $parser = null;
    if ($parser === null) {
        $parser = new ArrayParser();
    }
    return $parser;
}

            
hasMethod() public method

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

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

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

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

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

public void init ( )

                public function init()
{
}

            
phpTypecast() public method

データベースからの取得後、$phpTypeに従って入力値を変換します。

値が null または yii\db\Expression の場合、変換は行われません。

public mixed phpTypecast ( $value )
$value mixed

入力値

return mixed

変換された値

                public function phpTypecast($value)
{
    if ($this->dimension > 0) {
        if ($this->disableArraySupport) {
            return $value;
        }
        if (!is_array($value)) {
            $value = $this->getArrayParser()->parse($value);
        }
        if (is_array($value)) {
            array_walk_recursive($value, function (&$val, $key) {
                $val = $this->phpTypecastValue($val);
            });
        } elseif ($value === null) {
            return null;
        }
        return $this->deserializeArrayColumnToArrayExpression
            ? new ArrayExpression($value, $this->dbType, $this->dimension)
            : $value;
    }
    return $this->phpTypecastValue($value);
}

            
phpTypecastValue() protected method

DBMSから取得した後の$valueをPHP表現にキャストします。

protected boolean|mixed|null phpTypecastValue ( $value )
$value string|null

                protected function phpTypecastValue($value)
{
    if ($value === null) {
        return null;
    }
    switch ($this->type) {
        case Schema::TYPE_BOOLEAN:
            switch (strtolower($value)) {
                case 't':
                case 'true':
                    return true;
                case 'f':
                case 'false':
                    return false;
            }
            return (bool) $value;
        case Schema::TYPE_JSON:
            return $this->disableJsonSupport ? $value : json_decode($value, true);
    }
    return parent::phpTypecast($value);
}

            
typecast() protected method (バージョン 2.0.3 から利用可能)

定義場所: yii\db\ColumnSchema::typecast()

データベースからの取得後、$phpTypeに従って入力値を変換します。

値が null または yii\db\Expression の場合、変換は行われません。

protected mixed typecast ( $value )
$value mixed

入力値

return mixed

変換された値

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