Yii Framework: ユーザログイン後の処理について

Yii の API を眺めていたら CWebUser クラスに afterLogin() というメソッドがあったのでテストしてみました (afterLogin() は v1.1.3 以上で使用可) 。例えば、ユーザがログインした後に自動で、IPアドレスと、ログイン日時をデータベースに保存したい時なんかに便利かと思われます。

やり方

CWebUser を継承した WebUser クラスを protected/components 下に作成し、
afterLogin() メソッドを上書き (ファイル名、クラス名などは任意) 。

	<?php
	class WebUser extends CWebUser
	{
	protected function afterLogin($fromCookie)
	{
	$model = User::model()->findByPk(Yii::app()->user->id);
	$model->last_ip = Yii::app()->request->userHostAddress;
	$model->last_login = new CDbExpression('NOW()');
	$model->save(true, array('last_ip', 'last_login'));
	}
	...

view raw WebUser.php hosted with ❤ by GitHub

続いて protected/config/main.php を編集。

	<?php
	...
	'components' => array(
	'user' => array(
	'class' => 'WebUser', // この行を書かない場合は、デフォルトのCWebUserが使われる
	...

view raw main.php hosted with ❤ by GitHub

CWebUser クラスを API で見る限り、ログイン、ログアウトまわりのメソッドとして beforeLogin(), beforeLogout(), afterLogin(), afterLogout() などがあります。

もちろん、例えばコントローラなどの actionLogin() で、バリデーションが通ったあとに、afterLogin() と同じようなコードを書くこともできますが、ログイン、ログアウト周りの実装を一元管理できる利点もあり、また CWebUser クラスには他にも、さまざまな重要な役割があるので、それをまとめてひとつのクラスファイルとして扱え、かつカスタマイズできることを考えると、使わない手はないと思います。

ただ、エクステンションの yii-user などを見ていたら、このへんを一元管理しておらず、部分部分で実装しているようです (これはおそらく v.1.1.3 になる以前に yii-user が作られたことが理由かもしれませんが) 。

参考リンク

• Yii API: CwebUser
• Yii API: CWebUser::afterLogin()
• Yii Extension: yii-user