Что такое afterSave() в Yii2?

Что такое afterSave() в Yii2?

afterSave() — это метод-обработчик событий, часть механизма событий ActiveRecord в фреймворке Yii2. Он представляет собой хук (hook), который автоматически вызывается после успешного выполнения операции сохранения модели в базу данных (после вызова методов save() или update()). Этот механизм является ключевым элементом архитектуры Yii, основанной на событиях (events) и поведениях (behaviors).

Место в жизненном цикле сохранения модели

Метод afterSave() является частью последовательности событий, которые происходят при сохранении ActiveRecord:

1. beforeValidate() и afterValidate() — до и после валидации.
2. beforeSave() — непосредственно перед выполнением INSERT или UPDATE в БД.
3. Выполнение SQL-запроса к базе данных.
4. afterSave() — сразу после успешного завершения операции в БД.

// Пример модели User с методом afterSave()
class User extends \yii\db\ActiveRecord
{
    // ...

    public function afterSave($insert, $changedAttributes)
    {
        parent::afterSave($insert, $changedAttributes);

        // Логируем создание нового пользователя
        if ($insert) {
            Yii::info('Новый пользователь создан: ' . $this->username, 'app');
        }

        // Синхронизируем данные с внешним сервисом при изменении email
        if (array_key_exists('email', $changedAttributes)) {
            $this->syncWithExternalService();
        }
    }

    private function syncWithExternalService()
    {
        // ... код отправки данных ...
    }
}

Параметры метода и их значение

Метод принимает два аргумента:

• $insert (boolean): Ключевой параметр, указывающий тип операции. Если true, модель была создана (INSERT). Если false, модель была обновлена (UPDATE).
• $changedAttributes (array): Массив изменённых атрибутов в случае UPDATE. Ключи — названия атрибутов, значения — их старые значения до сохранения. При INSERT этот массив пуст.

public function afterSave($insert, $changedAttributes)
{
    // Разная логика для создания и обновления
    if ($insert) {
        // Отправляем welcome-email новому пользователю
        $this->sendWelcomeEmail();
    } else {
        // Отправляем уведомление об изменении профиля
        if (isset($changedAttributes['status'])) {
            $this->notifyAboutStatusChange($changedAttributes['status']);
        }
    }
}

Основные сценарии применения afterSave()

• Логирование действий: Фиксация в логах или отдельной таблице истории всех созданий и изменений сущностей.
• Синхронизация данных: Обновление связанных данных в других системах или таблицах (например, обновление агрегированных данных в статистической таблице после изменения заказа).
• Отправка уведомлений: Вызов отправки email, SMS или push-уведомлений после критических изменений.
• Очистка или обновление кеша: Сброс кешированных данных, зависимых от модели.
• Асинхронные задачи: Помещение задач в очередь (например, RabbitMQ) для дальнейшей обработки без блокировки основного потока.

Отличие от beforeSave() и важные особенности

• beforeSave() может прервать операцию сохранения, вернув false. afterSave() вызывается только при успешном сохранении и не может его отменить.
• Внутри afterSave() можно безопасно обращаться к текущим атрибутам модели, так как они уже сохранены в БД.
• Обязательно вызывать parent::afterSave() в переопределённом методе, чтобы не нарушить цепочку событий (например, если родительский класс или подключенные поведения также используют этот хук).
• Этот метод не вызывается при массовом обновлении через updateAll() или прямых SQL-запросах, так как они работают на уровне базы данных, минуя ActiveRecord.

Практический пример: обновление сводной информации

class OrderItem extends \yii\db\ActiveRecord
{
    public function afterSave($insert, $changedAttributes)
    {
        parent::afterSave($insert, $changedAttributes);

        // После любого сохранения элемента заказа пересчитываем сумму всего заказа
        $order = $this->order; // Связь с моделью Order
        $totalSum = $order->getOrderItems()->sum('price * quantity');
        $order->updateAttributes(['total_sum' => $totalSum]);
    }
}

Таким образом, afterSave() в Yii2 — это мощный и стандартизированный инструмент для реализации постобработки, обеспечения консистентности данных и реализации сложной бизнес-логики, связанной с сохранением сущностей. Он позволяет соблюдать принцип разделения ответственности, вынося логику, не относящуюся напрямую к валидации и первичному сохранению, в отдельный, четко определённый этап жизненного цикла модели.