Login event listener in Symfony2

Login event listener in Symfony2

So you have a Symfony2 project under construction. Login works. Now you want to execute some code right after the user successfully logs in.

The solution: Make a custom event listener.

An event listener is actually a service with a proper tag associated with it. So first step is to register the listener. The configuration file shown corresponds to the listener in file Acme/UserBundle/Listener/LoginListener.php. You can read more about services here.

In services.yml:

Let’s go through the configuration.

class defines the listener class.

With arguments we inject services that this listener depends on. In this case the security.context service for retrieving the User object and doctrine service for EntityManager.

tags is important. Every listener must be tagged with kernel.event_listener and must specify it’s event. For successful login that event is security.interactive_login. You can also specify the optional method tag.

Ok, our listener is registered. Let’s create it.

The above code should be pretty self-explanatory. The only required method is onSecurityInteractiveLogin(Event $event). You do not need the other stuff, but you probably will if you want to modify the User object, or something else in the DB.

10 Responses so far.

  1. Ruben de Vries says:
    5. August. 2011 at 2:23

    Thanks for the snippets, really helped me out a lot :)

  2. Ivo Azirjans says:
    6. January. 2012 at 3:37

    Easy. Thanks!

  3. Sergio Bastias says:
    14. January. 2012 at 8:43

    This is MISTAKEN – you need to put the ->getUser() in the onSecurityInteractiveLogin function. Otherwise, the user isn’t logged in yet!

  4. Metod says:
    15. January. 2012 at 4:24

    Updated. ;)

  5. Dattaya says:
    20. January. 2012 at 12:32

    I’ve got user object this way: $user = $event->getAuthenticationToken()->getUser();
    (sf2.0.9)

  6. bnlab says:
    26. January. 2012 at 2:00

    thanks for this simple but powerful tuti!

  7. Flo says:
    8. March. 2012 at 3:25

    Thanks for the snippets.

    But how to get the container to do this:

    $this->container->get(‘request’)->getSession->setFlashes(‘message’, ………..);

    Thanks

  8. Metod says:
    11. March. 2012 at 11:32

    You should add a new dependency to the service: @session

    Then you can get it in the constructor and do what you need. :)

  9. Paolo says:
    15. March. 2012 at 9:33

    Great tutorial

    Is possible to do the same with logout action ?

    Thanks again

  10. Metod says:
    19. March. 2012 at 1:22

    I googled a bit and found the following, maybe that can help you:

    http://www.reecefowell.com/2011/10/26/redirecting-on-loginlogout-in-symfony2-using-loginhandlers/