overriding-models.md

Overriding models

When you are creating application with Yii2-user you can find that you need to override models or forms. This guide describes how you can override any model used by Yii2-user. Moreover you can attach any behavior or event handler to any model. This is possible because Yii2-user uses Dependency Injection container.

Assume you decided to override user class and change registration process. Let’s create new user class under @app/models.

namespace app\models;

use dektrium\user\models\User as BaseUser;

class User extends BaseUser
{
    public function register()
    {
        // do your magic
    }
}

In order to make Yii2-user use your class you need to configure module as follows:

...
'user' => [
    'class' => 'dektrium\user\Module',
    'modelMap' => [
        'User' => 'app\models\User',
    ],
],
...

Attaching behaviors and event handlers

Yii2-user allows you to attach behavior or event handler to any model. To do this you can set model map like so:

[
    ...
    'user' => [
        'class' => 'dektrium\user\Module',
        'modelMap' => [
            'User' => [
                'class' => 'app\models\User',
                'on user_create_init' => function () {
                    // do you magic
                },
                'as foo' => [
                    'class' => 'Foo',
                ],
            ],
        ],
    ],
    ...
]