0 フォロワー

クラス yii\behaviors\AttributeTypecastBehavior

継承	yii\behaviors\AttributeTypecastBehavior » yii\base\Behavior » yii\base\BaseObject
実装	yii\base\Configurable
利用可能なバージョン	2.0.10
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/behaviors/AttributeTypecastBehavior.php

AttributeTypecastBehavior は、モデル属性の自動型変換機能を提供します。

このビヘイビアは、MongoDBやRedisのようなスキーマレスデータベースでActiveRecordを使用する場合に非常に便利です。また、通常のyii\db\ActiveRecordや、yii\base\Modelに対しても、モデルのバリデーション後に厳密な属性型を維持するために役立ちます。

このビヘイビアは、yii\base\Modelまたはyii\db\BaseActiveRecordの子孫にアタッチする必要があります。

$attributeTypes を使用して、正確な属性型を指定する必要があります。

例:

use yii\behaviors\AttributeTypecastBehavior;

class Item extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                'attributeTypes' => [
                    'amount' => AttributeTypecastBehavior::TYPE_INTEGER,
                    'price' => AttributeTypecastBehavior::TYPE_FLOAT,
                    'is_active' => AttributeTypecastBehavior::TYPE_BOOLEAN,
                ],
                'typecastAfterValidate' => true,
                'typecastBeforeSave' => false,
                'typecastAfterFind' => false,
            ],
        ];
    }

    // ...
}

ヒント: $attributeTypes を空白のままにすると、その値はオーナーのバリデーションルールに基づいて自動的に検出されます。次の例では、上記で設定されたものと同じ $attributeTypes 値が自動的に作成されます。

use yii\behaviors\AttributeTypecastBehavior;

class Item extends \yii\db\ActiveRecord
{

    public function rules()
    {
        return [
            ['amount', 'integer'],
            ['price', 'number'],
            ['is_active', 'boolean'],
        ];
    }

    public function behaviors()
    {
        return [
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ];
    }

    // ...
}

このビヘイビアでは、以下のケースで属性の自動型変換が可能です。

モデルのバリデーションが成功した後
モデルの保存前（挿入または更新）
モデルの検索後（クエリで発見またはリフレッシュされた場合）

$typecastAfterValidate, $typecastBeforeSave, および $typecastAfterFind の各フィールドを使用して、特定のケースの自動型変換を制御できます。デフォルトでは、型変換はモデルのバリデーション後にのみ実行されます。

注意: typecastAttributes() メソッドを呼び出すことで、いつでも手動で属性型変換をトリガーできます。

$model = new Item();
$model->price = '38.5';
$model->is_active = 1;
$model->typecastAttributes();

公開プロパティ

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

プロパティ	型	説明	定義元
$attributeTypes	array\|null	属性名 => 型の形式の属性型キャストマップ。	yii\behaviors\AttributeTypecastBehavior
$owner	yii\base\Model\|yii\db\BaseActiveRecord	このビヘイビアのオーナー。	yii\behaviors\AttributeTypecastBehavior
$skipOnNull	boolean	`null` 値の型変換をスキップするかどうか。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterFind	boolean	データベースからオーナーモデルのデータを取得した後（検索またはリフレッシュ後）に型変換を実行するかどうか。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterSave	boolean	オーナーモデルを保存した後（挿入または更新）に型変換を実行するかどうか。	yii\behaviors\AttributeTypecastBehavior
$typecastAfterValidate	boolean	オーナーモデルのバリデーション後に型変換を実行するかどうか。	yii\behaviors\AttributeTypecastBehavior
$typecastBeforeSave	boolean	オーナーモデルを保存する前（挿入または更新）に型変換を実行するかどうか。	yii\behaviors\AttributeTypecastBehavior

公開メソッド

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

