laravel5 列出所有事件 和事件实例

首先声明 事件 和 监听者 的对应关系 在 EventServiceProvider.php 的 $listen 数组中
类似:

protected $listen = [
    //'App\Events\Event' => [
    //    'App\Listeners\EventListener',
    //],
    'App\Events\UserLogin' => [
        'App\Listeners\UserLoginListener',
    ],  // 自定义事件
    'Illuminate\Auth\Events\Login' => [
        'App\Listeners\IlluminateUserLoginListener',
    ],  // 使用系统的事件
];

然后使用 php artisan event:generate 来生成基础代码 (已经存在的事件文件 比如 Illuminate\Auth\Events\Login.php 不会重复创建)
修改 生成的 app/Events/UserLogin.php 如下: 即添加 user 类型提示



namespace App\Events;

use App\User;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;

class UserLogin
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public $user;

    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return Channel|array
     */
    public function broadcastOn()
    {
        return new PrivateChannel('channel-name');
    }
}

然后修改

app/Listeners/UserLoginListener.php
/**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  UserLogin  $event
     * @return void
     */
    public function handle(UserLogin $event)
    {
        Log::info('in user login listener custom event and listener');
        Log::info($event->user);
    }
}

最后定义事件分发(触发)代码即可:

在 LoginController 的 login函数 登录完成逻辑后面添加:

event(new UserLogin($request->user()));

这样就完成了 事件的分发。

以上只是事件使用的举例,实际上 登录事件 系统已经定义好了, 当然系统还定义了很多其它的事件。
例如缓存的命中 和 miss 数据库的查询 事务开始等等。
但是如何列出所有的事件,我是通过下面的方法:
使用搜索文件 列出所有 文件夹 叫做 Events 的搜索结果 然后基本上就是系统定义好的事件了,我的搜索编辑器(php storm)自带的

laravel5 列出所有事件 和事件实例_第1张图片

但是这个方法明显不是最有效的,所以如果大侠知道,还希望助一臂之力。

使用方法 :
如上 event service 已经定义了

'Illuminate\Auth\Events\Login' => [
        'App\Listeners\IlluminateUserLoginListener',
],  // 使用系统的事件

这里的 Illuminate\Auth\Events\Login 和 事件分发 都是系统定义好的 ,你只需要实现 App\Listeners\IlluminateUserLoginListener 即可
在刚才 php artisan event:generate 的时候已经生成了 listen 文件了 在 app\Listeners\IlluminateUserLoginListener.php
根据实际 修改 handle 函数即可。

另外想要查看 事件分发 可以搜索 比如 缓存命中 。 首先会看到 Cache 下面的 Events 文件夹 有个 CacheHit.php 那么 全局搜索 CacheHit 即可
具体在
vendor\laravel\framework\src\Illuminate\Cache\Repository.php
this>event(newCacheHit( key, $value));
当然 像 Login 这些就比较多不好找了,可以根据实际 逻辑 慢慢分析 也是找的到的。

大部分 系统定义的事件分发 调用方式有两种:

使用 event
$this->event(new CacheHit($key, $value));
使用 dispatch
return $this->events->dispatch(new Events\TransactionBeginning($this));

你可能感兴趣的:(laravel)