Bonsai Laravel Package

Changed

Most of the code has been rewritten, even though the public API remains backwards compatible.

Added

• Soft-deleting models are now supported. The SoftDeletes trait provides specific methods (forceDeleteTree(), restoreTree()).
• New siblings() relation.
• New methods for easier tree manipulation: graft(), graftOnto(), cut().
• New withHeight() scope.

Deprecated

All of these will be removed in the next major version:

• The --migrate option of the bonsai:grow command is deprecated.
• The BelongsToOrderedTree trait is deprecated in favor of the combination of the BelongsToTree and Ordered traits.
• The static getTree() and getTreeDepth() methods are deprecated and will be replaced with something else in v4.
• The deleteNode() method is deprecated because it didn't seem very useful.
• The withAncestors() and withDescendants() scopes are deprecated in favor of just using the with() method.
• Some methods and scopes have been renamed (the old name is still available for now, but deprecated):
  • whereIsRoot() becomes onlyRoots(),
  • whereIsLeaf() becomes onlyLeaves(),
  • whereHasChildren() becomes hasChildren(),
  • whereIsDescendantOf() becomes descendantsOf(),
  • whereIsAncestorOf() becomes ancestorsOf(),
  • includingSelf() becomes withSelf(),
  • excludingSelf() becomes withoutSelf(),
  • upToDepth() becomes maxDepth(),
  • getSubtreeDepth() becomes getHeight().

Fixed

• The migration generated by bonsai:grow now works with any type of key (such as UUIDs). It used to assume that the id column was an integer.
• The relation scopes (such as withSelf()) can now be called in the constraints callback when using withCount() or whereHas().

• Fixed: backward compatibility issue when using deleteTree()

• Added: support for Laravel 12
• Added: support for other SGBDs (SQLite, PostgreSQL, SQL Server) (previous versions only supported MySQL)

Added Laravel 11 support (issue #3).

Fixed

• The getTree() method, when called on an ordered tree, now orders the root elements (issue #1).

Added Laravel 10 support.

Added Laravel 9 support.

Fixed

• Fixed implicit transaction commit in bonsai:fix command.

Fixed

• The parent relationship is now properly auto-loaded when with('ancestors') is used. Previously, it would be loaded with wrong parents if the ancestors relationship was not ordered by ascending depth, or was filtered by some constraint.

Laravel 8 support.

Added

• deleteNode method.

Changed

• whereIsDescendantOf / whereIsAncestorOf now accept a Model as parameter.

Fixed

• Changed deleteTree implementation to avoid errors on bigger trees.