メソッド	説明	定義元
__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
afterFind()	オーナーの「afterFind」イベントを処理し、属性の型変換を確実にします。	yii\behaviors\AttributeTypecastBehavior
afterSave()	オーナーの「afterInsert」および「afterUpdate」イベントを処理し、属性の型変換を確実にします。	yii\behaviors\AttributeTypecastBehavior
afterValidate()	オーナーの「afterValidate」イベントを処理し、属性の型変換を確実にします。	yii\behaviors\AttributeTypecastBehavior
attach()	ビヘイビアオブジェクトをコンポーネントにアタッチします。	yii\behaviors\AttributeTypecastBehavior
beforeSave()	オーナーの「beforeInsert」および「beforeUpdate」イベントを処理し、属性の型変換を確実にします。	yii\behaviors\AttributeTypecastBehavior
canGetProperty()	プロパティを読み取ることができるかどうかを示す値を返します。	yii\base\BaseObject
canSetProperty()	プロパティを設定できるかどうかを示す値を返します。	yii\base\BaseObject
className()	このクラスの完全修飾名を返します。	yii\base\BaseObject
clearAutoDetectedAttributeTypes()	影響を受けるすべてのオーナークラスにおける自動検出された $attributeTypes 値の内部静的キャッシュをクリアします。	yii\behaviors\AttributeTypecastBehavior
detach()	ビヘイビアオブジェクトをコンポーネントからデタッチします。	yii\base\Behavior
events()	$owner のイベントのイベントハンドラーを宣言します。	yii\behaviors\AttributeTypecastBehavior
hasMethod()	メソッドが定義されているかどうかを示す値を返します。	yii\base\BaseObject
hasProperty()	プロパティが定義されているかどうかを示す値を返します。	yii\base\BaseObject
init()	オブジェクトを初期化します。	yii\base\BaseObject
typecastAttributes()	$attributeTypes に従ってオーナー属性を型変換します。	yii\behaviors\AttributeTypecastBehavior

保護されたメソッド

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

メソッド	説明	定義元
detectAttributeTypes()	オーナーのバリデーションルールから $attributeTypes のデフォルト値を構成します。	yii\behaviors\AttributeTypecastBehavior
resetOldAttributes()	名前付き属性の古い値をリセットします。	yii\behaviors\AttributeTypecastBehavior
typecastValue()	指定された型に値をキャストします。	yii\behaviors\AttributeTypecastBehavior

定数

継承された定数を非表示

定数	値	定義元
TYPE_BOOLEAN	'boolean'	yii\behaviors\AttributeTypecastBehavior
TYPE_FLOAT	'float'	yii\behaviors\AttributeTypecastBehavior
TYPE_INTEGER	'integer'	yii\behaviors\AttributeTypecastBehavior
TYPE_STRING	'string'	yii\behaviors\AttributeTypecastBehavior

プロパティの詳細

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

$attributeTypes public プロパティ

属性型キャストマップを、属性名 => 型の形式で設定します。型は、生の値を引数として受け取り、型キャスト結果を返すPHPのcallableを使用して設定できます。例：

[
    'amount' => 'integer',
    'price' => 'float',
    'is_active' => 'boolean',
    'date' => function ($value) {
        return ($value instanceof \DateTime) ? $value->getTimestamp(): (int) $value;
    },
]

設定しない場合、属性型マップはオーナーのバリデーションルールから自動的に構成されます。

public array|null $attributeTypes = null

$owner public プロパティ

このビヘイビアのオーナー。

public yii\base\Model|yii\db\BaseActiveRecord $owner = null

$skipOnNull public プロパティ

null値の型キャストをスキップするかどうか。有効にした場合、nullと等しい属性値は型キャストされません（例：nullはnullのまま）。そうでない場合は、$attributeTypesで設定された型に従って変換されます。

public boolean $skipOnNull = true

$typecastAfterFind public プロパティ

データベースからオーナーモデルのデータを取得した後に（findまたはrefreshの後）、型キャストを実行するかどうか。このオプションを無効にすると、パフォーマンスが向上する場合があります。たとえば、yii\db\ActiveRecordを使用する場合、find後の型キャストはほとんどの場合メリットがないため、無効にできます。このオプションの値を変更しても、このビヘイビアがモデルにアタッチされた後は効果がないことに注意してください。

public boolean $typecastAfterFind = false

$typecastAfterSave public プロパティ (バージョン 2.0.14 以降で利用可能)

オーナーモデルを保存（挿入または更新）した後に型キャストを実行するかどうか。このオプションを無効にすると、パフォーマンスが向上する場合があります。たとえば、yii\db\ActiveRecordを使用する場合、保存後の型キャストはほとんどの場合メリットがないため、無効にできます。このオプションの値を変更しても、このビヘイビアがモデルにアタッチされた後は効果がないことに注意してください。

