sibds/yii2-trash-behavior

AR models behavior that allows to mark models as deleted and then restore them.

yii2-trash-behavior

AR models behavior that allows to mark models as deleted and then restore them., _(*1)

, _(*2)

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

$ composer require sibds/yii2-trash-behavior

or add, _(*5)

"sibds/yii2-trash-behavior": "*"

to the require section of your composer.json file., _(*6)

How to use?

Paste in the model code:, _(*7)

  public function behaviors()
  {
      return [
          \sibds\behaviors\TrashBehavior::className(),
      ];
  }

To mark a record for deletion, call function delete:, _(*8)

  $model->delete();

The second call delete, delete the record., _(*9)

To restore record:, _(*10)

  $model->restore();

For the correct selection of records in the model, it is necessary to redefine the function of find:, _(*11)

  public static function find()
  {
      return (new \sibds\behaviors\TrashQuery(get_called_class()))->findRemoved();
  }

Example of use:, _(*12)

  $posts = Post::find()->all();

Selecting only marked for deletion of records:, _(*13)

  $count = Post::find()->onlyRemoved()->count();

Selecting all records:, _(*14)

  $allPosts = Post::find()->withRemoved()->all();