lekoala / silverstripe-softdelete

Add SoftDelete behaviour to your SilverStripe models

SilverStripe Soft Delete Module

Add a soft delete behaviour to your dataobjects. Objects are simply marked as deleted and kept in the database.

Soft delete will follow the same permissions patterns as delete.

ModelAdmin and SecurityAdmin are extended to add a new GridField action that replace the default delete action

This module depends on lekoala/silverstripe-cms-actions for displaying delete buttons

How to use

Simply replace your calls from delete to softDelete.

New extensions hooks are provided to avoid side effects (onBeforeSoftDelete, onAfterSoftDelete). These are ideals if you have child records that need to be soft deleted with their parent.

Config options

SilverStripe\Admin\ModelAdmin:
    softdelete_from_list: true
    softdelete_from_list_exclude: []
    extensions:
        - SoftDeleteModelAdmin
SilverStripe\Admin\SecurityAdmin:
    softdelete_from_list: true
    softdelete_from_list_exclude: []
    extensions:
        - SoftDeleteSecurityAdmin

You can configure:

• softdelete_from_list: show delete button on a line. Enabled by default.
• softdelete_from_list_exclude: hide the delete button for these classes even if enabled globally

Prevent accidental deletion

By default, the module will prevent any delete from happening. To allow deletion, you must set

SoftDeletable:$prevent_delete = false

The only way from the CMS UI to delete a record is to go to a soft deleted record and click "Really delete" which will call "forceDelete" on the record.

Disable filtering

You can disable filtering globally, using

SoftDeletable::$disable = true

Or at query level

$dataQuery->setQueryParam('SoftDeletable.filter',false)

Filtering on ids

By default, this module will let you return soft deleted records if you ask them specifically by ID. This is by design to prevent things breaking accidentally. If you want to make sure you don't display soft deleted records, make sure to implement a proper canView() method that fits your usage.

An alternative option, is to disable that feature:

SoftDeletable:
    check_filters_on_id: false

Keep in mind that DataObject::get_by_id(); can get cached and it can lead to tricky scenarios.

Compatibility

Tested with 4.4+

Maintainer

LeKoala - [email protected]

silverstripe-softdelete's Issues

Soft delete with relation filter fails

Hello,

First of all, thank you for this module :-).

But I have one issue. If I apply a relation filter, soft delete condition is ignored.

silverstripe-softdelete/code/SoftDeletable.php

Line 107 in 047694a

if ($query->filtersOnID() && self::config()->check_filters_on_id) {

e.g.
MyObject::get()->filter('Relation.ID', 3)->count();

Why do you check if query filters on ID and then stop the query?

We had a problem that we were querying by ID and it would find the deleted items. It would make sense to me that default it shouldn't find anything that is soft deleted. And if you do, you can use SoftDeletable.filter to make sure you can find it. It breaks our code now and we have to do extra checks to make sure it doesn't get a deleted object.

Composer type is silverstripe-module, not silverstripe-vendormodule

The type is silverstripe-module which causes this package to be installed into the root directory instead of vendor. I am wanting to keep my root directly clean if possible, can I submit a PR to change this?

SoftDeleteModelAdmin dataFieldByName not working for detailed implementations of $managed_models

SoftDeleteModelAdmin.php

    protected function getSanistedModelClass()
    {
        return str_replace('\\', '-', $this->owner->modelClass);
    }

needs to use $this->owner->modelTab because the GridField is constructed using modelTab https://github.com/silverstripe/silverstripe-admin/blob/2/code/ModelAdmin.php#L286

Override delete() instead of adding softDelete()

It would be better, to override the actual delete() method, instead of having to rely on replacing all occurences of delete() with softDelete();

forceDelete is already in place to handle the hard deletions.

No change....

There is no change on my dataobject after implement this addon...

Create tag 1.0.0 for silverstripe 3

It would help with sites that have this module as a requirement, but are stuck in 3.

https://stackoverflow.com/a/44983803