1 フォロワー

クラス yii\behaviors\AttributeBehavior

すべてのクラス | プロパティ | メソッド
継承yii\behaviors\AttributeBehavior » yii\base\Behavior » yii\base\BaseObject
実装yii\base\Configurable
サブクラスyii\behaviors\BlameableBehavior, yii\behaviors\OptimisticLockBehavior, yii\behaviors\SluggableBehavior, yii\behaviors\TimestampBehavior
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/behaviors/AttributeBehavior.php

AttributeBehavior は、特定のイベントが発生したときに、ActiveRecord オブジェクトの1つまたは複数の属性に指定された値を自動的に割り当てます。

AttributeBehavior を使用するには、更新が必要な属性のリストと更新をトリガーする対応するイベントを指定する $attributes プロパティを構成します。次に、現在の属性に割り当てるために使用される戻り値を持つ PHP の呼び出し可能なもので $value プロパティを構成します。例えば、

use yii\behaviors\AttributeBehavior;

public function behaviors()
{
    return [
        [
            'class' => AttributeBehavior::class,
            'attributes' => [
                ActiveRecord::EVENT_BEFORE_INSERT => 'attribute1',
                ActiveRecord::EVENT_BEFORE_UPDATE => 'attribute2',
            ],
            'value' => function ($event) {
                return 'some value';
            },
        ],
    ];
}

属性値はこのビヘイビアによって自動的に設定されるため、通常はユーザー入力ではなく、検証されるべきではありません。つまり、モデルの rules() メソッドには表示されるべきではありません。

パブリックプロパティ

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

プロパティ タイプ 説明 定義元
$attributes array $value で指定された値で自動的に入力される属性のリスト。 yii\behaviors\AttributeBehavior
$owner yii\base\Component|null このビヘイビアのオーナー yii\base\Behavior
$preserveNonEmptyValues boolean 空でない属性値を保持するかどうか。 yii\behaviors\AttributeBehavior
$skipUpdateOnClean boolean $owner が変更されていない場合、このビヘイビアをスキップするかどうか yii\behaviors\AttributeBehavior
$value mixed 現在の属性に割り当てられる値。 yii\behaviors\AttributeBehavior

パブリックメソッド

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

メソッド 説明 定義元
__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
attach() ビヘイビアオブジェクトをコンポーネントにアタッチします。 yii\base\Behavior
canGetProperty() プロパティを読み取ることができるかどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティを設定できるかどうかを示す値を返します。 yii\base\BaseObject
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
detach() ビヘイビアオブジェクトをコンポーネントからデタッチします。 yii\base\Behavior
evaluateAttributes() 属性値を評価し、現在の属性に割り当てます。 yii\behaviors\AttributeBehavior
events() $owner のイベントのイベントハンドラを宣言します。 yii\behaviors\AttributeBehavior
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject

保護されたメソッド

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

メソッド 説明 定義元
getValue() 現在の属性の値を返します。 yii\behaviors\AttributeBehavior

プロパティの詳細

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

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

$value で指定された値で自動的に入力される属性のリスト。配列キーは、属性が更新される ActiveRecord イベントであり、配列値は、更新される対応する属性です。単一の属性を表すには文字列を使用するか、属性のリストを表すには配列を使用できます。例えば、

[
    ActiveRecord::EVENT_BEFORE_INSERT => ['attribute1', 'attribute2'],
    ActiveRecord::EVENT_BEFORE_UPDATE => 'attribute2',
]
public array $attributes = []
$preserveNonEmptyValues パブリックプロパティ (バージョン 2.0.13 から利用可能)

空でない属性値を保持するかどうか。

public boolean $preserveNonEmptyValues = false
$skipUpdateOnClean パブリックプロパティ (バージョン 2.0.8 から利用可能)

$owner が変更されていない場合、このビヘイビアをスキップするかどうか

public boolean $skipUpdateOnClean = true
$value パブリックプロパティ

現在の属性に割り当てられる値。これは、匿名関数、配列形式で呼び出し可能なもの（例：[$this, 'methodName']）、DB式を表すExpressionオブジェクト（例：new Expression('NOW()')）、スカラー、文字列、または任意の値を指定できます。前者の場合、関数の戻り値が属性に割り当てられます。関数のシグネチャは次のとおりです。

function ($event)
{
    // return value will be assigned to the attribute
}
public mixed $value = 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);
    }
}
attach() public メソッド

定義元: yii\base\Behavior::attach()

ビヘイビアオブジェクトをコンポーネントにアタッチします。

デフォルトの実装では、$owner プロパティを設定し、events() で宣言されているようにイベントハンドラーをアタッチします。このメソッドをオーバーライドする場合は、必ず親の実装を呼び出してください。

public void attach ( $owner )
$owner yii\base\Component

このビヘイビアがアタッチされるコンポーネント。

 

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}
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 メソッド
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();
}
detach() public メソッド

定義元: yii\base\Behavior::detach()

ビヘイビアオブジェクトをコンポーネントからデタッチします。

デフォルトの実装では、$owner プロパティをunsetし、events() で宣言されたイベントハンドラをデタッチします。このメソッドをオーバーライドする場合は、必ず親の実装を呼び出してください。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
evaluateAttributes() public メソッド

属性値を評価し、現在の属性に割り当てます。

public void evaluateAttributes ( $event )
$event yii\base\Event 

                public function evaluateAttributes($event)
{
    if (
        $this->skipUpdateOnClean
        && $event->name == ActiveRecord::EVENT_BEFORE_UPDATE
        && empty($this->owner->dirtyAttributes)
    ) {
        return;
    }
    if (!empty($this->attributes[$event->name])) {
        $attributes = (array) $this->attributes[$event->name];
        $value = $this->getValue($event);
        foreach ($attributes as $attribute) {
            // ignore attribute names which are not string (e.g. when set by TimestampBehavior::updatedAtAttribute)
            if (is_string($attribute)) {
                if ($this->preserveNonEmptyValues && !empty($this->owner->$attribute)) {
                    continue;
                }
                $this->owner->$attribute = $value;
            }
        }
    }
}
events() public メソッド

$owner のイベントのイベントハンドラを宣言します。

子クラスは、このメソッドをオーバーライドして、$owner コンポーネントのイベントにアタッチする PHP コールバックを宣言できます。

コールバックは、ビヘイビアがオーナーにアタッチされたときに $owner のイベントにアタッチされ、ビヘイビアがコンポーネントからデタッチされたときにイベントからデタッチされます。

コールバックは以下のいずれかになります。

  • このビヘイビアのメソッド: 'handleClick'、[$this, 'handleClick'] と同等
  • オブジェクトメソッド: [$object, 'handleClick']
  • 静的メソッド: ['Page', 'handleClick']
  • 匿名関数: function ($event) { ... }

以下は例です

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
return array

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

 

                public function events()
{
    return array_fill_keys(
        array_keys($this->attributes),
        'evaluateAttributes'
    );
}
getValue() protected メソッド

現在の属性の値を返します。

このメソッドは evaluateAttributes() によって呼び出されます。その戻り値は、トリガーイベントに対応する属性に割り当てられます。

protected mixed getValue ( $event )
$event yii\base\Event

現在の属性更新をトリガーするイベント。
return mixed

属性の値

 

                protected function getValue($event)
{
    if ($this->value instanceof Closure || (is_array($this->value) && is_callable($this->value))) {
        return call_user_func($this->value, $event);
    }
    return $this->value;
}
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()

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

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

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