Стандартные события Yii2

Yii2 имеет множество стандартных типов событий для вызова собственного кода в нужный момент работы его компонентов. В этой заметке перечислены все найденные типы событий на текущий момент и приведены примеры использования, по больше части из документации.

Привязка, отвязка и триггеры

Привязка в коде:

$foo = new Foo();
 
// обработчик - глобальная функция
$foo->on(Foo::EVENT_HELLO, 'function_name');
 
// обработчик - метод объекта
$foo->on(Foo::EVENT_HELLO, [$object, 'methodName']);
 
// обработчик - статический метод класса
$foo->on(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);
 
// обработчик - анонимная функция
$foo->on(Foo::EVENT_HELLO, function ($event) {
    // логика обработки события
});

Привязка через конфигурацию:

...
$config = [
    ...
    'components' => [
        ...
        'response' => [
            'on beforeSend' => function(){
                Yii::info('Событие до отправки ответа.');
            }
        ],
        ...
    ],
    ...
];
...

Отвязка:

// обработчик - глобальная функция
$foo->off(Foo::EVENT_HELLO, 'function_name');
 
// обработчик - метод объекта
$foo->off(Foo::EVENT_HELLO, [$object, 'methodName']);
 
// обработчик - статический метод класса
$foo->off(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);
 
// обработчик - анонимная функция
$foo->off(Foo::EVENT_HELLO, $anonymousFunction);
 
// отвязка всех обработчиков
$foo->off(Foo::EVENT_HELLO);