public boolean $typecastAfterSave = false

$typecastAfterValidate public プロパティ

オーナーモデルのバリデーション後に型キャストを実行するかどうか。型キャストは、バリデーションが成功した場合（例：オーナーモデルにエラーがない場合）にのみ実行されることに注意してください。このオプションの値を変更しても、このビヘイビアがモデルにアタッチされた後は効果がないことに注意してください。

public boolean $typecastAfterValidate = true

$typecastBeforeSave public プロパティ

オーナーモデルを保存（挿入または更新）する前に型キャストを実行するかどうか。このオプションを無効にすると、パフォーマンスが向上する場合があります。たとえば、yii\db\ActiveRecordを使用する場合、保存前の型キャストはほとんどの場合メリットがないため、無効にできます。このオプションの値を変更しても、このビヘイビアがモデルにアタッチされた後は効果がないことに注意してください。

public boolean $typecastBeforeSave = false

メソッドの詳細

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

__call() public メソッド

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

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

不明なメソッドが呼び出されたときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

public mixed __call ( $name, $params )
$name	string	メソッド名
$params	array	メソッドのパラメータ
return	mixed	メソッドの戻り値
throws	yii\base\UnknownMethodException	不明なメソッドを呼び出すとき

public void __construct ( $config = [] )
$config	array	オブジェクトのプロパティを初期化するために使用される名前と値のペア

public mixed __get ( $name )
$name	string	プロパティ名
return	mixed	プロパティ値
throws	yii\base\UnknownPropertyException	プロパティが定義されていない場合
throws	yii\base\InvalidCallException	プロパティが書き込み専用の場合

public boolean __isset ( $name )
$name	string	プロパティ名またはイベント名
return	boolean	指定されたプロパティが設定されているかどうか（nullではない）。

public void __set ( $name, $value )
$name	string	プロパティ名またはイベント名
$value	mixed	プロパティ値
throws	yii\base\UnknownPropertyException	プロパティが定義されていない場合
throws	yii\base\InvalidCallException	プロパティが読み取り専用の場合

public void __unset ( $name )
$name	string	プロパティ名
throws	yii\base\InvalidCallException	プロパティが読み取り専用の場合。

public void afterFind ( $event )
$event	yii\base\Event	イベントインスタンス。

public void afterSave ( $event )
$event	yii\base\Event	イベントインスタンス。

public void afterValidate ( $event )
$event	yii\base\Event	イベントインスタンス。

public void attach ( $owner )
$owner	yii\base\Component	このビヘイビアがアタッチされるコンポーネント。

public void beforeSave ( $event )
$event	yii\base\Event	イベントインスタンス。

protected array detectAttributeTypes ( )
return	array	属性型マップ。

public array events ( )
return	array	イベント (配列のキー) と対応するイベントハンドラメソッド (配列の値)。

public void typecastAttributes ( $attributeNames = null )
$attributeNames	array\|null	型キャストされる属性名のリスト。このパラメータが空の場合、$attributeTypes にリストされている任意の属性が型キャストされることを意味します。

protected mixed typecastValue ( $value, $type )
$value	mixed	型キャストされる値。
$type	string\|callable	型名または型キャスト可能なcallable。
return	mixed	型キャストの結果。

public boolean canGetProperty ( $name, $checkVars = true )
$name	string	プロパティ名
$checkVars	boolean	メンバ変数をプロパティとして扱うかどうか
return	boolean	プロパティが読み取り可能かどうか

public boolean canSetProperty ( $name, $checkVars = true )
$name	string	プロパティ名
$checkVars	boolean	メンバ変数をプロパティとして扱うかどうか
return	boolean	プロパティが書き込み可能かどうか

public static string className ( )
return	string	このクラスの完全修飾名。

public boolean hasMethod ( $name )
$name	string	メソッド名
return	boolean	メソッドが定義されているかどうか

public boolean hasProperty ( $name, $checkVars = true )
$name	string	プロパティ名
$checkVars	boolean	メンバ変数をプロパティとして扱うかどうか
return	boolean	プロパティが定義されているかどうか