cornernote / yii2-softdelete

Soft delete behavior for Yii2

Yii2 Soft Delete

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',
        ],
    ];
}

yii2-softdelete's Issues

Trying a query on joined tables using soft delete behavior throws sql error

Trying to join two or more tables that are using soft delete, same attribute name and deleted or notDeleted method fails with Column 'deleted_at' in where clause is ambiguous.

I just fixed it by prefixing the attribute name with the table name.
I'm going to do a pull request after posting this issue.

SoftDeleteQueryBehavior being ignored

Hey, Ive set softdelete behavior in an ActiveRecord model with the following config:

            TimestampBehavior::className(),
            'softDeleteBehavior' => [
                'class'                     => SoftDeleteBehavior::className(),
                'softDeleteAttributeValues' => [
                    'deleted_at' => new Expression('UNIX_TIMESTAMP()')
                ],
                'replaceRegularDelete'      => true
            ],

Its working: when I delete, "detelet_at" is set with the unix timestamp.

Now, to retrieve without the deleted ones, Ive set the query like this:

class UserQuery extends ActiveQuery
{

    public function behaviors()
    {
        return [
            'softDelete' => [
                'class' => SoftDeleteQueryBehavior::className(),
                'deletedCondition'    => [
                    'deleted_at' => new Expression('IS NOT NULL'),
                ],
                'notDeletedCondition' => [
                    'deleted_at' => new Expression('IS NULL'),
                ],
            ],
        ];
    }
}

Its being completely ignored, the deleted records are returned normally on any query

Im not sure its a bug, sorry if it inst. But everything seems right and I dont know what could be wrong.