Mongodb Odm Softdelete Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require doctrine/mongodb-odm-softdelete
   

   Ensure doctrine/mongodb-odm is also installed (v2.x+ recommended).

2. Enable Soft Deletes Extend your document with SoftDeletable trait:

   use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
   use Doctrine\ODM\MongoDB\SoftDelete\SoftDeletable;
   
   #[MongoDB\Document]
   class User
   {
       use SoftDeletable;
   
       // ...
   }
   

3. First Use Case Soft-delete a record:

   $user = $dm->find(User::class, $id);
   $user->delete(); // Soft-deletes (sets `deletedAt` timestamp)
   

   Query soft-deleted records:

   $deletedUsers = $dm->createQueryBuilder(User::class)
       ->field('deletedAt')->exists(true)
       ->getQuery()
       ->execute();
   

Implementation Patterns

Workflows

1. Soft Delete + Restore

   // Soft-delete
   $user->delete();
   
   // Restore (set `deletedAt` to null)
   $user->restore();
   

2. Querying Soft-Deleted Records Use SoftDeleteQueryBuilder for filtered queries:

   $qb = $dm->createQueryBuilder(User::class)
       ->where('deletedAt')->exists(false); // Only active records
   

3. Bulk Soft Deletes

   $qb = $dm->createQueryBuilder(User::class)
       ->field('status')->equals('inactive');
   
   $users = $qb->getQuery()->execute();
   foreach ($users as $user) {
       $user->delete();
   }
   $dm->flush();
   

Integration Tips

• Events: Listen to onSoftDelete/onSoftRestore via Doctrine events.
• APIs: Use middleware to filter soft-deleted records in responses.
• Admin Panels: Add a "Restore" button for soft-deleted records in admin UIs.

Gotchas and Tips

Pitfalls

1. Missing deletedAt Field Ensure your document has a deletedAt field (auto-generated by the trait):

   #[MongoDB\Field(type: 'date')]
   protected ?\DateTimeInterface $deletedAt = null;
   

2. Query Performance Avoid exists(false) on large collections—index deletedAt for speed:

   #[MongoDB\Index(name: 'deletedAt_idx', fields: ['deletedAt' => 'asc'])]
   

3. Manual Deletion Calling $dm->remove($user) bypasses soft-delete. Use $user->delete() instead.

Debugging

• Check deletedAt: Verify timestamps are set correctly in MongoDB.
• Query Debugging: Use $qb->getQuery()->getDebugQuery() to inspect generated queries.

Extension Points

1. Custom Fields Override getDeletedAtField() to use a different field name.

2. Custom Logic Extend SoftDeletable trait or use events to add pre/post-delete logic.

3. Time Zones Ensure deletedAt uses UTC to avoid timezone-related issues.