nex-otaku/yii2-softdelete

SoftDelete for ActiveRecord.

Soft Delete

Реализация SoftDelete для моделей ActiveRecord в Yii2., _(*1)

Зачем это нужно

Суть работы SoftDelete (мягкого удаления) - вместо окончательного удаления записей из БД, в них просто меняется флаг (например, deleted=1). При выборке из БД мы опять же по этому флагу "отсеиваем" все удалённые записи, и получаем только актуальные., _(*2)

Зачем это нужно, не проще ли сразу удалять навсегда?, _(*3)

В более-менее сложных приложениях, есть статистика, отчёты и связанные данные. Например, покупатели делают заказы на сайте. Допустим, мы удалили покупателя, а вместе с ним и все его заказы. В результате мы не можем достоверно сказать, сколько у нас было заказов и на какую сумму за определённый период. В таких случаях помогает SoftDelete. По умолчанию мы игнорируем записи, отмеченные как удалённые, но при необходимости можем их учитывать и брать из них любую информацию., _(*4)

Также, сохранение удалённых записей теоретически может пригодиться при отладке кода и восстановлении случайно удалённых данных. Но на практике это почти никогда не случается. Тем более, что для восстановления гораздо удобнее использовать регулярные бекапы. Поэтому, решив использовать SoftDelete, взвесьте все за и против. Возможно, в вашем проекте он не принесёт пользы, а будет только мешать., _(*5)

Установка

Лучше всего устанавливать через Composer., _(*6)

Выполните, _(*7)

php composer.phar require --prefer-dist nex-otaku/yii2-softdelete "*"

или же добавьте, _(*8)

"nex-otaku/yii2-softdelete": "*"

в список "require" вашего файла composer.json., _(*9)

Схема БД.

В таблицах, добавляем поле "deleted": TINYINT(1) NOT NULL DEFAULT '1'. Для всех внешних ключей таблицы устанавливаем режим ON DELETE RESTRICT. Это частично защитит нас от случайного "жёсткого" удаления записей., _(*10)

Подключение расширений.

Расширения подгружаются автоматически, через зависимости композера., _(*11)

Используются расширения:, _(*12)

1. SoftDeleteBehavior. https://github.com/yii2tech/ar-softdelete, _(*13)

2. QueryScopeBehavior для отображения всех записей, кроме удалённых. https://github.com/mdmsoft/yii2-ar-behaviors, _(*14)

3. NotDeletedTrait, SoftDeleteBehavior (сконфигурированный под поле "deleted"), SoftDeleteTimestampBehavior, SoftDeleteBlameableBehavior. https://github.com/nex-otaku/yii2-softdelete, _(*15)

Бихевиор QueryScopeBehavior подключается к ActiveQuery автоматически. Его нигде не нужно специально прописывать. Установили расширение и он уже сам в бутстрапе прилепился к ActiveQuery., _(*16)

Подключение в модели.

В модели подключаем трейт NotDeletedTrait и бихевиор SoftDeleteBehavior. Если нам нужно знать, кто и когда удалил запись, подключаем SoftDeleteTimestampBehavior и SoftDeleteBlameableBehavior. Не забываем добавить соответствующие поля в таблице БД - "deleted_by", "deleted_at"., _(*17)

Так как эти поля управляются автоматически и недоступны для редактирования пользователем напрямую, удаляем их из правил модели. См. метод "rules()"., _(*18)

Пример., _(*19)

class Feed extends \yii\db\ActiveRecord
{
    use \nex_otaku\softdelete\NotDeletedTrait;
    public function behaviors()
    {
        return [
            SoftDeleteBehavior::className(),
            SoftDeleteTimestampBehavior::className(),
            SoftDeleteBlameableBehavior::className(),
        ];
    }
}

Использование

// Удаление.
$model->safeDelete();

// Выборка записей, которые не были удалены.
$coolModels = CoolModel::find()->notDeleted()->all();

Каскадное удаление реализуется самостоятельно., _(*20)