using-controller-events.md

Using controllers events

The controllers packaged with the Yii2-user provide a lot of functionality that is sufficient for general use cases. But, you might find that you need to extend that functionality and add some logic that suits the specific needs of your application.

For this purpose, you can either override controller or use events. The controllers are dispatching events in many places in their code. All events can be found in the constants of needed controller class.

For example, this event listener will redirect user to login page after successful registration instead of showing message on a blank page:

'user' => [
    'class' => \dektrium\user\Module::className(),
    'controllerMap' => [
        'registration' => [
            'class' => \dektrium\user\controllers\RegistrationController::className(),
            'on ' . \dektrium\user\controllers\RegistrationController::EVENT_AFTER_REGISTER => function ($e) {
                Yii::$app->response->redirect(array('/user/security/login'))->send();
                Yii::$app->end();
            }
        ],
    ],
],

Alternative: Class based-events

You can also assign events on class-level.

\yii\base\Event::on(
    \dektrium\user\controllers\RegistrationController::className(),
    \dektrium\user\controllers\RegistrationController::EVENT_AFTER_CONFIRM,
    function () {        
        Yii::info('Assigning default roles to user...');
        // implement role assignment(s)
    }
);