How to use Laravel events?

Question

I want to be notified when a new user signs up. In my controller I fire an event as follows.

Event::fire('myapp.new_user', array($this->data['user']->email));

Where do I define the listener?

Event::listen('myapp.new_user', function ($uid) {
    Message::to("[email protected]")
                ->from("[email protected]", "My App")
                ->subject('New User')
                ->body("new user")
                ->html(true)
                ->send();
});

How does the listener know an event fired?

Answer 1

You need to make sure your listeners are defined prior to your application logic executing, when events are thrown they can only be caught by already registered listeners, it does not look for new ones.

On small projects I just place my listeners in application/start.php at the bottom of the file. This file happens before your routes are ran and it serves as sort of a application config file with some logic to it. You need to place these events towards the bottom of the file, at least after the Autoloader mappings have been registered.

On Larger projects I will create application/listeners.php and require this file inside application/start.php for better readability.

Hope this helps!

Answer 2

You can also define classes to handle specific events and then use a Service Provider to register them.

Below is a basic example:

app/NewUserListener.php

The listener which is called when the event is fired:

class NewUserListener
{
    public function handle($uid)
    {
        // Send an email here
    }
}

app/ListenerServiceProvider.php

The ServiceProvider - remember and add this to the list of Service Providers in L4 Config.

use Illuminate\Support\ServiceProvider;

class ListenerServiceProvider extends ServiceProvider
{
        public function register()
        {
            Event::listen('myapp.new_user', 'NewUserListener');
            // Register more events here...
        }
}

If you organize listeners etc. into appropriately named folders, it ends up being a lot easier to maintain should you have a bunch of listeners later. You can also instantiate and test the listeners if you write them in this manner.

Answer 3

try :

Event::listen('myapp.new_user', function ($uid) {
Message::to("[email protected]")
            ->from("[email protected]", "My App")
            ->subject('New User')
            ->body("new user")
            ->html(true)
            ->send();
return 'test my event';
});

http://laravel.com/docs/events