文档章节

学了两年半,Yii2的内置事件知多少?

阿北2017
 阿北2017
发布于 2017/05/23 00:02
字数 1195
阅读 571
收藏 16

书接上回,我将代码提交到服务器后被小X经理一顿批,她是这样说的。

小X: 你丫不知道yii2自己就有登陆后的事件么?
我:不知道啊,咋的吧?
小X:改!😡😡😡😡,然后统计个yii2预定义事件表给我。
我:哦,好的。😱😱😱

好吧,算咱技术不到家,那就赶紧改吧,先回顾下上一篇我都干了啥,我是在会员登陆后触发了一个事件,既然说有内置的,那就找找吧。

我知道登陆功能是使用yii\web\User这个类,那应该去那里去找它们。它在@app/vendor/yiisoft/yii2/web/User.php

@@nai8@@

5分钟以后~

果然,我找到了那个事件,还用了3分钟分析了如何使用,现在把我的研究成果和大家分享下。

对于yii2系统的登陆,yii\web\User类一共提供了4个事件,如下

const EVENT_BEFORE_LOGIN = 'beforeLogin';
const EVENT_AFTER_LOGIN = 'afterLogin';
const EVENT_BEFORE_LOGOUT = 'beforeLogout';
const EVENT_AFTER_LOGOUT = 'afterLogout';

分别是登陆前后、注销前后,我要使用的是EVENT_AFTER_LOGIN事件,那么如何去使用那?

既然是登陆,还是先看下yii\web\User中的login方法,看看是否有蛛丝马迹

public function login(IdentityInterface $identity, $duration = 0){

    if ($this->beforeLogin($identity, false, $duration)) {
        $this->switchIdentity($identity, $duration);
        $id = $identity->getId();
        $ip = Yii::$app->getRequest()->getUserIP();
        if ($this->enableSession) {
            $log = "User '$id' logged in from $ip with duration $duration.";
        } else {
            $log = "User '$id' logged in from $ip. Session not enabled.";
        }
        Yii::info($log, __METHOD__);
        $this->afterLogin($identity, false, $duration);
    }

    return !$this->getIsGuest();
}    

我看到了 $this->afterLogin($identity, false, $duration),似乎这个方法是登陆后做了一些事情,那就继续看吧

protected function afterLogin($identity, $cookieBased, $duration){

    $this->trigger(self::EVENT_AFTER_LOGIN, new UserEvent([
        'identity' => $identity,
        'cookieBased' => $cookieBased,
        'duration' => $duration,
    ]));
}    

OMG,真的发现了,原来这个方法触发了EVENT_AFTER_LOGIN事件,并且还很贴心的将identity等信息传递给了绑定EVENT_AFTER_LOGIN事件的每一位观察者。

于是思路来了㊙️㊙️㊙️㊙️㊙️㊙️

我只需要在login前绑定EVENT_AFTER_LOGIN事件,然后afterLogin会自动触发所有订阅者。

重构开始

use yii\web\User;
class UserController extends Controller {
	
	public function __construct(){
		//	绑定事件
		$this->on(User::EVENT_AFTER_LOGIN,['app\models\OLog','add']); 
		$this->on(User::EVENT_AFTER_LOGIN,['app\models\Admin','sendMail']); 
		$this->on(User::EVENT_AFTER_LOGIN,['app\models\User','notifyFirend']); 
	}
	
	public function actionIndex(){
		.....
		//	login				
	}
}

我之前定义的EVENT_USER_LOGIN自然可以删除了,上面看到afterLogin方法触发事件的时候已经传递了一个UserEvent,里面含有登陆的详细信息了,我上一篇自己定义的那个UserLoginEvent也就可以删除了。

使用系统自带的事件,真心省了太多代码了,感谢yii2开发团队,感谢你们八倍祖主。

对于登陆主题就重构完了,现在我还需要改下订阅者的代码,毕竟传递给订阅者的$event不一样了,拿一个订阅者举例吧

// User app\models\User.php
class User {
    static public function notifyFirend($event){
        $userId = $event->userId;
        echo "告诉了朋友们我登陆了";
    }
}

我要对其进行小手术,diu一下,手术后的样子如下

// User app\models\User.php
class User {
    static public function notifyFirend($event){
        $userId = $event->identity->id;
        echo "告诉了朋友们我登陆了";
    }
}

ok~ 到此为止我们对登陆逻辑的事件处理就完成了,去掉了自定义的事件,绑定了 User::EVENT_AFTER_LOGIN 内置事件。

还没完~

是的还没完,小X经理还让我提交一个yii2预定义事件表给她,我深刻体会到这个表格的重要性,有了它,便可以通晓yii所有事件,正所谓就算成功,也不一定自宫。

