This repo is forked from not maintained salines/cakephp4-soft-delete and updated to avoid deprecated code in CakePHP >=4.0
This Cakephp plugin enables you to make your models soft deletable.
When soft deleting an entity, it is not actually removed from your database.
Instead, a deleted
int2 is set 1 on the record.
AND a deleted_date
timestamp as string is set on the record.(deleted_date
Default ='0')
This Trait has been developed for cakephp >=4.0 and PHP >=8.0
You can install this plugin into your CakePHP application using composer.
Update your composer file to include this plugin:
composer require aokazu/cakephp4-soft-delete "2.*"
Use the SoftDelete trait on your model Table class:
// in src/Model/Table/UsersTable.php
...
use SoftDelete\Model\Table\SoftDeleteTrait;
class UsersTable extends Table
{
use SoftDeleteTrait;
...
delete
and deleteAll
functions will now soft delete records by populating deleted
field with the date of the deletion.
// in src/Model/Table/UsersTable.php
$this->delete($user); // $user entity is now soft deleted if UsersTable uses SoftDeleteTrait.
To restore a soft deleted entity into an active state, use the restore
method:
// in src/Model/Table/UsersTable.php
// Let's suppose $user #1 is soft deleted.
$user = $this->Users->find('all', ['withDeleted'])->where('id', 1)->first();
$this->restore($user); // $user #1 is now restored.
find
, get
or dynamic finders (such as findById
) will only return non soft deleted records.
To also return soft deleted records, $options
must contain 'withDeleted'
. Example:
// in src/Model/Table/UsersTable.php
$nonSoftDeletedRecords = $this->find('all');
$allRecords = $this->find('all', ['withDeleted']);
To hard delete a single entity:
// in src/Model/Table/UsersTable.php
$user = $this->get($userId);
$success = $this->hardDelete($user);
To mass hard delete records that were soft deleted before a given date, you can use hardDeleteAll($date):
// in src/Model/Table/UsersTable.php
$date = new \DateTime('some date');
$affectedRowsCount = $this->hardDeleteAll($date);
Associations are correctly handled by SoftDelete plugin.
- Soft deletion will be cascaded to related models as usual. If related models also use SoftDelete Trait, they will be soft deleted.
- Soft deletes records will be excluded from counter caches.