plook/tree

Library for working with tree data structures.

0.5.0 2024-02-16 21:01 UTC

Requires

• php: ^8.2

Requires (Dev)

• brainbits/phpcs-standard: ^7.0
• ergebnis/phpstan-rules: ^2.2.0
• phpstan/phpstan: ^1.10.58
• phpstan/phpstan-phpunit: ^1.3.15
• phpunit/phpunit: ^11.0.3
• rector/rector: ^1.0.1
• squizlabs/php_codesniffer: ^3.9.0
• thecodingmachine/phpstan-safe-rule: ^1.2.0
• thecodingmachine/phpstan-strict-rules: ^1.0.0

LGPL-2.1-or-later

• Phillip Look

README

A PHP library for working with tree data structures.

Installation

$ composer require plook/tree

Working with trees that are stored in arrays

Traversing a left/right tree that is ordered by the left value

$tree = [
    ['id' => 1, 'left' => 1, 'right' => 14],
    ['id' => 2, 'left' => 2, 'right' => 7],
    ['id' => 3, 'left' => 3, 'right' => 4],
    ['id' => 4, 'left' => 5, 'right' => 6],
    ['id' => 5, 'left' => 8, 'right' => 13],
    ['id' => 6, 'left' => 9, 'right' => 10],
    ['id' => 7, 'left' => 11, 'right' => 12],
];

/** @var TraverseLeftRightTree<array{id: int, left: int, right: int}> $traverse */
$traverse = new TraverseLeftRightTree();

$traverse(
    $tree,
    'left',
    'right',
    static function (array $node): void {
        echo sprintf('Processing node %s%s', $node['id'], PHP_EOL);
    },
    static function (array $node): void {
        echo sprintf('Childrens of node %s have been processed%s', $node['id'], PHP_EOL);
    },
);

Processing node 1
Processing node 2
Processing node 3
Childrens of node 3 have been processed
Processing node 4
Childrens of node 4 have been processed
Childrens of node 2 have been processed
Processing node 5
Processing node 6
Childrens of node 6 have been processed
Processing node 7
Childrens of node 7 have been processed
Childrens of node 5 have been processed
Childrens of node 1 have been processed