Skip to content

doc(readme): add guide to deleting multiple nodes #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v6
Choose a base branch
from
Open

doc(readme): add guide to deleting multiple nodes #602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,21 +489,30 @@ $tree = Category::descendantsOf($rootId)->toTree($rootId);

### Deleting nodes

To delete a node:
#### To delete a node:

```php
$node->delete();
```

**IMPORTANT!** Any descendant that node has will also be deleted!
> [!IMPORTANT]
> Any descendant that node will also be deleted!

**IMPORTANT!** Nodes are required to be deleted as models, **don't** try do delete them using a query like so:
#### To delete multiple nodes:

```php
Category::where('id', '=', $id)->delete();
$nodes = Model::query()->get();
foreach ($nodes as $node) {
$node->fresh()?->delete(); // Reload the `_lft` & `_rgt` columns using `fresh` method
}
```

This will break the tree!
> [!IMPORTANT]
> Node are required to be deleted as models, **don't** try do delete them using a query like so:
> ```php
> Category::where('id', '=', $id)->delete();
> ```
>
>This will break the tree!

`SoftDeletes` trait is supported, also on model level.

Expand Down