但是,yii2这么大,我如何一个不落的得到它们那?

看来要借助于我们的神器PHPSTORM了。

首先我们知道yii2对于事件名的命名规则,常量大写、观察下发现内置的这些事件都是EVENT_开头的,有了这些特征,那开始吧。

**方法如下:**我们对vendor/yiisoft目录进行查找(find in path),找到所有const EVENT_开头的行。

输入图片说明

是的,一共有41个。最近听说有个叫阿北的人做了一个yii速查表,我计划将这个表格分享给他也。

yii2速查表之event内置一览表 http://nai8.me/tool-sc.html

建议你背下这些事件,至少在做事件的时候查一遍速查表,能用系统的优先使用系统的。

学到了一些

很高兴完成了小x经理关于登陆事件的需求,通过这些让我对yii的事件有了一个大体了解,知道了事件是观察者模式的一种实现、知道yii2内置了很多事件,我们应该优先使用它们。

begin git。

一阵QQ震动,带着坏笑的小x经理发了一句消息给我:“来,小北同学!”

天,又咋了,下篇告诉你。 输入图片说明

© 著作权归作者所有

共有 人打赏支持
阿北2017
粉丝 66
博文 58
码字总数 74348
作品 0
洛阳
私信 提问
加载中

评论(2)

阿北2017
阿北2017

引用来自“落雪无声”的评论

你有一个好的老板啊。

回复@落雪无声 : 恩,是哈。
落雪无声
落雪无声
你有一个好的老板啊。
Yii 2 公共预览版发布

我们非常高兴宣布 Yii 2 公共预览版发布,地址在 GItHub,这是Yii2在开始开发到两年多的重写的一个里程碑。 注意:Yii2还正处于开发阶段,可能会在不通知的情况下引入较大的修改,所以不要在...

首席烤地瓜
2013/05/04
2.6K
15
YII FORM表单怎样修改按钮的样式?

@Susanno 你好,想跟你请教个问题:YII form 表单, 你好,我在北京混口饭吃。 我干开发快两年了,之前一直是前端,会一点后台代码,现在新公司转行做PHP开发,公司开始使用YII框架。在FORM表...

cooldown
2013/04/01
3.2K
1
Yii2 实例管理

Yii2 实例管理 Yii2框架没有提供类似ZendFramework3中提供的ServiceManager.那么Yii2框架是如何管理对象实例的呢? 长时间使用Yii2框架的童鞋一定已经适应了对象中的public变量,以及一个来自y...

Vett
2017/12/23
0
0
从配置文件的角度去了解Yii2

前言 Yii2是一个奇特的框架,其牺牲了现在盛行的解耦设计,用一个高度耦合的结构提供给开发者一个方便的几类抽象,Application,Module,Component,甚至是ServiceLocator.想让对象具备哪类特征就直...

Vett
2017/12/23
0
0
详解Yii2框架中生成URL的方法

前言 在项目中,推荐使用 Yii2 内置的 URL 工具类生成链接,这样可以非常便捷的管理整站的 URL 行为:比如通过修改配置改变整站的URL格式等。URL 更多高级的用法参见官方文档,这篇文章仅仅介...

botkenni
06/07
0
0

没有更多内容

加载失败,请刷新页面

加载更多

二十分钟教你如何将区块链应用与函数计算相结合

前言 本篇文章适合对区块链应用感兴趣或是想要通过函数计算服务进一步开发区块链应用的新人。本文将结合阿里云区块链服务、阿里云函数计算服务、阿里云日志服务 以及社区应用 Marbles,手把手...

阿里云官方博客
6分钟前
1
0
Double数相加后结果不准确

在我们进行两个double运算时,例如:2..0-1.1 不是想象的输出0.9,而是0.89999999999999999。其主要原因是浮点数值采用二进制系统表示,而在二进制系统中无法精确的表示分数1/10。这就好像十...

嘴角轻扬30
14分钟前
1
0
去除移动端点击效果

移动端点击时,会有一个类似active的短暂背景淡出效果,去除该效果可使用 -webkit-tap-highlight-color: rgba(255, 0, 0, 0);

originDu
15分钟前
1
0
腾讯云与MariaDB 基金会签署战略合作,共建全球开源生态圈

本文由云+社区发表 腾讯云日前与MariaDB基金会正式签署战略合作协议,2019年,腾讯云将继续以白金会员身份为基金会的发展提供强有力的资源支持,与MariaDB全球用户和开发者一道,共建开放共赢...

腾讯云加社区
20分钟前
1
0
Kotlin的SAM(Single Abstract Method)

今天有人在群里问kotlin支持SAM的问题,其实kotlin不支持SAM,因为人家支持FP(function programing) package reactinterface Test { fun print()}class TestInterface(var...

SuShine
21分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部