cornernote/yii2-softdelete

Soft delete behavior for Yii2.

Maintainers

Details

github.com/cornernote/yii2-softdelete

Source

Issues

Installs: 13 075

Dependents: 0

Suggesters: 0

Security: 0

Stars: 20

Watchers: 2

Forks: 5

Open Issues: 1

Type:yii2-behavior

1.0.3 2017-09-13 23:12 UTC

Requires

Requires (Dev)

BSD-3-Clause 5d81696d52ca0727369b56e7e871a43d9a42eff7

  • Brett O'Donnell <cornernote.woop@gmail.com>

yii2soft delete

This package is auto-updated.

Last update: 2024-11-19 18:47:57 UTC

README

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

Soft delete behavior for Yii2.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require cornernote/yii2-softdelete "*"

or add

"cornernote/yii2-softdelete": "*"

to the require section of your composer.json file.

Usage

In your ActiveRecord class:

public function behaviors() {
    return [
        \cornernote\softdelete\SoftDeleteBehavior::className(),
        // or
        [
            'class' => \cornernote\softdelete\SoftDeleteBehavior::className(),
            'attribute' => 'deleted_time',
            'value' => new \yii\db\Expression('NOW()'), // for sqlite use - new \yii\db\Expression("date('now')")
        ],
    ];
}

then you can use explicitly $model->softDelete(), $model->hardDelete() and $model->unDelete() (for softly deleted models). Each of these methods return boolean result. Also $model->softDelete() calls indirectly from $model->delete(), which always returns false.

In your ActiveQuery class:

public function behaviors() {
    return [
        \cornernote\softdelete\SoftDeleteQueryBehavior::className(),
        // or
        [
            'class' => \cornernote\softdelete\SoftDeleteQueryBehavior::className(),
            'attribute' => 'deleted_time',
        ],
    ];
}