https://github.com/cornernote/yii2-softdelete

Soft delete behavior for Yii2
https://github.com/cornernote/yii2-softdelete

Last synced: 3 months ago
JSON representation

Soft delete behavior for Yii2

• Host: GitHub
• URL: https://github.com/cornernote/yii2-softdelete
• Owner: cornernote
• License: other
• Created: 2015-06-20T07:44:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-13T23:13:07.000Z (over 7 years ago)
• Last Synced: 2024-10-03T13:22:22.700Z (3 months ago)
• Language: PHP
• Size: 46.9 KB
• Stars: 20
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-yii2 - cornernote/yii2-softdelete

README

        
# Yii2 Soft Delete

[![Latest Version](https://img.shields.io/github/tag/cornernote/yii2-softdelete.svg?style=flat-square&label=release)](https://github.com/cornernote/yii2-softdelete/tags)

[![Software License](https://img.shields.io/badge/license-BSD-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/travis/cornernote/yii2-softdelete/master.svg?style=flat-square)](https://travis-ci.org/cornernote/yii2-softdelete)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/cornernote/yii2-softdelete.svg?style=flat-square)](https://scrutinizer-ci.com/g/cornernote/yii2-softdelete/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/g/cornernote/yii2-softdelete.svg?style=flat-square)](https://scrutinizer-ci.com/g/cornernote/yii2-softdelete)

[![Total Downloads](https://img.shields.io/packagist/dt/cornernote/yii2-softdelete.svg?style=flat-square)](https://packagist.org/packages/cornernote/yii2-softdelete)

Soft delete behavior for Yii2.

## Installation

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

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:

```php

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:

```php

public function behaviors() {

    return [

        \cornernote\softdelete\SoftDeleteQueryBehavior::className(),

        // or

        [

            'class' => \cornernote\softdelete\SoftDeleteQueryBehavior::className(),

            'attribute' => 'deleted_time',

        ],

    ];

}

```