Remove an aggregate

In order to remove an aggregate you need 3 things:

• an Id of the aggregate
• a repository in which to put the aggregate
• a transaction to atomically persist the aggregate

Translated into code this gives:

$users = $orm->repository(User::class);
$result = $orm->transactional(
    static fn() => $repository
        ->remove(Id::of(User::class, 'alice-uuid'))
        ->either(),
);

If alice exists in the storage it will remove it and if it doesn't then nothing will happen. And like for persisting the ->either() will indicate to transactional to commit the transaction.

Note

If you want to remove multiple aggregates at once corresponding to a set of criteria head to the Specification chapter.