Skip to content

efureev/laravel-trees

Repository files navigation

PHP Laravel Package Total Downloads License composer.lock available

Latest Stable Version

Maintainability Test Coverage

Laravel Tree Structure

Contents:

Information

This package is Multi-Tree structures (a lot of root-nodes).

Screenshots

html tree console tree

What are nested sets?

Nested sets or Nested Set Model is a way to effectively store hierarchical data in a relational table. From wikipedia:

The nested set model is to number the nodes according to a tree traversal, which visits each node twice, assigning numbers in the order of visiting, and at both visits. This leaves two numbers for each node, which are stored as two attributes. Querying becomes inexpensive: hierarchy membership can be tested by comparing these numbers. Updating requires renumbering and is therefore expensive.

Applications

NSM shows good performance when tree is updated rarely. It is tuned to be fast for getting related nodes. It is ideally suited for building multi-depth menu or categories for shop.

Requirements

  • PHP: 8.2|8.3
  • Laravel: ^11.*

It is highly suggested to use database that supports transactions (like Postgres) to secure a tree from possible corruption.

Installation

composer require efureev/laravel-trees

Testing

./vendor/bin/phpunit --testdox
# or
composer test

Documentation

The package allows to create multi-root structures: no only-one-root! And allows to move nodes between trees.
Moreover, it also works with different model's primary key: int, uuid, ulid.