3 フォロワー

クラス yii\behaviors\TimestampBehavior

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

TimestampBehavior は、指定された属性に現在のタイムスタンプを自動的に設定します。

TimestampBehavior を使用する際は、ActiveRecord クラスに以下のコードを追加します。

use yii\behaviors\TimestampBehavior;

public function behaviors()
{
    return [
        TimestampBehavior::class,
    ];
}

デフォルトでは、TimestampBehavior は関連付けられた AR オブジェクトが挿入されるときに `created_at` 属性と `updated_at` 属性に現在のタイムスタンプを設定し、AR オブジェクトが更新されるときに `updated_at` 属性にタイムスタンプを設定します。タイムスタンプの値は `time()` 関数によって取得されます。

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

上記の機能を MySQL データベースで使用するには、カラム（`created_at`、`updated_at`）を UNIX タイムスタンプとして int(11) で宣言してください。

属性名が異なる場合、またはタイムスタンプの計算方法を変更する場合は、$createdAtAttribute、$updatedAtAttribute、および $value プロパティを以下のように設定できます。

use yii\db\Expression;

public function behaviors()
{
    return [
        [
            'class' => TimestampBehavior::class,
            'createdAtAttribute' => 'create_time',
            'updatedAtAttribute' => 'update_time',
            'value' => new Expression('NOW()'),
        ],
    ];
}

上記のように yii\db\Expression オブジェクトを使用する場合、レコードが保存された後、属性にはタイムスタンプ値ではなく、Expression オブジェクト自体が格納されます。後でデータベースから値を取得する必要がある場合は、レコードの refresh() メソッドを呼び出してください。

TimestampBehavior は、指定された属性に現在のタイムスタンプを設定し、データベースに保存できる touch() というメソッドも提供しています。例：

$model->touch('creation_time');

公開プロパティ

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

プロパティ 型 説明 定義元
$attributes array $value を介して指定された値で自動的に設定される属性のリスト。 yii\behaviors\AttributeBehavior
$createdAtAttribute string タイムスタンプ値を受け取る属性。作成時刻を記録しない場合は、このプロパティを false に設定します。 yii\behaviors\TimestampBehavior
$owner yii\base\Component|null このビヘイビアの所有者 yii\base\Behavior
$preserveNonEmptyValues boolean 空でない属性値を保持するかどうか。 yii\behaviors\AttributeBehavior
$skipUpdateOnClean boolean $owner が変更されていない場合にこのビヘイビアをスキップするかどうか。 yii\behaviors\AttributeBehavior
$updatedAtAttribute string タイムスタンプ値を受け取る属性。 yii\behaviors\TimestampBehavior
$value mixed 現在の属性に割り当てられる値。 yii\behaviors\TimestampBehavior

公開メソッド

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

メソッド 説明 定義元
__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\behaviors\TimestampBehavior
touch() タイムスタンプ属性を現在のタイムスタンプに更新します。 yii\behaviors\TimestampBehavior

保護されたメソッド

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

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

プロパティの詳細

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

$createdAtAttribute public property

タイムスタンプ値を受け取る属性。作成時刻を記録しない場合は、このプロパティを false に設定します。

public string $createdAtAttribute = 'created_at'
$updatedAtAttribute public property

タイムスタンプ値を受け取る属性。更新時刻を記録しない場合は、このプロパティを false に設定します。

public string $updatedAtAttribute = 'updated_at'
$value public プロパティ

値がnullの場合、PHP関数time()の結果が値として使用されます。

現在の属性に割り当てられる値です。これは、無名関数、配列形式で呼び出し可能な関数（例：[$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

メソッドパラメータ
戻り値 mixed

メソッドの戻り値
例外 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

プロパティ名
戻り値 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 でないか）を確認します。

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

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

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

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

__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 に設定します。

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

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

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

メンバ変数をプロパティとして扱うかどうか
戻り値 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();
}
detach() publicメソッド

定義場所: yii\base\Behavior::detach()

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

デフォルトの実装では、$ownerプロパティをアンセットし、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メソッド

定義場所: yii\behaviors\AttributeBehavior::evaluateAttributes()

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

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

定義場所: yii\behaviors\AttributeBehavior::events()

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

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

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

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

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

例を以下に示します。

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

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

 

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

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

$valueがnullの場合、PHP関数time()の結果が値として使用されます。

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

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

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

属性値

 

                protected function getValue($event)
{
    if ($this->value === null) {
        return time();
    }
    return parent::getValue($event);
}
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メソッド

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

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

public void init ( )

                public function init()
{
    parent::init();
    if (empty($this->attributes)) {
        $this->attributes = [
            BaseActiveRecord::EVENT_BEFORE_INSERT => [$this->createdAtAttribute, $this->updatedAtAttribute],
            BaseActiveRecord::EVENT_BEFORE_UPDATE => $this->updatedAtAttribute,
        ];
    }
}
touch() publicメソッド

タイムスタンプ属性を現在のタイムスタンプに更新します。

$model->touch('lastVisit');
public void touch ( $attribute )
$attribute string

更新する属性の名前。
例外 yii\base\InvalidCallException

オーナーが新規レコードの場合（バージョン2.0.6以降）。

 

                public function touch($attribute)
{
    /* @var $owner BaseActiveRecord */
    $owner = $this->owner;
    if ($owner->getIsNewRecord()) {
        throw new InvalidCallException('Updating the timestamp is not possible on a new record.');
    }
    $owner->updateAttributes(array_fill_keys((array) $attribute, $this->getValue(null)));
}